Quando usar
- Você precisa remover tags de múltiplos contatos de uma vez sem precisar abrir cada contato manualmente
- Você está rodando uma rotina de limpeza ou correção de tags em base de contatos
- Você quer manter a base organizada após uma campanha ou migração
Pré-requisitos
-
API Key (
API_TOKEN) em mãos — ver Como encontrar sua API Key no Cloud Chat -
ACCOUNT_IDda conta -
Cada contato precisa ter ao menos um identificador entre
identifier,emailouphone_number
Endpoint
DELETE https://cloudchat.cloudhumans.com/api/v1/accounts/{ACCOUNT_ID}/contacts/delete_tags
Headers
| Header | Valor |
|---|---|
content-type |
application/json |
api_access_token |
Seu token de API |

Corpo da requisição
O body deve conter um único campo contacts, que é um array de objetos. Cada objeto representa um contato e deve conter:
| Campo | Obrigatório | Descrição |
|---|---|---|
identifier |
Pelo menos 1 dos 3* | Identificador único do contato |
email |
Pelo menos 1 dos 3* | E-mail do contato |
phone_number |
Pelo menos 1 dos 3* | Telefone do contato |
tags |
Sim | Array com as tags a remover (pelo nome) |
*Pelo menos um identificador deve ser informado para localizar o contato.
Exemplo de requisição
curl --request DELETE \
--url 'https://cloudchat.cloudhumans.com/api/v1/accounts/ACCOUNT_ID/contacts/delete_tags' \
--header 'api_access_token: API_TOKEN' \
--header 'content-type: application/json' \
--data '{
"contacts": [
{
"identifier": 123,
"tags": ["tag-de-massa-1","tag-de-massa-2"]
},
{
"email": "[email protected]",
"tags": ["tag-de-massa-2","tag-de-massa-3"]
},
{
"phone_number": 5551000000000,
"tags": ["tag-de-massa-1","tag-de-massa-3"]
}
]
}'
Como o contato é localizado
O sistema busca o contato nesta ordem:
-
identifier(primeiro) -
email(segundo) -
phone_number(terceiro)
Diferente do endpoint de import de contato (que prioriza email), aqui o identifier tem prioridade.
Sobre phone_number
Se enviado sem o prefixo +, o sistema adiciona automaticamente (ex: 5511999998888 → +5511999998888).
Observações
-
Para criar ou atualizar contatos (incluindo gerenciar tags com
tags_addetags_removegranulares): Como importar contatos em massa via API -
Para atualizar atributos customizados (não tags) em conversas: Como atualizar atributos customizados em conversas via API
-
Visão geral de todas as APIs disponíveis: Guia Mestre — Como acessar e operar dados do Cloud Chat via API