WhatsApp | Venddor API

Veja quais números de WhatsApp estão ligados a uma conta de cliente e solte um número quando preciso.

Quando a loja vende pelo WhatsApp, o assistente reconhece o cliente pelo número que ele usa na conversa. Esse reconhecimento é um vínculo entre o número e a conta do cliente, criado quando o cliente entra pela mini-loja, faz um pedido pelo WhatsApp ou é atendido por um atendente. Um mesmo cliente pode ter vários números ligados.

Estas rotas servem ao suporte: ver quais números estão "logados" numa conta e soltar um deles, por exemplo quando o cliente trocou de chip e o número antigo caiu com outra pessoa.

Soltar um número não apaga o carrinho: o carrinho continua na conta. O número volta a ser um visitante, e só é reconhecido de novo quando o cliente entrar outra vez pela mini-loja. Desativar ou excluir a conta (Alterar cliente, Excluir cliente) solta todos os números sozinho.

GET/api/v1/admin/users/{id}/whatsapp-bindingsAdmin

Números de WhatsApp vinculados a uma conta de cliente

Lista os vínculos ativos da conta. Exige view_users ou manage_users.

Path parameters

iduuidobrigatório

Id do usuário.

200Vínculos da conta

json

{
  "bindings": [
    {
      "id": "6e4d2a1c-8f3b-4b7e-9c11-0a5d7f2e9b34",
      "phone": "5511999990000",
      "web_session": false,
      "source": "B",
      "linked_at": "2026-09-30T14:02:11Z",
      "last_activity_at": "2026-10-10T19:45:03Z",
      "matches_account_phone": true
    }
  ]
}

Campos da resposta

bindingsarray

Vínculos. Lista vazia se a conta não tem número ligado.

bindings[].iduuid

Id do vínculo, usado para soltar.

bindings[].phonestring

Número, só dígitos, com código do país. Quando web_session é true, não é um telefone.

bindings[].web_sessionboolean

true para uma mini-loja aberta na web sem número. Também pode ser solta.

bindings[].sourcestring

WNAB

Como o vínculo nasceu: W mini-loja web, N pedido nativo, A atendente, B assistente (bot).

bindings[].linked_atstring

Quando foi ligado (RFC 3339), quando conhecido.

bindings[].last_activity_atstring

Última atividade (RFC 3339), quando conhecida.

bindings[].matches_account_phoneboolean

true se o número é o telefone (ou o WhatsApp) cadastrado na conta.

DELETE/api/v1/admin/users/{id}/whatsapp-bindings/{bindingId}Admin

Desvincula um número de WhatsApp de uma conta de cliente

Solta o número: ele deixa de ser reconhecido na conta. Exige manage_users. A ação é registrada no histórico de atividades da loja.

Path parameters

iduuidobrigatório

Id do usuário.

bindingIduuidobrigatório

Id do vínculo, de bindings[].id.

200Número solto

json

{
  "revoked": {
    "id": "6e4d2a1c-8f3b-4b7e-9c11-0a5d7f2e9b34",
    "phone": "5511999990000",
    "web_session": false,
    "source": "B",
    "matches_account_phone": true
  }
}

Exemplo de requisição

bash

# Listar
curl "$BASE_URL/api/v1/admin/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f/whatsapp-bindings" \
  -H "Authorization: Bearer $TOKEN"

# Soltar um número
curl -X DELETE "$BASE_URL/api/v1/admin/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f/whatsapp-bindings/6e4d2a1c-8f3b-4b7e-9c11-0a5d7f2e9b34" \
  -H "Authorization: Bearer $TOKEN"

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"error":"invalid or expired token"}`
403	Falta o privilégio	`{"error":"insufficient privileges","required":"manage_users"}` (soltar) ou `{"error":"insufficient privileges","privilege_required_any":["manage_users","view_users"]}` (listar)
404	Usuário inexistente (listar) ou vínculo inexistente (soltar)	`{"error":"user not found"}` ou `{"error":"whatsapp binding not found"}`
500	Falha interna	`{"error":"failed to list whatsapp bindings","detail":"..."}`

Veja também

Veja quais números de WhatsApp estão ligados a uma conta de cliente e solte um número quando preciso.

Estas rotas servem ao suporte: ver quais números estão "logados" numa conta e soltar um deles, por exemplo quando o cliente trocou de chip e o número antigo caiu com outra pessoa.

GET/api/v1/admin/users/{id}/whatsapp-bindingsAdmin

Números de WhatsApp vinculados a uma conta de cliente

Lista os vínculos ativos da conta. Exige view_users ou manage_users.

Path parameters

iduuidobrigatório

Id do usuário.

200Vínculos da conta

json

{
  "bindings": [
    {
      "id": "6e4d2a1c-8f3b-4b7e-9c11-0a5d7f2e9b34",
      "phone": "5511999990000",
      "web_session": false,
      "source": "B",
      "linked_at": "2026-09-30T14:02:11Z",
      "last_activity_at": "2026-10-10T19:45:03Z",
      "matches_account_phone": true
    }
  ]
}

Campos da resposta

bindingsarray

Vínculos. Lista vazia se a conta não tem número ligado.

bindings[].iduuid

Id do vínculo, usado para soltar.

bindings[].phonestring

Número, só dígitos, com código do país. Quando web_session é true, não é um telefone.

bindings[].web_sessionboolean

true para uma mini-loja aberta na web sem número. Também pode ser solta.

bindings[].sourcestring

WNAB

Como o vínculo nasceu: W mini-loja web, N pedido nativo, A atendente, B assistente (bot).

bindings[].linked_atstring

Quando foi ligado (RFC 3339), quando conhecido.

bindings[].last_activity_atstring

Última atividade (RFC 3339), quando conhecida.

bindings[].matches_account_phoneboolean

true se o número é o telefone (ou o WhatsApp) cadastrado na conta.

DELETE/api/v1/admin/users/{id}/whatsapp-bindings/{bindingId}Admin

Desvincula um número de WhatsApp de uma conta de cliente

Solta o número: ele deixa de ser reconhecido na conta. Exige manage_users. A ação é registrada no histórico de atividades da loja.

Path parameters

iduuidobrigatório

Id do usuário.

bindingIduuidobrigatório

Id do vínculo, de bindings[].id.

200Número solto

json

{
  "revoked": {
    "id": "6e4d2a1c-8f3b-4b7e-9c11-0a5d7f2e9b34",
    "phone": "5511999990000",
    "web_session": false,
    "source": "B",
    "matches_account_phone": true
  }
}

Exemplo de requisição

bash

# Listar
curl "$BASE_URL/api/v1/admin/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f/whatsapp-bindings" \
  -H "Authorization: Bearer $TOKEN"

# Soltar um número
curl -X DELETE "$BASE_URL/api/v1/admin/users/3dc023ca-3746-4b6e-8afd-686a4a9af99f/whatsapp-bindings/6e4d2a1c-8f3b-4b7e-9c11-0a5d7f2e9b34" \
  -H "Authorization: Bearer $TOKEN"

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"error":"invalid or expired token"}`
403	Falta o privilégio	`{"error":"insufficient privileges","required":"manage_users"}` (soltar) ou `{"error":"insufficient privileges","privilege_required_any":["manage_users","view_users"]}` (listar)
404	Usuário inexistente (listar) ou vínculo inexistente (soltar)	`{"error":"user not found"}` ou `{"error":"whatsapp binding not found"}`
500	Falha interna	`{"error":"failed to list whatsapp bindings","detail":"..."}`