Listar o status de envio de um comunicado para um cliente

Permite obter a situação de envio de um comunicado para os contatos de um cliente específico vinculado a um escritório contábil.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

O customerId é o id retornado em customers na rota Listar um comunicado específico.

A rota responde 404 quando o comunicado não existe ou foi excluído, quando o cliente não existe e quando o comunicado não foi enviado para o cliente.


Dicionário para propriedades retornadas

emailStatus

Essa propriedade representa a situação do e-mail do comunicado enviado ao contato:

  • 1- Na fila
  • 2- Agendado
  • 3- Enviado
  • 4- Aberto
  • 5- Clicado
  • 99- Falha

Response body

  • id - Id do cliente.
  • name - Nome do cliente.
  • documentNumber - CNPJ ou CPF do cliente, sem máscara.
  • contacts - Contatos do cliente que receberam o comunicado.
    • id - Id do contato.
    • name - Nome do contato.
    • email - E-mail do contato.
    • emailStatus - Situação do e-mail enviado ao contato.
    • emailSentDate - Data em que o e-mail foi enviado ao contato.
    • isVisualized - Indica se o contato visualizou o comunicado.
Path Params
string
required

Id do escritório.

string
required

Id do comunicado.

string
required

Id do cliente.

Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json