Перейти к содержимому
Разработчикам

Endpoints

Tags

The workspace tag list that contact tags come from.

Пути указаны относительно базового URL. В каждой карточке указано, какое разрешение нужно для вызова, и перечислены все параметры с типами и ограничениями.

GET
/tags

List workspace tags.

Разрешение: contacts
POST
/tags

Create a workspace tag.

Разрешение: contacts

Тело JSON

  • nameобязательноstring

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

  • colorнеобязательноenum | null

    Tag color.

    Допустимые значения: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.

Разрешение: contacts

Параметры пути

  • idобязательноinteger

    Tag ID.

Тело JSON

  • nameнеобязательноstring

    1–80 characters.

  • colorнеобязательноenum | null

    Tag color.

    Допустимые значения: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.

Разрешение: contacts

Параметры пути

  • idобязательноinteger

    Tag ID.