VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: caixa de entrada

Notas internas

Anotações da equipe sobre uma conversa, invisíveis para o cliente.

Uma nota interna é um recado que a equipe deixa em uma conversa ("cliente quer fatura da empresa"). Ela nunca é enviada ao cliente. Notas fixadas sobem para o topo. A exclusão é lógica: a nota some das listas, mas é mantida para auditoria.

Listar notas

Devolve todas as notas ativas da conversa.

GET/api/v1/admin/whatsapp/threads/{id}/notesAdmin

Lista as notas internas da conversa

Parâmetros de caminho

idstringobrigatório
UUID da conversa.

Exemplo de requisição (Listar notas)

bash
curl "$BASE_URL/api/v1/admin/whatsapp/threads/014ff6d8-8ff0-40da-82ce-e5a349b57be6/notes" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Listar notas)

200Notas
json
{
  "notes": [
    {
      "id": "6c1e0d9a-4b0e-4d6b-8a1e-7f2f3a9d1c20",
      "thread_id": "014ff6d8-8ff0-40da-82ce-e5a349b57be6",
      "author_user_id": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
      "author_name": "Ana Souza",
      "body": "Cliente quer fatura em nome da empresa.",
      "is_pinned": true,
      "created_at": "2026-10-11T15:00:00Z",
      "updated_at": "2026-10-11T15:00:00Z",
      "edited": false
    }
  ],
  "total": 1
}

Campos da resposta

notesarray

Notas.

idstring
UUID da nota.
thread_idstring
UUID da conversa.
author_user_idstring
UUID do autor. Ausente se o usuário foi apagado.
author_namestring
Nome do autor no momento da criação (preservado mesmo se o usuário sair).
bodystring
Texto simples. Quebras de linha são preservadas.
is_pinnedboolean
Notas fixadas aparecem primeiro.
created_atstring
Criação, RFC 3339.
updated_atstring
Última edição.
editedboolean
true se a nota foi editada (mais de 1 segundo depois de criada).
totalinteger
Quantidade de notas.

Erros (Listar notas)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_orders"} ou {"error":"admin access required"}
404A conversa não existe.{"error":"thread not found"}

Criar nota

O autor é o usuário do token; se o nome não puder ser resolvido, vale "Admin".

POST/api/v1/admin/whatsapp/threads/{id}/notesAdmin

Cria uma nota interna na conversa

Parâmetros de caminho

idstringobrigatório
UUID da conversa.

Corpo da requisição

bodystringobrigatório
Texto da nota. Obrigatório.
is_pinnedbooleanpadrão: false
Fixar a nota.

Exemplo de requisição (Criar nota)

bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp/threads/014ff6d8-8ff0-40da-82ce-e5a349b57be6/notes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "Cliente quer fatura em nome da empresa.",
    "is_pinned": true
  }'

Resposta (Criar nota)

201Criada
json
{
  "id": "6c1e0d9a-4b0e-4d6b-8a1e-7f2f3a9d1c20",
  "thread_id": "014ff6d8-8ff0-40da-82ce-e5a349b57be6",
  "author_user_id": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
  "author_name": "Ana Souza",
  "body": "Cliente quer fatura em nome da empresa.",
  "is_pinned": true,
  "created_at": "2026-10-11T15:00:00Z",
  "updated_at": "2026-10-11T15:00:00Z",
  "edited": false
}

Campos da resposta

idstring
UUID da nota.
thread_idstring
UUID da conversa.
author_user_idstring
UUID do autor. Ausente se o usuário foi apagado.
author_namestring
Nome do autor no momento da criação (preservado mesmo se o usuário sair).
bodystring
Texto simples. Quebras de linha são preservadas.
is_pinnedboolean
Notas fixadas aparecem primeiro.
created_atstring
Criação, RFC 3339.
updated_atstring
Última edição.
editedboolean
true se a nota foi editada (mais de 1 segundo depois de criada).

Erros (Criar nota)

StatusQuandoCorpo
400Corpo inválido, body vazio ou módulo desligado.{"error":"whatsapp thread note: body required"}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_orders"} ou {"error":"admin access required"}
404A conversa não existe.{"error":"thread not found"}

Editar nota

Atualização parcial: só os campos enviados mudam. Qualquer administrador com o privilégio pode editar notas de outros autores.

PATCH/api/v1/admin/whatsapp/threads/{id}/notes/{note_id}Admin

Altera o texto ou o estado de fixação de uma nota

Parâmetros de caminho

idstringobrigatório
UUID da conversa.
note_idstringobrigatório
UUID da nota.

Corpo da requisição

bodystring
Novo texto.
is_pinnedboolean
Fixar ou desafixar.

Exemplo de requisição (Editar nota)

bash
curl -X PATCH "$BASE_URL/api/v1/admin/whatsapp/threads/014ff6d8-8ff0-40da-82ce-e5a349b57be6/notes/6c1e0d9a-4b0e-4d6b-8a1e-7f2f3a9d1c20" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "is_pinned": false
  }'

Resposta (Editar nota)

200Atualizada
json
{
  "id": "6c1e0d9a-4b0e-4d6b-8a1e-7f2f3a9d1c20",
  "thread_id": "014ff6d8-8ff0-40da-82ce-e5a349b57be6",
  "author_user_id": "d4613dde-ac7a-431c-9232-50d8cd6ad5fc",
  "author_name": "Ana Souza",
  "body": "Cliente quer fatura em nome da empresa.",
  "is_pinned": false,
  "created_at": "2026-10-11T15:00:00Z",
  "updated_at": "2026-10-11T15:00:00Z",
  "edited": true
}

Campos da resposta

idstring
UUID da nota.
thread_idstring
UUID da conversa.
author_user_idstring
UUID do autor. Ausente se o usuário foi apagado.
author_namestring
Nome do autor no momento da criação (preservado mesmo se o usuário sair).
bodystring
Texto simples. Quebras de linha são preservadas.
is_pinnedboolean
Notas fixadas aparecem primeiro.
created_atstring
Criação, RFC 3339.
updated_atstring
Última edição.
editedboolean
true se a nota foi editada (mais de 1 segundo depois de criada).

Erros (Editar nota)

StatusQuandoCorpo
400Corpo inválido.{"error":"invalid request body"}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_orders"} ou {"error":"admin access required"}
404Nota inexistente ou já excluída.{"error":"note not found"}

Excluir nota

A nota some das listas. Responde 204 sem corpo.

DELETE/api/v1/admin/whatsapp/threads/{id}/notes/{note_id}Admin

Exclui (logicamente) uma nota interna

Parâmetros de caminho

idstringobrigatório
UUID da conversa.
note_idstringobrigatório
UUID da nota.

Exemplo de requisição (Excluir nota)

bash
curl -X DELETE "$BASE_URL/api/v1/admin/whatsapp/threads/014ff6d8-8ff0-40da-82ce-e5a349b57be6/notes/6c1e0d9a-4b0e-4d6b-8a1e-7f2f3a9d1c20" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Excluir nota)

204Excluída
http
HTTP/1.1 204 No Content

Erros (Excluir nota)

StatusQuandoCorpo
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O módulo WhatsApp Commerce está desligado na loja, o usuário não é administrador ou não tem o privilégio exigido.{"error":"module_disabled","module":"whatsapp-commerce"} ou {"error":"insufficient privileges","required":"manage_orders"} ou {"error":"admin access required"}
404Nota inexistente ou já excluída.{"error":"note not found"}

Veja também

  • Conversas
  • Responder ao cliente
Anterior
Orçamento do carrinho em PDF
Próxima
Respostas prontas
Nesta página
  • Listar notas
  • Exemplo de requisição (Listar notas)
  • Resposta (Listar notas)
  • Erros (Listar notas)
  • Criar nota
  • Exemplo de requisição (Criar nota)
  • Resposta (Criar nota)
  • Erros (Criar nota)
  • Editar nota
  • Exemplo de requisição (Editar nota)
  • Resposta (Editar nota)
  • Erros (Editar nota)
  • Excluir nota
  • Exemplo de requisição (Excluir nota)
  • Resposta (Excluir nota)
  • Erros (Excluir nota)
  • Veja também