Channel Groups

Create a new channel group

Create a new channel group. This method requires the ChannelGroups:Create permission to be associated with your role.

POST

/fm/channel/groups

curl --request POST \
  --url https://api.catch-e.com/fm/channel/groups \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel_group_code": "ABC",
  "name": "ABC Channel Group",
  "status_flag": "active"
}
'

{
  "_links": {
    "channels": {
      "href": "https://api.catch-e.com/fm/channels/?channel_group_id=100000"
    },
    "self": {
      "href": "https://api.catch-e.com/fm/channel/groups/100000"
    }
  },
  "channel_group_code": "ABC",
  "channel_group_id": "100000",
  "name": "ABC Channel Group",
  "status_flag": "active"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Body

JSON payload

channel_group_codestringdefault:required

A unique code for the channel group

Example: ABC

namestringdefault:required

Example: ABC Channel Group

status_flagenum<string>default:active

Status of the new channel group

Available options: active, inactive

Example: active

Response

Success

_linksobject

Show child attributes

channel_group_codestring

Example: ABC

channel_group_idstring

Example: 100000

namestring

Example: ABC Channel Group

status_flagenum<string>

Available options: active, inactive

Still need help? Ask the team