Channels

Update a topic's title and/or description. Only the fields you include in the request body will be modified — omitted fields are left unchanged.

Updating a topic's description can change how future data points are classified against it.

Returns the updated topic 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/topic/{topic_id}

Request

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

Path parameters

topic_idstring required

Unique identifier of the topic.

Request body

titlestring

The topic's title.

descriptionstring

The topic's description.

Example request

{
  "title": "My topic",
  "description": "My topic description"
}

Response

200

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