Parceiros

Gerencie convênios, seguros e planos de saúde vinculados aos atendimentos. Parceiros são associados opcionalmente no momento do agendamento.

Licença e permissão

Parceiros está incluído em toda licença NooviChat válida; o acesso depende das permissões do usuário e da configuração operacional da conta.

Tipos de Parceiros

Não é uma lista fechada

A conta nomeia os próprios tipos: kind aceita qualquer texto de até 40 caracteres (caracteres de controle são recusados). Os quatro valores abaixo são os canônicos, os únicos que o painel traduz; qualquer outro valor é exibido exatamente como foi escrito. outros continua válido por compatibilidade com cadastros antigos, mas o painel deixou de oferecê-lo como escolha.

kind	Descrição
convenio	Convênio médico / odontológico
seguro	Seguro de saúde
plano	Plano de saúde
outros	Legado: balde genérico anterior aos tipos próprios

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

Lista os parceiros da conta, ordenados por nome. Qualquer membro da conta pode visualizar.

Ativos por padrão

Sem parâmetros, a listagem retorna somente os parceiros ativos e não-descartados. Passe include_inactive=truepara trazer também os desativados — sem esse filtro um parceiro com active: false fica inalcançável pela API de listagem, inclusive para reativá-lo.

Não há filtro por kind via query.

Parâmetros de Query

Nome	Tipo	Obrigatorio	Descricao
`include_inactive`(query)	`boolean`	Nao	Inclui parceiros com active: false. Padrão false.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/partners" \
  -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	Qualquer texto de até 40 caracteres (padrão convenio). convenio, seguro, plano e outros são os canônicos que o painel traduz; os demais aparecem como escritos.
`settings`	`object`	Nao	Configurações flexíveis (códigos de autorização, coberturas etc.)
`active`	`boolean`	Nao	Status ativo (padrão 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 específico.

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 históricos que referenciam este parceiro são preservados. Apenas administradores.

bash

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