Skip to content
Developers

Endpoints

Tags

The workspace tag list that contact tags come from.

Paths are relative to the base URL. Each card lists the permission the call needs and every parameter, with its type and limits.

GET
/tags

List workspace tags.

Permission: contacts
POST
/tags

Create a workspace tag.

Permission: contacts

JSON body

  • namerequiredstring

    1–80 characters. Must be unique (case-insensitive), else 409.

  • coloroptionalenum | null

    Tag color.

    Allowed values:chart-1chart-2chart-3chart-4chart-5chart-6chart-7chart-8

PATCH
/tags/:id

Rename or recolor a tag. A rename updates every contact that has it. Send name, color, or both.

Permission: contacts

Path parameters

  • idrequiredinteger

    Tag ID.

JSON body

  • nameoptionalstring

    1–80 characters.

  • coloroptionalenum | null

    Tag color.

    Allowed values:chart-1chart-2chart-3chart-4chart-5chart-6chart-7chart-8

DELETE
/tags/:id

Delete a tag and remove it from every contact. The response includes contacts_updated.

Permission: contacts

Path parameters

  • idrequiredinteger

    Tag ID.