OnZap
Criar conta

Etiquetas

Etiquetas do WhatsApp Business.

Basehttps://app.onzap.io/v1/instances/{instanceId}AuthX-Instance-Token: SEU_TOKEN

Listar etiquetas

GET/v1/instances/{instanceId}/labels
API OnZap
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/labels" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta
[
  {
    "color": 0,
    "colorHex": "#ff9485",
    "id": "1",
    "name": "Lead"
  }
]

Criar etiqueta

POST/v1/instances/{instanceId}/labels
API OnZap

Corpo (JSON)

namestringobrigatório
Label name
colornumberopcional
Color number, not hex
colorHexstringopcional
Color in hex
Requisição
curl -X POST "https://app.onzap.io/v1/instances/SUA_INSTANCIA/labels" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lead"
  }'
Resposta
{
  "color": 0,
  "colorHex": "#ff9485",
  "id": "1",
  "name": "Lead"
}

Etiquetas do chat

GET/v1/instances/{instanceId}/labels/chats/{chatId}
API OnZap

Parâmetros do caminho

chatIdstringobrigatório
Conversa: número com DDI e DDD (5511999999999) ou JID (…@c.us, …@g.us, …@lid).
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/labels/chats/5511999999999" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta
[
  {
    "color": 0,
    "colorHex": "#ff9485",
    "id": "1",
    "name": "Lead"
  }
]

Definir etiquetas do chat

PUT/v1/instances/{instanceId}/labels/chats/{chatId}
API OnZap

Parâmetros do caminho

chatIdstringobrigatório
Conversa: número com DDI e DDD (5511999999999) ou JID (…@c.us, …@g.us, …@lid).

Corpo (JSON)

labelsarray de objectobrigatório
labels[].idstringobrigatório
Label ID
Requisição
curl -X PUT "https://app.onzap.io/v1/instances/SUA_INSTANCIA/labels/chats/5511999999999" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "labels": [
      {
        "id": "1"
      }
    ]
  }'
Resposta

Sucesso

Atualizar etiqueta

PUT/v1/instances/{instanceId}/labels/{labelId}
API OnZap

Parâmetros do caminho

labelIdstringobrigatório

Corpo (JSON)

namestringobrigatório
Label name
colornumberopcional
Color number, not hex
colorHexstringopcional
Color in hex
Requisição
curl -X PUT "https://app.onzap.io/v1/instances/SUA_INSTANCIA/labels/LABELID" \
  -H "X-Instance-Token: $ONZAP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Lead"
  }'
Resposta
{
  "color": 0,
  "colorHex": "#ff9485",
  "id": "1",
  "name": "Lead"
}

Excluir etiqueta

DELETE/v1/instances/{instanceId}/labels/{labelId}
API OnZap

Parâmetros do caminho

labelIdstringobrigatório
Requisição
curl -X DELETE "https://app.onzap.io/v1/instances/SUA_INSTANCIA/labels/LABELID" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta
{}

Chats com a etiqueta

GET/v1/instances/{instanceId}/labels/{labelId}/chats
API OnZap

Parâmetros do caminho

labelIdstringobrigatório
Requisição
curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/labels/LABELID/chats" \
  -H "X-Instance-Token: $ONZAP_TOKEN"
Resposta

Sucesso