API de Etiquetas

Criar, buscar e deletar etiquetas em configurações via API

Agora só copiar a url e o token:

Teremos 3 métodos:

  • GET (buscar todas as etiquetas): o token vai no Header da requisição. "Authorization": "Bearer seu_token". Você também precisa adicionar /tags no final da url. A resposta será um array de objetos contendo todas as etiquetas, e cada item terá os seguintes parâmetros: id, tag, color, isActive, userId, tenantId, createdAt, updatedAt

  • POST (criar uma ou mais etiquetas): o token vai no Header da requisição. "Authorization": "Bearer seu_token". Você também precisa adicionar /tags no final da url. O BODY da requisição será esse:

[
  {
    "tag": "Tag 1",
    "color": "#FF0000",
    "userId": null
  },
  {
    "tag": "Tag 2",
    "color": "#00FF00",
    "userId": null
  },
  {
    "tag": "Tag 3",
    "color": "#0000FF",
    "userId": null
  }
]

Você vai precisar passar um Id de usuário, pois as etiquetas são criadas fazendo esse vínculo, se deixar o userId = null, não vai criar. Você pode criar uma ou mais de uma etiqueta.

  • DELETE (deletar etiquetas): o token vai no Header da requisição. "Authorization": "Bearer seu_token". Você também precisa adicionar /tags/id_etiqueta no final da url.

Você também pode encontrar essas informações em Configurações -> Api/Webhook -> documentação

Last updated