Erros & Envelopes de resposta - Escrybe API

A maior parte da API compartilha um único envelope de resposta; alguns grupos de endpoints encapsulam as respostas de forma diferente. Todos usam códigos HTTP padrão — verifique-os primeiro.

Códigos de status

Status	Significado
`200`	Sucesso
`400`	Requisição inválida ou incompleta
`401`	Credenciais ausentes ou inválidas
`403`	Autenticado, mas proibido
`404`	Recurso não encontrado
`405`	Método HTTP não permitido
`429`	Muitas tentativas de autenticação falhas (rate limit)
`500`	Erro interno
`503`	Em manutenção

Envelopes

Padrão (cartas, e-mail, mensagens WhatsApp)
Modelos de WhatsApp / logo
Favoritos / verificação de número

{ "status": 200, "status_message": "Sucesso", "data": { } }

Usado pelos endpoints de Cartas/Telegrama (v2), E-mail Registrado, Recibos (erros) e pelos endpoints de mensagens e remetentes de WhatsApp. O campo status espelha o código HTTP.

{ "code": 200, "status": "success", "message": null, "data": { }, "request_id": "req_..." }

Usado pelos endpoints de modelos de WhatsApp e pela sincronização de modelos. O endpoint de logo do remetente usa o mesmo formato sem request_id.

{ "success": true, "favorites": [ ] }

Contatos salvos e a verificação de número de WhatsApp retornam um objeto simples { "success": ... }.

O campo status / code do envelope sempre espelha o código HTTP real — erros nunca são retornados dentro de um HTTP 200.