Parceiros

Gerencie convenios, seguros e planos de saude vinculados aos atendimentos. Parceiros sao associados opcionalmente no momento do agendamento.

Feature Flag

Requer appointments_module habilitado na conta.

Tipos de Parceiros

kind	Descricao
convenio	Convenio medico / odontologico
seguro	Seguro de saude
plano	Plano de saude
outros	Outros tipos de parceiros

GET/api/v1/accounts/{account_id}/partners

Lista todos os parceiros ativos. Qualquer membro da conta pode visualizar.

Parametros de Query

Nome	Tipo	Obrigatorio	Descricao
`active`(query)	`boolean`	Nao	Filtrar por status ativo (default true)
`kind`(query)	`string`	Nao	Filtrar por tipo: convenio \| seguro \| plano \| outros

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/partners?kind=convenio" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de parceiros

json

{
  "data": [
    {
      "id": 2,
      "name": "Unimed SP",
      "kind": "convenio",
      "settings": {},
      "active": true,
      "created_at": "2026-05-01T10:00:00Z"
    }
  ]
}

POST/api/v1/accounts/{account_id}/partners

Cria novo parceiro. Apenas administradores.

Body (partner)

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome do parceiro
`kind`	`string`	Nao	convenio \| seguro \| plano \| outros (padrao convenio)
`settings`	`object`	Nao	Configuracoes flexiveis (codigos de autorizacao, coberturas etc.)
`active`	`boolean`	Nao	Status ativo (padrao true)

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/partners" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "partner": {
      "name": "Bradesco Saude",
      "kind": "plano",
      "settings": { "code_prefix": "BDS-" }
    }
  }'

201Parceiro criado

json

{ "data": { "id": 5, "name": "Bradesco Saude", "kind": "plano", "active": true } }

GET/api/v1/accounts/{account_id}/partners/{id}

Retorna detalhes de um parceiro especifico.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/partners/2" \
  -H "api_access_token: YOUR_TOKEN" | jq .

PATCH/api/v1/accounts/{account_id}/partners/{id}

Atualiza dados do parceiro. Apenas administradores.

bash

curl -X PATCH "https://chat.seudominio.com/api/v1/accounts/1/partners/2" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "partner": { "settings": { "authorization_required": true } } }'

DELETE/api/v1/accounts/{account_id}/partners/{id}

Remove o parceiro (soft-delete). Atendimentos historicos que referenciam este parceiro sao preservados. Apenas administradores.

bash

curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/partners/2" \
  -H "api_access_token: YOUR_TOKEN"