Settings

Apply Label to Chat

Manages the labels of a chat. Use `labelids` to set all labels at once, `add_labelid` to add one label, or `remove_labelid` to remove one. Send only one of these fields per request.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/chat/labels

Authentication with the x-api-key and x-api-secret headers.

Parameters

Name	Type	In	Required	Description
`number`	text	body	Yes	Contact number
`labelids`	textarea	body	No	Label IDs (array, replaces all)
`add_labelid`	text	body	No	Add Label (ID)
`remove_labelid`	text	body	No	Remove Label (ID)

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/chat/labels" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999"}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/chat/labels", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "number": "5511999999999"
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/chat/labels",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"number":"5511999999999"},
)
print(res.json())

Response example

JSON

{
  "response": "Label added to chat"
}

Values are illustrative; the fields follow the real response format.

Other endpoints in this category

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.

Create free account View the documentation