Etiquetar conversa

PUT/v1/instances/{id}/labels/{label_id}/chats/{jid}desde M10token da instância ou admin

Quando usar

Etiquetar conversa

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

Nome	Tipo	Descrição
idobrigatório	string	Id da instância (inst_...).
label_idobrigatório	string
jidobrigatório	string	JID do chat (...@s.whatsapp.net, ...@g.us, ...@lid) ou número com DDI. Prefira o jid devolvido por GET /chats ou check-numbers.

Exemplo

cURL

curl -s -X PUT "$LITEZAP_URL/v1/instances/$ID/labels/$LABEL_ID/chats/$JID" \
  -H "Authorization: Bearer $LITEZAP_TOKEN"

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/labels/label_id/chats/5511999999999@s.whatsapp.net", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}` },
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.put(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/labels/label_id/chats/5511999999999@s.whatsapp.net",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("PUT", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/labels/label_id/chats/5511999999999@s.whatsapp.net", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('PUT', '/v1/instances/inst_7f3a9c2e5b1d4086/labels/label_id/chats/5511999999999@s.whatsapp.net', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 A etiqueta com suas conversas.

Campos de Label

id	string
name	string
color	integer	Índice na paleta do WhatsApp.
chats	string[]

Erros

Código	HTTP	Retentável	O que fazer
not_found	404	não	Confira o id do recurso (mensagem, chat, contato, mídia ou webhook).
instance_not_found	404	não	Confira o id da instância.
business_account_required	409	não

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Eventos gerados

• label.updated

Equivalente na Z-API: Atribuir etiqueta a um chat. Veja Migrar da Z-API.

Outras operações de Etiquetas e Business: Listar etiquetas · Criar etiqueta · Renomear ou mudar a cor · Apagar etiqueta · Remover etiqueta da conversa · Etiquetar mensagem · Remover etiqueta da mensagem · Perfil comercial