staqlydocs
REST APIAPI referenceChannels

Rename a channel group or change its colour or position

Rename a channel group or change its colour or position (channels:manage)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

PATCH
/v1/channel-groups/{id}

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Request Body

application/json
  1. body
name?string

Unique in the workspace (case-insensitive); required on create

Lengthlength <= 60
color?string

#rrggbb, or empty

position?integer

Response Body

OK

application/json
  1. response

The one bucket a channel sits in (a group per client, say). The Default group always exists and can't be deleted.

id*string
name*string
color*string

#rrggbb, or empty

position*integer

Sort order (Default always leads)

default*boolean
channels*integer

Channels in the group (list only; 0 elsewhere)

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X PATCH 'https://staqly.example.com/v1/channel-groups/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "name": "string",  "color": "string",  "position": 0,  "default": true,  "channels": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}