Pular para o conteúdo principal
Referência da API

Remetentes

Remetentes avulsos verificados por email, sem domínio próprio.

Listar remetentes

GEThttps://api.coffeemail.com.br/v1/product/senders200

Resposta 200

sendersarray<object>obrigatório
Lista de remetentes da organização

Cadastrar remetente

POSThttps://api.coffeemail.com.br/v1/product/senders201

Corpo da requisição

emailstring (email)obrigatório
Endereço de e-mail do remetente a ser verificado
displayNamestring≤ 200
Nome de exibição do remetente

Resposta 201

idstring (uuid)obrigatório
Identificador único do remetente
emailstringobrigatório
Endereço de e-mail do remetente
displayNamestringobrigatório
Nome de exibição do remetente
verifiedAtstring (date-time)obrigatório
Data/hora em que o remetente foi verificado
activebooleanobrigatório
Se o remetente está ativo para envio
createdAtstring (date-time)obrigatório
Data/hora de criação do remetente

Confirmar remetente

POSThttps://api.coffeemail.com.br/v1/product/senders/verify200

Corpo da requisição

tokenstring (uuid)obrigatório
Token de verificação recebido por e-mail

Resposta 200

idstring (uuid)obrigatório
Identificador único do remetente
emailstringobrigatório
Endereço de e-mail do remetente

Reenviar verificação

POSThttps://api.coffeemail.com.br/v1/product/senders/{id}/resend-verification204

Parâmetros do caminho

idstringobrigatório

Remover remetente

DELETEhttps://api.coffeemail.com.br/v1/product/senders/{id}200

Parâmetros do caminho

idstringobrigatório