Sign in
Channels

Update a channel by ID

patch/channels/{id}

Path parameters

idstring required

Channel ID

Channel ID

Request body

namestring

Name of the channel

externalIdstring

Deprecated, use 'externalIds' instead. Shorthand for a single-entry 'externalIds'. For now, responses will keep returning 'externalId' with the first entry of 'externalIds'.

externalIdsstring[]

External identifiers for the channel. Replaces the full list; an empty array clears all external IDs. Mutually exclusive with externalId.

timeoutnumber

Timeout in seconds (minimum 60). To never stop, specify 0

Response

Updated channel

Changes

Changed in 1 of the 9 revisions of this API.4

  • 7bfe58df4d984See the full diff
    • ○

      added the new optional request property externalIds

      new-optional-request-property

    • ○

      request property externalId deprecated

      request-property-deprecated

    • ○

      added the optional property data/allOf[Channel]/externalIds to the response with the 200 status

      response-optional-property-added

    • ○

      response property data/allOf[Channel]/externalId deprecated

      response-property-deprecated