Skip to main content
PUT
/
api
/
{session}
/
labels
/
chats
/
{chatId}
Salvar etiquetas para a conversa
curl --request PUT \
  --url https://{host}/api/{session}/labels/chats/{chatId} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '{
  "labels": [
    {
      "id": "1"
    }
  ]
}'
{
  "success": true,
  "chatId": "5511999999999@s.whatsapp.net",
  "labelId": "label123",
  "action": "add"
}

Descrição

Este endpoint permite adicionar ou remover um rótulo de um chat específico, permitindo organizar e categorizar suas conversas.

Parâmetros de URL

session
string
required
ID único da sessão WhatsApp
chatId
string
required
ID do chat (JID do contato ou grupo)

Corpo da Requisição

labelId
string
required
ID do rótulo a ser adicionado ou removido
action
string
required
Ação a ser executada: “add” (adicionar) ou “remove” (remover)

Resposta

success
boolean
Indica se a operação foi executada com sucesso
{
  "success": true,
  "chatId": "5511999999999@s.whatsapp.net",
  "labelId": "label123",
  "action": "add"
}

Códigos de Status

  • 200 - Operação executada com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Não autorizado
  • 404 - Chat ou rótulo não encontrado

Exemplo de Uso

curl -X PUT https://api.wappfy.com.br/api/my-session/labels/chats/5511999999999@s.whatsapp.net \
  -H "Content-Type: application/json" \
  -d '{
    "labelId": "label123",
    "action": "add"
  }'

Authorizations

apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

chatId
string
required

ID da Conversa

Body

application/json
labels
object[]
required
I