v1

latestOpenAPI 3.0.22026-07-261040577.4 KB

Channels

Patch channel

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.

patch/v1/channels/{channel_id}

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