Skip to main content
POST
Adicionar ou remover etiqueta

Autorizações

apikey
string
header
obrigatório

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
number
string
obrigatório

Número de telefone do destinatário em formato internacional (não vazio).

Exemplo:

"5511999999999"

labelId
string
obrigatório

Identificador da etiqueta a aplicar ou remover (não vazio).

Exemplo:

"1"

action
string
obrigatório

Operação a executar; add ou remove.

Exemplo:

"add"

Resposta

Sucesso — corpo de resposta nativo do provedor.

Result of adding or removing a label from a chat. The boolean flag reflects the action performed: add is present for the add action, remove for the remove action.

numberJid
string
obrigatório

The WhatsApp JID of the chat the label was applied to or removed from.

labelId
string
obrigatório

The id of the label that was handled.

add
boolean

Present and true when the label was added to the chat (action = add).

remove
boolean

Present and true when the label was removed from the chat (action = remove).