DOdovetail
Channels

Create topic

Changed on

Create a new topic within a channel. Topics are categories used by Dovetail's AI to classify incoming data points. Each topic has a title and description that guide how data is sorted.

You must specify the channel_id that this topic belongs to. After creating a topic, new data points sent to the channel will be evaluated against it during classification.

Returns the newly created topic object.

Required scope: channel:write

post/v1/channels/topic

Request

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

Request body

titlestring required

The topic's title.

descriptionstring required

The topic's description.

channel_idstring required

Unique identifier of the channel.

Response

201

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