curl --request POST \
--url https://api.pipo.health/v1/enrollment/alteration/{member-tax-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company-tax-id": "12345678000190",
"alteration-data": {
"new-company-tax-id": "44555666000199",
"requested-start-date": "2026-12-01",
"reason": "Transferência do colaborador para outra filial"
}
}
'{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}Alteração de membro
Solicita uma alteração para um membro titular já existente — troca de plano, troca da
empresa vinculada aos benefícios (CNPJ) e/ou correção de dados cadastrais, em uma única
requisição. A alteração vale para os benefícios titulares ativos do membro na empresa
de company-tax-id, e gera uma movimentação por benefício.
alteration-data é um mapa de campos livres: deve conter apenas chaves
conhecidas e pelo menos uma das seguintes indicações de mudança:
new-product-ids— lista dos produtos novos (troca de plano); ou o deprecatednew-product-id, com um único produto.new-company-tax-id— troca do CNPJ vinculado aos benefícios.- um ou mais campos cadastrais (
name,email,address-*,bank-*, etc.).
Casamento por tipo de benefício. Cada produto de new-product-ids substitui o
benefício do membro do mesmo tipo (health-insurance, dental-insurance,
life-insurance…). Benefício cujo tipo não aparece na lista segue com o mesmo
produto. Um produto igual ao que o benefício já tem também conta como “sem troca”.
Consulte o tipo de cada produto em product-type de GET /v1/products.
Com new-company-tax-id, todos os benefícios titulares ativos do membro na empresa vão
para o novo CNPJ. Benefício com produto do seu tipo na lista troca de plano para esse
produto. Benefício sem par continua o mesmo benefício, com o mesmo produto: só passa a ficar
vinculado ao novo CNPJ. Um new-company-tax-id igual ao company-tax-id não é troca de
CNPJ: a requisição segue as regras sem new-company-tax-id.
Na troca de CNPJ, a empresa de destino precisa oferecer o produto que cada benefício
terá lá: o da lista, para quem tem par, e o atual, para quem não tem. Se o novo CNPJ tiver
outro contrato (outros produtos), mande em new-product-ids o produto equivalente de cada
tipo de benefício. Senão, a requisição é recusada com 400 e nenhuma movimentação é gerada.
Sem new-company-tax-id, só os benefícios com par na lista trocam de plano. Os campos
cadastrais valem para todos os benefícios. Benefício sem par e sem campo cadastral não
gera movimentação; se nenhum benefício tiver o que mudar, a requisição é recusada (400).
Os campos comuns (requested-start-date, reason, documents e os campos cadastrais)
acompanham todas as movimentações.
Validações:
- produto da lista que a empresa não oferece — o novo CNPJ, ou a empresa atual quando
não há troca de CNPJ (
400); - na troca de CNPJ, produto atual de um benefício sem par que o novo CNPJ não oferece
(
400, mesma resposta do item anterior); - dois produtos do mesmo tipo em
new-product-ids(400); - produto de um tipo de que o membro não tem benefício titular ativo — isso seria uma
inclusão; use
POST /v1/enrollment/inclusion/{member-tax-id}(400); - membro com mais de um benefício titular ativo do tipo de um produto da lista, sem como
saber qual trocar (
409); - na troca de CNPJ, dois ou mais benefícios titulares ativos com o mesmo produto atual:
eles não podem ser transferidos na mesma requisição (
409); new-company-tax-idde empresa que você não tem permissão para movimentar (403).
new-product-id (um único produto) está deprecated: continua aceito e é tratado como
uma lista de um item. Enviar new-product-id e new-product-ids juntos dá 400.
Atenção: não repita chaves no mesmo objeto JSON. Com dois
new-product-idno mesmoalteration-data, o parser fica só com o último valor e o primeiro é descartado sem erro. Para trocar mais de um produto, mande todos emnew-product-ids.
curl --request POST \
--url https://api.pipo.health/v1/enrollment/alteration/{member-tax-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company-tax-id": "12345678000190",
"alteration-data": {
"new-company-tax-id": "44555666000199",
"requested-start-date": "2026-12-01",
"reason": "Transferência do colaborador para outra filial"
}
}
'{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}https://api.pipo.health). Ainda não deve ser utilizado em produção.company-tax-id e gera uma movimentação por benefício.
Troca de produtos: casamento por tipo de benefício
Envie os produtos novos emalteration-data.new-product-ids. Cada produto substitui o benefício
do membro do mesmo tipo (health-insurance, dental-insurance, life-insurance…). O tipo
de cada produto está em product-type, na listagem de produtos.
- Benefício cujo tipo não aparece na lista segue com o mesmo produto.
- Produto igual ao que o benefício já tem conta como “sem troca”.
- No máximo um produto por tipo.
- Só tipos de que o membro já tem benefício titular ativo. Para incluir um benefício de outro tipo, use a inclusão de benefício.
- O produto precisa ser oferecido pela empresa de destino: a de
new-company-tax-id, ou a decompany-tax-idquando não há troca de CNPJ. Na troca de CNPJ, o produto atual dos benefícios sem par também (veja abaixo).
Com e sem troca de CNPJ
| Benefício com produto do seu tipo na lista | Benefício sem par na lista | |
|---|---|---|
Com new-company-tax-id | Vai para o novo CNPJ e troca de plano para o produto da lista | Vai para o novo CNPJ e continua o mesmo benefício, com o mesmo produto |
Sem new-company-tax-id | Troca de plano para o produto da lista | Só muda se houver campo cadastral a corrigir |
new-company-tax-id igual ao company-tax-id não é troca de CNPJ: vale a linha “sem
new-company-tax-id”.
Os campos comuns (requested-start-date, reason, documents e os campos cadastrais)
acompanham todas as movimentações. Sem troca de CNPJ, se nenhum benefício tiver o que mudar, a
requisição é recusada com 400.
Troca de CNPJ: o novo CNPJ precisa oferecer o produto de cada benefício
Na troca de CNPJ, a empresa de destino precisa oferecer o produto que cada benefício terá lá: o da lista, para quem tem par, e o atual, para quem não tem. Se o novo CNPJ tiver outro contrato, com outros produtos, mande emnew-product-ids o produto equivalente de cada tipo de
benefício (consulte os produtos de cada empresa na listagem de produtos).
Se algum produto não for oferecido, a requisição é recusada com 400, product-ids lista os
produtos que faltam no novo CNPJ, e nenhuma movimentação é gerada.
Exemplo: membro com saúde, odonto e vida, transferido de CNPJ trocando saúde e odonto.
{
"company-tax-id": "12345678000190",
"alteration-data": {
"new-company-tax-id": "44555666000199",
"new-product-ids": [
"7c3a91e2-5b4d-4f6a-9e8c-2d1b0a3f4e5d",
"9b2f6c1e-3d4a-4e8b-a7c5-1f0d2e3b4a5c"
],
"requested-start-date": "2026-12-01"
}
}
400 com esse produto em product-ids; nesse caso, inclua
o produto de vida do novo CNPJ em new-product-ids.
new-product-id (deprecated)
new-product-id, com um único produto, continua aceito e é tratado como new-product-ids com um
item. Enviar new-product-id e new-product-ids juntos dá 400.
new-product-id no mesmo alteration-data,
o parser fica só com o último valor e o primeiro é descartado sem erro: a alteração sai com
um único produto. Para trocar mais de um produto, mande todos em new-product-ids.Erros de validação
| Status | Quando |
|---|---|
400 | new-product-id e new-product-ids juntos |
400 | Troca de CNPJ: o novo CNPJ não oferece um produto da lista ou o produto atual de um benefício sem par (product-ids traz os produtos) |
400 | Sem troca de CNPJ: a empresa não oferece um produto da lista (product-ids traz os produtos) |
400 | Dois produtos do mesmo tipo em new-product-ids |
400 | Produto de um tipo de que o membro não tem benefício titular ativo (seria uma inclusão) |
400 | Nenhum benefício com o que mudar |
403 | Sem permissão na empresa de company-tax-id ou na de new-company-tax-id |
409 | Membro com mais de um benefício titular ativo do tipo de um produto da lista |
409 | Troca de CNPJ com dois ou mais benefícios titulares ativos no mesmo produto atual (não podem ser transferidos na mesma requisição) |
Path Parameters
Body
Mapa de campos livres com a(s) mudança(s) solicitada(s). Deve conter apenas as chaves
abaixo, e ao menos uma de new-product-ids (ou o deprecated new-product-id, aceito
sozinho como lista de um item), new-company-tax-id ou um campo cadastral.
new-product-ids e new-product-id não podem ser enviados juntos.
Show child attributes
Show child attributes