VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Mensagens

POSTResponder uma conversa

Envia uma mensagem do administrador numa conversa.

Acrescenta uma mensagem, como admin, à conversa. A mensagem aparece na hora para os outros participantes que estiverem conectados (tempo real). O texto é limpo de HTML e scripts e fica como texto puro.

POST/api/v1/admin/messages/threads/{id}/replyAdmin

Envia uma mensagem do administrador na conversa

Exige o privilégio manage_settings. O administrador enxerga e responde qualquer conversa da loja.

Parâmetros de caminho

iduuidobrigatório
Identificador da conversa.

Corpo da requisição

bodystring
Texto da mensagem. Obrigatório se não houver anexos.
attachmentsarray

Anexos já enviados à mídia da loja. Obrigatório se não houver body.

urlstring
Endereço do arquivo.
filenamestring
Nome do arquivo.
content_typestring
Tipo MIME.
sizeinteger
Tamanho em bytes.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/messages/threads/02b7a358-6061-4d51-84c0-8044dbb6db6e/reply" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Olá! Seu pedido já saiu para entrega."
}'

Resposta

201Mensagem enviada
json
{
  "id": "ddfeb0e4-5c98-4bc3-ab4f-fad15ca6b364",
  "thread_id": "02b7a358-6061-4d51-84c0-8044dbb6db6e",
  "sender_id": "ec5e10b3-8cb1-43e9-9aa8-964b64eda8de",
  "sender_type": "admin",
  "body": "Olá! Seu pedido já saiu para entrega.",
  "attachments": [],
  "is_read": false,
  "created_at": "2026-10-11T19:25:56.593566Z"
}

Campos da resposta

iduuid
Identificador da mensagem.
thread_iduuid
Conversa.
sender_iduuid
Usuário que enviou.
sender_typestring
customervendoradmin
Quem enviou.
bodystring
Texto, sem HTML.
attachmentsarray
Anexos. Cada um tem url, filename, content_type e size (bytes).
is_readboolean
true quando o outro lado leu.
delivered_atstring
Quando chegou ao outro lado, RFC 3339. Ausente se ainda não.
read_atstring
Quando foi lida, RFC 3339. Ausente se ainda não.
created_atstring
Envio, RFC 3339.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio manage_settings.{"error":"insufficient privileges","required":"manage_settings"}
400O id não é um UUID válido.{"error":"invalid id","detail":"id must be a valid UUID"}
400Corpo inválido, ou nem body nem attachments.{"error":"body or attachments required"}
500Falha ao gravar.{"error":"failed to send message","detail":"..."}
Anexos não sobem por aqui

Esta rota só registra os metadados do anexo. O arquivo precisa ter sido enviado antes, pela API de mídia, e você passa o endereço devolvido.

Veja também

  • Listar e abrir conversas
  • Estado e leitura
Anterior
Listar e abrir conversas
Próxima
Estado, leitura e presença
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também