Sign in

v2

latestOpenAPI 3.0.02026-07-26365590.3 KB
Tags

Create a tag

Creates a new tag for use in sequences to qualify call results.

post/v1/tags

Headers

x-workspace-idstring uuid

Target workspace id (from GET /v1/workspaces). Required for multi-workspace API keys to designate which workspace to write to; omit for single-workspace keys, where it is resolved automatically. Must be within the API key scope.

Request body

labelstring required

The label of the tag

isSuccessTagboolean

Whether the tag represents a successful call outcome

Example request

{
  "label": "Lead"
}

Response

Tag created successfully

idstring required

Unique identifier of the tag

labelstring required

Label of the tag

isSuccessTagboolean required

Whether the tag represents a successful call outcome

createdAtstring date-time required

Date when the tag was created

updatedAtstring date-time required

Date when the tag was last updated

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "label": "Lead",
  "isSuccessTag": true,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}