Listar um comunicado específico

Permite obter um comunicado 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 andamento do envio para cada cliente retornado em customers pode ser consultado em Listar o status de envio de um comunicado para um cliente.


Dicionário para propriedades retornadas

Response body

  • id - Id do comunicado.
  • subject - Assunto do comunicado.
  • message - Mensagem do comunicado.
  • isReadConfirmationRequired - Indica se o contato deve confirmar a leitura do comunicado.
  • createdAt - Data de criação do comunicado.
  • createdBy - Nome do usuário que criou o comunicado.
  • totalCustomers - Quantidade de clientes que receberam o comunicado.
  • totalSentEmails - Quantidade de contatos com o e-mail enviado, aberto ou clicado.
  • totalOpenedCustomers - Quantidade de clientes com ao menos um contato que abriu o e-mail.
  • totalVisualizedCustomers - Quantidade de clientes com ao menos um contato que visualizou o comunicado.
  • files - Arquivos anexados ao comunicado, com id e nome.
  • customers - Clientes que receberam o comunicado, com id e nome.
Path Params
string
required

Id do escritório.

string
required

Id do comunicado.

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