Integrações privadasConsultórioCadastros

Criar motivo de consulta

View as Markdown
Cria um novo motivo de consulta para a empresa autenticada. Regras: - o cadastro nasce ativo; - `ic_encerra_negociacao` aceita `S` ou `N`; - esse campo indica se, nas telas do sistema, a finalização da reunião direciona o usuário para o fluxo de abertura de negociação; - `duracao_padrao` é informada em minutos; - esta rota não aceita `ativo`.

Authentication

AuthorizationBearer
Token privado usado para consultar dados da plataforma. Como usar: - obtenha o token privado da sua empresa; - envie `Authorization: Bearer SEU_TOKEN_PRIVADO`; - não use `x-api-key` neste módulo.

Request

This endpoint expects an object.
nomestringRequired
Nome do motivo de consulta.
descricaostring or nullOptional

Descrição opcional do motivo.

ic_encerra_negociacaostring or nullOptional

Use S quando esse motivo, nas telas do sistema, indica que o encerramento da consulta pode seguir para o fluxo de abertura de negociação. Use N nos demais casos. Quando omitido, o padrão é N.

duracao_padraodouble or nullOptional

Duração padrão em minutos. Quando omitida, o padrão operacional é 30.

Response

Motivo de consulta criado com sucesso.
statusstring
mensagemstring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error