NInibo

Criar e enviar comunicado

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

post/v1/accountingfirms/{accountingFirmId}/announcements

Request

  • Base URL
    https://api.nibo.com.br/accountant/api
  • URL
    https://api.nibo.com.br/accountant/api/v1/accountingfirms/{accountingFirmId}/announcements
  • Auth
    none required

Path parameters

accountingFirmIdstring required

Id do escritório.

Headers

X-API-Keystring

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

X-User-Idstring

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

Request body

subjectstring

Assunto do comunicado, com até 200 caracteres.

messagestring

Mensagem do comunicado.

isReadConfirmationRequiredboolean

Indica se o contato deve confirmar a leitura do comunicado.

customerIdsstring[]

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

fileIdsstring[]

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

Response

201

idstring
subjectstring
totalContactsinteger

Example response

{
  "id": "id",
  "subject": "string"
}

Changes

No recorded changes to this operation across all 1 revision of this API.