Desenvolvedores

Endpoints

Tags

The workspace tag list that contact tags come from.

Os caminhos são relativos à URL base. Cada card lista a permissão que a chamada exige e todos os parâmetros, com tipo e limites.

GET

/tags

List workspace tags.

Permissão: contacts

POST

/tags

Create a workspace tag.

Permissão: contacts

Corpo JSON

nameobrigatóriostring
1–80 characters. Must be unique (case-insensitive), else 409.
coloropcionalenum | null
Tag color.
Valores permitidos: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.

Permissão: contacts

Parâmetros de caminho

idobrigatóriointeger
Tag ID.

Corpo JSON

nameopcionalstring
1–80 characters.
coloropcionalenum | null
Tag color.
Valores permitidos: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.

Permissão: contacts

Parâmetros de caminho

idobrigatóriointeger
Tag ID.