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

Respostas prontas

Modelos de texto que o atendente insere com um clique: criar, listar, ordenar, editar e excluir.

Respostas prontas são textos que a equipe usa o tempo todo ("Atendemos de segunda a sexta..."). Cada resposta tem título e texto. Quem não está vinculado a um seller enxerga e edita só as respostas da loja; um usuário vinculado a um seller enxerga e edita só as desse seller. Cada escopo comporta até 200 respostas.

Listar

Só as ativas, ordenadas por sort_order e depois por título.

GET/api/v1/admin/whatsapp/canned-repliesAdmin

Lista as respostas prontas do seu escopo

Exemplo de requisição (Listar)

Resposta (Listar)

200Lista

Campos da resposta

repliesarray

Respostas.

idstring
UUID da resposta pronta.
vendor_idstring
UUID do seller dono. Ausente nas respostas da loja.
titlestring
Título curto mostrado ao atendente.
bodystring
Texto que será inserido na resposta.
sort_orderinteger
Posição na lista (0 é o primeiro).
activeboolean
Sempre true nas listagens: excluídas não aparecem.
created_atstring
Criação, RFC 3339.
updated_atstring
Última alteração.
created_bystring
UUID de quem criou.
totalinteger
Quantidade.

Erros (Listar)

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"}

Criar

Cria a resposta no escopo do usuário.

POST/api/v1/admin/whatsapp/canned-repliesAdmin

Cria uma resposta pronta

Corpo da requisição

titlestringobrigatório
Título, até 120 caracteres.
bodystringobrigatório
Texto, até 4096 caracteres.
sort_orderintegerpadrão: 0
Posição inicial.

Exemplo de requisição (Criar)

Resposta (Criar)

201Criada

Campos da resposta

idstring
UUID da resposta pronta.
vendor_idstring
UUID do seller dono. Ausente nas respostas da loja.
titlestring
Título curto mostrado ao atendente.
bodystring
Texto que será inserido na resposta.
sort_orderinteger
Posição na lista (0 é o primeiro).
activeboolean
Sempre true nas listagens: excluídas não aparecem.
created_atstring
Criação, RFC 3339.
updated_atstring
Última alteração.
created_bystring
UUID de quem criou.

Erros (Criar)

StatusQuandoCorpo
400Título ou texto vazio ou acima do limite, limite de 200 respostas atingido, ou corpo inválido.{"error":"whatsapp canned reply: title 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"}

Reordenar

Recebe os ids na ordem desejada: o primeiro vira sort_order 0, o segundo 1, e assim por diante, numa só transação. Ids de outro escopo são ignorados em silêncio.

PUT/api/v1/admin/whatsapp/canned-replies/reorderAdmin

Define a ordem da lista

Corpo da requisição

idsarrayobrigatório
UUIDs na ordem desejada, no máximo 200.

Exemplo de requisição (Reordenar)

Resposta (Reordenar)

200Reordenada

Campos da resposta

okboolean
true.
countinteger
Quantidade de ids recebidos.

Erros (Reordenar)

StatusQuandoCorpo
400Corpo inválido ou mais de 200 ids.{"error":"whatsapp canned reply: too many ids (201 > 200)"}
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"}

Editar

Atualização parcial: só os campos enviados mudam. active: false esconde a resposta sem excluí-la.

PUT/api/v1/admin/whatsapp/canned-replies/{id}Admin

Altera uma resposta pronta

Parâmetros de caminho

idstringobrigatório
UUID da resposta pronta.

Corpo da requisição

titlestring
Novo título.
bodystring
Novo texto.
sort_orderinteger
Nova posição.
activeboolean
Ativa ou esconde.

Exemplo de requisição (Editar)

Resposta (Editar)

200Atualizada

Campos da resposta

idstring
UUID da resposta pronta.
vendor_idstring
UUID do seller dono. Ausente nas respostas da loja.
titlestring
Título curto mostrado ao atendente.
bodystring
Texto que será inserido na resposta.
sort_orderinteger
Posição na lista (0 é o primeiro).
activeboolean
Sempre true nas listagens: excluídas não aparecem.
created_atstring
Criação, RFC 3339.
updated_atstring
Última alteração.
created_bystring
UUID de quem criou.

Erros (Editar)

StatusQuandoCorpo
400Título ou texto em branco, ou corpo inválido.{"error":"whatsapp canned reply: title cannot be empty"}
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"}
404Resposta inexistente, excluída ou de outro escopo.{"error":"canned reply not found"}

Excluir

Marca como inativa. Responde 204 sem corpo.

DELETE/api/v1/admin/whatsapp/canned-replies/{id}Admin

Exclui (logicamente) uma resposta pronta

Parâmetros de caminho

idstringobrigatório
UUID da resposta pronta.

Exemplo de requisição (Excluir)

Resposta (Excluir)

204Excluída

Erros (Excluir)

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"}
404Resposta inexistente ou de outro escopo.{"error":"canned reply not found"}

Veja também

  • Responder ao cliente
  • Conversas
Anterior
Notas internas
Próxima
Presença dos atendentes
Nesta página
  • Listar
  • Exemplo de requisição (Listar)
  • Resposta (Listar)
  • Erros (Listar)
  • Criar
  • Exemplo de requisição (Criar)
  • Resposta (Criar)
  • Erros (Criar)
  • Reordenar
  • Exemplo de requisição (Reordenar)
  • Resposta (Reordenar)
  • Erros (Reordenar)
  • Editar
  • Exemplo de requisição (Editar)
  • Resposta (Editar)
  • Erros (Editar)
  • Excluir
  • Exemplo de requisição (Excluir)
  • Resposta (Excluir)
  • Erros (Excluir)
  • Veja também
bash
curl "$BASE_URL/api/v1/admin/whatsapp/canned-replies" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X POST "$BASE_URL/api/v1/admin/whatsapp/canned-replies" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Horário de atendimento",
    "body": "Atendemos de segunda a sexta, das 9h às 18h."
  }'
bash
curl -X PUT "$BASE_URL/api/v1/admin/whatsapp/canned-replies/reorder" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      "bbaa8f20-98c7-4c97-ac5e-ece63b4c0b0b"
    ]
  }'
bash
curl -X PUT "$BASE_URL/api/v1/admin/whatsapp/canned-replies/bbaa8f20-98c7-4c97-ac5e-ece63b4c0b0b" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Horário"
  }'
bash
curl -X DELETE "$BASE_URL/api/v1/admin/whatsapp/canned-replies/bbaa8f20-98c7-4c97-ac5e-ece63b4c0b0b" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "replies": [
    {
      "id": "bbaa8f20-98c7-4c97-ac5e-ece63b4c0b0b",
      "title": "Horário de atendimento",
      "body": "Atendemos de segunda a sexta, das 9h às 18h.",
      "sort_order": 0,
      "active": true,
      "created_at": "2026-05-15T18:29:34Z",
      "updated_at": "2026-05-15T18:29:34Z",
      "created_by": "9b7bfd43-e9f8-4365-b6e1-15bccdad64ee"
    }
  ],
  "total": 1
}
json
{
  "id": "bbaa8f20-98c7-4c97-ac5e-ece63b4c0b0b",
  "title": "Horário de atendimento",
  "body": "Atendemos de segunda a sexta, das 9h às 18h.",
  "sort_order": 0,
  "active": true,
  "created_at": "2026-05-15T18:29:34Z",
  "updated_at": "2026-05-15T18:29:34Z",
  "created_by": "9b7bfd43-e9f8-4365-b6e1-15bccdad64ee"
}
json
{
  "ok": true,
  "count": 1
}
json
{
  "id": "bbaa8f20-98c7-4c97-ac5e-ece63b4c0b0b",
  "title": "Horário",
  "body": "Atendemos de segunda a sexta, das 9h às 18h.",
  "sort_order": 0,
  "active": true,
  "created_at": "2026-05-15T18:29:34Z",
  "updated_at": "2026-05-15T18:29:34Z",
  "created_by": "9b7bfd43-e9f8-4365-b6e1-15bccdad64ee"
}
http
HTTP/1.1 204 No Content