Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Label

Update Label

Partially updates a label. Only fields present in the request body are applied (pointer-nil merge semantics). Renaming a label cascades updates to scorecard criteria and intelligence-item-collection criteria that reference the old label name. Cross-organization updates return 404.

patch/labels/{id}

Path parameters

idstring required

UUID of the label to update.

Request body

namestring

New label name. Trimmed before validation. Must be unique within the organization. Renaming cascades to scorecard criteria and intelligence-item-collection criteria that reference the old name.

descriptionstring nullable

New description. Pass an empty string to clear. 0 to 2000 characters. Omit to leave unchanged.

aiFlowboolean nullable

New AI-flow participation value. Omit to leave unchanged.

allTeamsboolean nullable

New allTeams value. Omit to leave unchanged.

Example request

{
  "name": "Buying Signal (v2)",
  "description": "Updated description of the buying signal label.",
  "aiFlow": false
}

Response

Label successfully updated

Example response

{
  "data": {
    "uuid": "fe515723-fe2e-4959-a5fa-c4d3937fe7e4",
    "name": "Buying Signal",
    "description": "Conversations where the prospect expresses a buying signal.",
    "aiFlow": true,
    "allTeams": false,
    "isDefaultTemplate": false,
    "options": [],
    "organizationUUID": "16b78cec-82ef-46d2-8213-5d3bb7d2571c",
    "createdAt": "2026-04-16T18:00:00Z"
  }
}