Cancelar Agenda

1- URL base API

Ambientes	URL
Produção	https://api.mosia.chat/v1

2- Endpoint

Endpoint	Método	Descrição
schedule/cancel	POST	Método cancela uma agenda de acordo com os parâmetros de entrada.

3- Autenticação

Key	Value	Descrição
Authorization	<TOKEN_API_MOSIA>	Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo.

Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:

Acesse a administração do MOSIA, em admin.mosia.chat
No menu principal, acesse "Ajustes Gerais" e habilite o CRM;
Indique uma URL de CALLBACK e salve as mudanças.
Um token será exibido. Este é o token que será utilizado nas integrações destas APIs.

4- Parâmetros envio

Parâmetro

Obrigatório

Tipo

Descrição

idAgendaIntegracao

TRUE

string

ID da agenda (Sistema do cliente)

idChaveUnicaPaciente

TRUE

string

Chave única do paciente

idChaveUnicaProfissional

TRUE

string

ID do médico (Sistema do cliente)

5- Body request

{
  "idAgendaIntegracao": "200",
  "idChaveUnicaPaciente": "paciente@email.com.br",
  "idChaveUnicaProfissional" : "919191"
}

6- Retorno com sucesso (200)

{
    "status": true,
    "data": {},
    "critical": null,
    "timestamp": "2021-01-19T16:43:56.256Z",
    "msg": "Agenda cancelada com sucesso."
}

7- Retorno com erro (200)

{
    "status": false,
    "data": {},
    "critical": [
        {
            "COD": 0,
            "DESC": "A propriedade [idAgenda] é obrigatória.",
            "origem": "",
            "trace": "",
            "SOLU": null,
            "REAL": null,
            "CONT": null
        }
    ],
    "timestamp": "2021-01-19T16:44:42.868Z",
    "msg": "A propriedade [idAgenda] é obrigatória."
}