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

Atualizar consulta

||View as Markdown|
PUT
/simplificav2/consulta/:id
PUT
/ords/gestao/simplificav2/consulta/:id
$curl -X PUT https://gestao.simplificagestao.com.br/ords/gestao/simplificav2/consulta/1 \
> -H "Authorization: Bearer <token>" \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "status": "sucesso",
3 "mensagem": "Consulta atualizada com sucesso.",
4 "data": {
5 "id": 145
6 }
7}
Atualiza parcialmente uma consulta pendente. Regras: - esta rota só atualiza os atributos enviados; - campos omitidos continuam com o valor atual; - a rota só atua sobre consultas pendentes e ativas; - você pode atualizar `consultor_id`, `motivo_consulta_id`, `hora_inicial`, `hora_final`, `descricao` e `procedimentos`; - para alterar data, profissional ou fluxo de agenda, use a rota de remarcação; - `procedimentos`, quando enviado, substitui a lista atual de procedimentos da consulta; - `procedimentos` deve conter ao menos um id válido; - se houver alteração de horário, a rota valida conflitos da agenda e bloqueios com a configuração atual da consulta. Exemplo de uso: ```http PUT {{base_url}}/simplificav2/consulta/145 Authorization: Bearer {{bearer_token}} Content-Type: application/json { "consultor_id": 52, "motivo_consulta_id": 8, "hora_inicial": "14:30", "hora_final": "15:30", "descricao": "Observação atualizada da consulta.", "procedimentos": [981, 990] } ```
Was this page helpful?
Previous

Criar consulta

Next

Remarcar consulta

Built with

Atualiza parcialmente uma consulta pendente.

Regras:

  • esta rota só atualiza os atributos enviados;
  • campos omitidos continuam com o valor atual;
  • a rota só atua sobre consultas pendentes e ativas;
  • você pode atualizar consultor_id, motivo_consulta_id, hora_inicial, hora_final, descricao e procedimentos;
  • para alterar data, profissional ou fluxo de agenda, use a rota de remarcação;
  • procedimentos, quando enviado, substitui a lista atual de procedimentos da consulta;
  • procedimentos deve conter ao menos um id válido;
  • se houver alteração de horário, a rota valida conflitos da agenda e bloqueios com a configuração atual da consulta.

Exemplo de uso:

1PUT {{base_url}}/simplificav2/consulta/145
2Authorization: Bearer {{bearer_token}}
3Content-Type: application/json
4
5{
6 "consultor_id": 52,
7 "motivo_consulta_id": 8,
8 "hora_inicial": "14:30",
9 "hora_final": "15:30",
10 "descricao": "Observação atualizada da consulta.",
11 "procedimentos": [981, 990]
12}

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.
consultor_idinteger or nullOptional

Novo consultor responsável pela consulta.

motivo_consulta_idinteger or nullOptional
Novo motivo da consulta.
hora_inicialstring or nullOptional

Nova hora inicial no formato HH24:MI.

hora_finalstring or nullOptional

Nova hora final no formato HH24:MI.

descricaostring or nullOptional

Nova observação da consulta.

procedimentoslist of integers or nullOptional
Nova lista de ids dos procedimentos. Quando enviada, substitui a lista atual da consulta.

Response

Consulta atualizada com sucesso.
statusstring
mensagemstring
dataobject

Errors

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

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.