Pular para o conteúdo principal
Começar

Erros

Os status que a API devolve de verdade e o envelope de erro.

Envelope

Todo erro volta num objeto error com code, message e meta. O code é estável; a message é para pessoas e pode mudar; meta traz o campo ou o limite envolvido.

400 VALIDATION_FAILED
{  "error": {    "code": "VALIDATION_FAILED",    "message": "O campo to precisa de pelo menos 1 destinatário",    "meta": { "field": "to" }  }}

Códigos

HTTPcodeQuando acontece
400VALIDATION_FAILEDAlgum campo do corpo ou da consulta é inválido; meta diz qual.
400INVALID_RECIPIENTO destinatário não é um endereço válido.
401UNAUTHORIZEDChave ausente, inválida ou revogada.
409DOMAIN_NOT_VERIFIEDO domínio do remetente ainda não passou na verificação de DNS.
409EMAIL_NOT_CANCELLABLESó emails agendados e ainda não enviados podem ser cancelados.
422INVALID_FROM_DOMAINO from usa um domínio que não pertence à organização.
422SENDER_NOT_VERIFIEDO remetente avulso ainda não confirmou o email.
429PLAN_QUOTA_EXCEEDEDA cota do plano acabou no ciclo; libere excedente ou mude de plano.
429RATE_LIMIT_EXCEEDEDMuitas requisições; espere o tempo de retry-after.
500TEMPLATE_RENDER_ERRORO modelo não renderizou com as variáveis enviadas.
Guarde o x-request-id da resposta: com ele o suporte acha a requisição na hora.

Nos SDKs

Os SDKs não lançam exceção por erro da API: o erro vem tipado no resultado, com code, status e requestId.

Node.js
const { data, error } = await coffeemail.emails.send(payload); if (error instanceof ValidationError) return showFieldErrors(error.details);if (error instanceof RateLimitError) return retryLater(error);if (error) throw error; console.log(data.id, data.status);
Go
_, err := client.Domains.Get(ctx, id)if errors.Is(err, coffeemail.ErrNotFound) {	return nil} var apiErr *coffeemail.Errorif errors.As(err, &apiErr) {	log.Printf("status=%d code=%s requestId=%s", apiErr.Status, apiErr.Code, apiErr.RequestID)}