API atual/Referência completa/WhatsApp Commerce: caixa de entrada

Notas internas

Lista, cria e apaga anotações da equipe dentro de uma conversa, que o cliente nunca vê.

Uma nota interna é um recado da equipe do seller preso a uma conversa: "cliente prefere falar de manhã", "já combinei desconto de 5%". O texto não é enviado ao WhatsApp do cliente. O autor é definido pelo servidor a partir do token (você não envia o nome), então ninguém consegue assinar uma nota como outra pessoa.

Listar as notas

GET/api/v1/vendor/whatsapp/inbox/threads/{id}/notesSeller

Lista as notas internas de uma conversa

As notas fixadas vêm primeiro; depois as demais, da mais nova para a mais antiga. Notas apagadas não aparecem. Conversa sem notas devolve lista vazia, não 404.

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp/inbox/threads/$THREAD_ID/notes" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Notas da conversa

json

{
  "notes": [
    {
      "id": "0c8a6f3e-2b71-4a9d-9a55-6d1b0e7f2c40",
      "thread_id": "9b1f3c52-6a0e-4d57-8a43-2f6c1d7e90ab",
      "author_user_id": "d4613dde-ac7a-4319-9232-50d8cd6ad5fc",
      "author_name": "Carla Mendes",
      "body": "Prefere atendimento de manhã. Combinado 5% de desconto.",
      "is_pinned": true,
      "created_at": "2026-10-10T14:00:00Z",
      "updated_at": "2026-10-10T14:00:00Z",
      "edited": false
    }
  ],
  "total": 1
}

Campos da resposta

notesarray

Notas da conversa.

notes[].iduuid

Id da nota. Use para apagar.

notes[].thread_iduuid

Conversa a que pertence.

notes[].author_user_iduuid

Usuário que escreveu. Ausente se o usuário foi removido.

notes[].author_namestring

Nome do autor no momento em que escreveu. Fica gravado na nota, então não muda se o usuário for renomeado ou removido.

notes[].bodystring

Texto da nota, com quebras de linha preservadas.

notes[].is_pinnedboolean

true para notas fixadas no topo.

notes[].created_atstring

RFC 3339.

notes[].updated_atstring

RFC 3339.

notes[].editedboolean

true se a nota foi alterada mais de 1 segundo depois de criada.

totalinteger

Quantidade de notas.

Erros

Status	Quando	Corpo
401 / 403	Autenticação, módulo ou privilégio	veja Conversas
404	Conversa de outro seller ou inexistente	`{"error":"thread not found"}`
500	Falha ao ler	`{"error":"Failed to list notes: ..."}`

Criar uma nota

POST/api/v1/vendor/whatsapp/inbox/threads/{id}/notesSeller

Cria uma nota interna na conversa

Retorna 201 com a nota criada.

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Corpo da requisição

bodystringobrigatório

Texto da nota. Espaços nas pontas são removidos. Passando de 10.000 caracteres, o texto é cortado em silêncio nesse limite.

is_pinnedbooleanpadrão: false

true para fixar no topo da lista.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp/inbox/threads/$THREAD_ID/notes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body": "Prefere atendimento de manhã.", "is_pinned": true}'

Resposta

201Nota criada

json

{
  "id": "0c8a6f3e-2b71-4a9d-9a55-6d1b0e7f2c40",
  "thread_id": "9b1f3c52-6a0e-4d57-8a43-2f6c1d7e90ab",
  "author_user_id": "d4613dde-ac7a-4319-9232-50d8cd6ad5fc",
  "author_name": "Carla Mendes",
  "body": "Prefere atendimento de manhã.",
  "is_pinned": true,
  "created_at": "2026-10-11T13:15:00Z",
  "updated_at": "2026-10-11T13:15:00Z",
  "edited": false
}

Os campos são os de um item de notes na listagem.

Erros

Status	Quando	Corpo
400	JSON inválido	`{"error":"invalid request body"}`
400	`body` vazio	`{"error":"whatsapp thread note: body required"}`
401 / 403	Autenticação, módulo ou privilégio	veja Conversas
404	Conversa de outro seller ou inexistente	`{"error":"thread not found"}`

Apagar uma nota

DELETE/api/v1/vendor/whatsapp/inbox/threads/{id}/notes/{note_id}Seller

Apaga uma nota interna

Remove a nota da listagem (exclusão lógica: o registro não é destruído). Responde 204 sem corpo.

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

note_iduuidobrigatório

Id da nota (notes[].id).

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/vendor/whatsapp/inbox/threads/$THREAD_ID/notes/$NOTE_ID" \
  -H "Authorization: Bearer $TOKEN"

Resposta

204Nota apagada

http

HTTP/1.1 204 No Content

Erros

Status	Quando	Corpo
401 / 403	Autenticação, módulo ou privilégio	veja Conversas
404	Conversa de outro seller ou inexistente	`{"error":"thread not found"}`
404	Nota inexistente ou já apagada	`{"error":"note not found"}`

Veja também

API atual/Referência completa/WhatsApp Commerce: caixa de entrada

Notas internas

Lista, cria e apaga anotações da equipe dentro de uma conversa, que o cliente nunca vê.

Listar as notas

GET/api/v1/vendor/whatsapp/inbox/threads/{id}/notesSeller

Lista as notas internas de uma conversa

As notas fixadas vêm primeiro; depois as demais, da mais nova para a mais antiga. Notas apagadas não aparecem. Conversa sem notas devolve lista vazia, não 404.

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/whatsapp/inbox/threads/$THREAD_ID/notes" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Notas da conversa

json

{
  "notes": [
    {
      "id": "0c8a6f3e-2b71-4a9d-9a55-6d1b0e7f2c40",
      "thread_id": "9b1f3c52-6a0e-4d57-8a43-2f6c1d7e90ab",
      "author_user_id": "d4613dde-ac7a-4319-9232-50d8cd6ad5fc",
      "author_name": "Carla Mendes",
      "body": "Prefere atendimento de manhã. Combinado 5% de desconto.",
      "is_pinned": true,
      "created_at": "2026-10-10T14:00:00Z",
      "updated_at": "2026-10-10T14:00:00Z",
      "edited": false
    }
  ],
  "total": 1
}

Campos da resposta

notesarray

Notas da conversa.

notes[].iduuid

Id da nota. Use para apagar.

notes[].thread_iduuid

Conversa a que pertence.

notes[].author_user_iduuid

Usuário que escreveu. Ausente se o usuário foi removido.

notes[].author_namestring

Nome do autor no momento em que escreveu. Fica gravado na nota, então não muda se o usuário for renomeado ou removido.

notes[].bodystring

Texto da nota, com quebras de linha preservadas.

notes[].is_pinnedboolean

true para notas fixadas no topo.

notes[].created_atstring

RFC 3339.

notes[].updated_atstring

RFC 3339.

notes[].editedboolean

true se a nota foi alterada mais de 1 segundo depois de criada.

totalinteger

Quantidade de notas.

Erros

Status	Quando	Corpo
401 / 403	Autenticação, módulo ou privilégio	veja Conversas
404	Conversa de outro seller ou inexistente	`{"error":"thread not found"}`
500	Falha ao ler	`{"error":"Failed to list notes: ..."}`

Criar uma nota

POST/api/v1/vendor/whatsapp/inbox/threads/{id}/notesSeller

Cria uma nota interna na conversa

Retorna 201 com a nota criada.

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

Corpo da requisição

bodystringobrigatório

Texto da nota. Espaços nas pontas são removidos. Passando de 10.000 caracteres, o texto é cortado em silêncio nesse limite.

is_pinnedbooleanpadrão: false

true para fixar no topo da lista.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/whatsapp/inbox/threads/$THREAD_ID/notes" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body": "Prefere atendimento de manhã.", "is_pinned": true}'

Resposta

201Nota criada

json

{
  "id": "0c8a6f3e-2b71-4a9d-9a55-6d1b0e7f2c40",
  "thread_id": "9b1f3c52-6a0e-4d57-8a43-2f6c1d7e90ab",
  "author_user_id": "d4613dde-ac7a-4319-9232-50d8cd6ad5fc",
  "author_name": "Carla Mendes",
  "body": "Prefere atendimento de manhã.",
  "is_pinned": true,
  "created_at": "2026-10-11T13:15:00Z",
  "updated_at": "2026-10-11T13:15:00Z",
  "edited": false
}

Os campos são os de um item de notes na listagem.

Erros

Status	Quando	Corpo
400	JSON inválido	`{"error":"invalid request body"}`
400	`body` vazio	`{"error":"whatsapp thread note: body required"}`
401 / 403	Autenticação, módulo ou privilégio	veja Conversas
404	Conversa de outro seller ou inexistente	`{"error":"thread not found"}`

Apagar uma nota

DELETE/api/v1/vendor/whatsapp/inbox/threads/{id}/notes/{note_id}Seller

Apaga uma nota interna

Remove a nota da listagem (exclusão lógica: o registro não é destruído). Responde 204 sem corpo.

Parâmetros de caminho

iduuidobrigatório

Id da conversa.

note_iduuidobrigatório

Id da nota (notes[].id).

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/vendor/whatsapp/inbox/threads/$THREAD_ID/notes/$NOTE_ID" \
  -H "Authorization: Bearer $TOKEN"

Resposta

204Nota apagada

http

HTTP/1.1 204 No Content

Erros

Status	Quando	Corpo
401 / 403	Autenticação, módulo ou privilégio	veja Conversas
404	Conversa de outro seller ou inexistente	`{"error":"thread not found"}`
404	Nota inexistente ou já apagada	`{"error":"note not found"}`