curl --request POST \
--url https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/benefit/{benefit-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "voluntary-dismissal",
"extension-plan": false
}
}
'
{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}{
"error": "End date cannot be in the past"
}{
"error": "Not entitled to modify this member"
}{
"error": "Benefit not found active in member"
}{
"enrollment-id": "789e0123-e89b-12d3-a456-426614174002",
"error": "Exclusion not performed. Benefit still has ongoing enrollment"
}Exclusão de um benefício específico
Exclui um único benefício do membro.
POST
/
v1
/
enrollment
/
exclusion
/
{member-tax-id}
/
benefit
/
{benefit-id}
curl --request POST \
--url https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/benefit/{benefit-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "voluntary-dismissal",
"extension-plan": false
}
}
'
{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}{
"error": "End date cannot be in the past"
}{
"error": "Not entitled to modify this member"
}{
"error": "Benefit not found active in member"
}{
"enrollment-id": "789e0123-e89b-12d3-a456-426614174002",
"error": "Exclusion not performed. Benefit still has ongoing enrollment"
}Authorizations
Token Bearer obtido em POST /v1/authenticate.
Path Parameters
CPF do membro. CPF (Cadastro de Pessoas Físicas). Aceita apenas dígitos ou formatado.
Examples:
"12345678900"
"123.456.789-00"
ID do benefício a ser excluído.
Query Parameters
Resolve automaticamente a movimentação: approve aprova; reject rejeita.
Esta opção existe apenas no ambiente de Homologação, para testes.
Available options:
approve, reject Body
application/json
Show child attributes
Show child attributes
Response
Movimentação processada com sucesso.
Identificador da requisição. Use em GET /v1/request/{request-id}.