Channels

Operations for channels

Find All

GET /v1/networks/channels

Paging

This endpoint supports paging. Refer to our User Guide for usage.

cURL
curl --request GET 'https://api.eflow.team/v1/networks/channels' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "channels": [
    {
      "network_channel_id": 1,
      "network_id": 1,
      "name": "TestChannel",
      "status": "active",
      "relationship": {
			"offers_count": "1"
	  }
    }
  ]
}

Find By ID

GET /v1/networks/channels/:channelId

Path Parameters

Parameter Description
channelId The ID of the channel you want to find

cURL
curl --request GET 'https://api.eflow.team/v1/networks/channels/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "network_channel_id": 1,
  "network_id": 1,
  "name": "TestChannel",
  "status": "inactive",
  "relationship": {
        "offers_count": "1"
  }
}

Create

POST /v1/networks/channels

name string

Name of the channel.

status string

Status of the channel. Can either be active or inactive.

{
  "name": "ChannelName",
  "status": "active"
}

cURL
curl --request POST 'https://api.eflow.team/v1/networks/channels/1' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
  "network_channel_id": 1,
  "network_id": 1,
  "name": "ChannelName",
  "status": "active",
  "relationship": {},
  "time_created": 1579163366,
  "time_saved": 1579163366
}

Update

PUT /v1/networks/channels/:channelId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter Description
channelId The ID of the channel you want to update

name string

Name of the channel.

status string

Status of the channel. Can either be active or inactive.

relationship object
offers_count int

Number of offer in the channel.

{
  "network_channel_id": 1,
  "network_id": 1,
  "name": "TestChannel",
  "status": "inactive",
  "relationship": {
        "offers_count": "1"
  }
}

Delete

DELETE /v1/networks/channels/:channelId

Path Parameters

Parameter Description
channelId The ID of the channel you want to delete

cURL
curl --request DELETE \
  --url 'https://api.eflow.team/v1/networks/channels/:channelId" \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
Response
{
  "result": true
}