Criar e enviar comunicado

Permite criar um comunicado e enviá-lo aos contatos dos clientes de um escritório.

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

Para anexar arquivos ao comunicado, antes é preciso fazer o upload de cada arquivo e enviar os ids retornados em fileIds. O comunicado precisa ser criado em até 10 minutos depois da criação de cada arquivo; depois disso, a rota responde 404 para o arquivo.

Destinatários

O comunicado é enviado por e-mail e notificação a todos os contatos com e-mail de cada cliente informado em customerIds, que recebe o id retornado em Listar clientes. Clientes arquivados, sem contato com e-mail ou fora da permissão do usuário são ignorados. Se nenhum cliente restar, a rota responde 400.

Tamanho da requisição

O corpo da requisição pode ter até 4 MB. Acima disso, a rota responde 413.


Dicionário para propriedades retornadas

Response body

  • id - Id do comunicado criado.
  • subject - Assunto do comunicado.
  • totalContacts - Quantidade de contatos que vão receber o comunicado.
Path Params
string
required

Id do escritório.

Body Params
string
Defaults to Obrigatório.

Assunto do comunicado, com até 200 caracteres.

string
Defaults to Obrigatório.

Mensagem do comunicado.

boolean
Defaults to false

Indica se o contato deve confirmar a leitura do comunicado.

customerIds
array of strings

Ids dos clientes que vão receber o comunicado. Obrigatório, com ao menos um cliente.

customerIds
fileIds
array of strings

Ids dos arquivos anexados ao comunicado, gerados na rota de upload de arquivo.

fileIds
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