Ir al contenido

Endpoints

Tags

The workspace tag list that contact tags come from.

Las rutas son relativas a la URL base. Cada tarjeta indica el permiso que necesita la llamada y cada parámetro, con su tipo y sus límites.

GET
/tags

List workspace tags.

Permiso: contacts
POST
/tags

Create a workspace tag.

Permiso: contacts

Cuerpo JSON

  • nameobligatoriostring

    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.

Permiso: contacts

Parámetros de ruta

  • idobligatoriointeger

    Tag ID.

Cuerpo 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.

Permiso: contacts

Parámetros de ruta

  • idobligatoriointeger

    Tag ID.