DOdovetail
Channels

Patch channel

Changed on

Update a channel's properties. Supports updating the title and the context (a description of the channel's main goal or purpose, which helps Dovetail's AI better classify incoming data). Only the fields you include in the request body will be modified.

Returns the updated channel object.

🚧 Permissions

Please check you have the relevant permissions required to access this resource. This may include specific permissions on the object itself or its parent, or having the correct user role if you're making updates.

Required scope: channel:write

patch/v1/channels/{channel_id}

Request

  • Base URL
    https://dovetail.com/api
  • URL
    https://dovetail.com/api/v1/channels/{channel_id}
  • Auth
    HTTP bearer

Path parameters

channel_idstring required

Unique identifier of the channel.

Request body

titlestring required

The channel's title.

contextstring

The channel's context, used to set the channel's main goal or purpose.

Example request

{
  "title": "My channel",
  "context": "Understanding customer feedback and improving product features"
}

Response

200

Changes

  • 8abea327e6b9Revision changes
    • breaking

      added subschema #1 subschema #2 to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status