For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentaçãoReferência da API
DocumentaçãoReferência da API
  • Integrações privadas
        • GETListar consultas
        • GETListar preços por profissional
        • GETListar itens de consulta
        • GETListar materiais de consulta
        • POSTCriar consulta
        • PUTAtualizar consulta
        • POSTRemarcar consulta
        • POSTConfirmar presença da consulta
        • POSTCancelar confirmação de presença
        • POSTCancelar consulta
        • POSTEncerrar consulta com no-show
        • POSTFinalizar consulta
  • Entrada pública de leads
LogoLogo
Integrações privadasConsultórioConsultas

Finalizar consulta

||View as Markdown|
POST
/simplificav2/consulta/:id/finalizar
POST
/ords/gestao/simplificav2/consulta/:id/finalizar
$curl -X POST https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/consulta/1/finalizar \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "status": "sucesso",
3 "mensagem": "Consulta finalizada com sucesso.",
4 "data": {
5 "id": 145
6 }
7}
Finaliza uma consulta já existente. Regras: - a rota usa as mesmas validações operacionais de finalização já aplicadas no sistema; - esta operação aceita `{}` ou corpo vazio; - o comportamento de finalização segue a regra atual do domínio e não abre oportunidade automaticamente. Exemplo de uso: ```http POST {{base_url}}/simplificav2/consulta/145/finalizar Authorization: Bearer {{bearer_token}} Content-Type: application/json {} ```
Was this page helpful?
Previous

Encerrar consulta com no-show

Next

Listar categorias financeiras

Built with

Finaliza uma consulta já existente.

Regras:

  • a rota usa as mesmas validações operacionais de finalização já aplicadas no sistema;
  • esta operação aceita {} ou corpo vazio;
  • o comportamento de finalização segue a regra atual do domínio e não abre oportunidade automaticamente.

Exemplo de uso:

1POST {{base_url}}/simplificav2/consulta/145/finalizar
2Authorization: Bearer {{bearer_token}}
3Content-Type: application/json
4
5{}

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.

Path parameters

idintegerRequired
Identificador da consulta.

Request

This endpoint expects an object.

Response

Consulta finalizada com sucesso.
statusstring
mensagemstring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error