Rename, change defaults, turn off or on, or reconnect with fresh fields
Rename, change defaults, turn off or on, or reconnect with fresh fields (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.
status is connected or disabled (a disabled channel's targets fail without trying).
fields reconnects a token platform with new credentials, checked against the platform first;
OAuth platforms reconnect through the OAuth flow.
AuthorizationBearer <token>API key (stk_...), or in the Community Edition the access token (stk_local_...)
id*stringIdempotency-Key?stringReplays 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.
length <= 200application/json- body
name?stringlength <= 100settings?Replaces the settings; links (keep, remove, defang; one of the provider's limits.link_modes) sets what the channel does with links
status?string"connected""disabled"fields?Token platforms: fresh credential fields to reconnect with
group_id?stringMoves the channel to this channel group (grp_...); empty moves it to Default
OK
application/json- response
A connected account. Credentials are stored sealed and never returned.
id*stringprovider*stringProvider id (see GET /v1/providers)
name*stringhandle*stringThe account's handle on the platform (@name, a channel id)
avatar_url*stringprofile_url*stringstatus*ChannelStatusconnected (works), needs_reconnect (the platform refused the credentials), disabled (turned off; targets on it fail without trying)
"connected""needs_reconnect""disabled"settings*Provider-level defaults for new targets, and links (one of the provider's limits.link_modes) to choose what the channel does with links
links*LinksModeWhat this channel does with the links in a post's text: settings.links, else the provider's limits.links
"keep""remove""defang"group_id*stringThe channel group it belongs to (every channel is in exactly one; the Default group unless moved)
last_error*stringcreated_at*stringdate-timeupdated_at*stringdate-timeactivity?Read from the channel's targets. Only GET /v1/channels and GET /v1/channels/{id} include it (not webhook payloads).
curl -X PATCH 'https://staqly.example.com/v1/channels/string' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": "string", "provider": "string", "name": "string", "handle": "string", "avatar_url": "string", "profile_url": "string", "status": "connected", "settings": {}, "links": "keep", "group_id": "string", "last_error": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "activity": { "last_published_at": "2019-08-24T14:15:22Z", "last_post_id": "string", "next_publish_at": "2019-08-24T14:15:22Z", "published_30d": 0 }}