Skip to main content

PATCH Vincular Sessão a uma Consulta

Vincula uma sessão do assistente a uma consulta.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão manage_assistant.


Endpoint​

PATCH https://api-dev.imagemais.com.br/api/assistant/session/{id}/link

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID do registro

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
consultationIdnumber✅inteiro; positivoID da consulta

Requisição​

curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/assistant/session/1/link' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"consultationId": 1
}'

Respostas​

200 Sucesso​

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"consultationId must be a positive number",
"consultationId must be an integer number"
],
"error": "Bad Request",
"statusCode": 400
}

Também retornado com a mensagem:

{
"message": "Validation failed (numeric string is expected)",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

{
"message": "Sessão não encontrada",
"error": "Not Found",
"statusCode": 404
}