curl --request POST \
--url https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "dismissal",
"extension-plan": false
}
}
'import requests
url = "https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}"
payload = { "exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "dismissal",
"extension-plan": False
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
'exclusion-details': {
'end-date': '2024-12-31',
'exclusion-reason': 'dismissal',
'extension-plan': false
}
})
};
fetch('https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'exclusion-details' => [
'end-date' => '2024-12-31',
'exclusion-reason' => 'dismissal',
'extension-plan' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}"
payload := strings.NewReader("{\n \"exclusion-details\": {\n \"end-date\": \"2024-12-31\",\n \"exclusion-reason\": \"dismissal\",\n \"extension-plan\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"exclusion-details\": {\n \"end-date\": \"2024-12-31\",\n \"exclusion-reason\": \"dismissal\",\n \"extension-plan\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"exclusion-details\": {\n \"end-date\": \"2024-12-31\",\n \"exclusion-reason\": \"dismissal\",\n \"extension-plan\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}Exclusão de benefício por produto
Exclui o benefício ativo do membro vinculado ao produto informado. Funciona como a exclusão
por benefit-id, mas localiza o benefício pelo produto (product-id) em vez do identificador
do benefício. Se o membro tiver mais de um benefício ativo do mesmo produto dentro do escopo
de empresas autorizado do chamador, a exclusão é recusada com 409 (ambiguidade) em vez de
excluir um dos benefícios arbitrariamente.
curl --request POST \
--url https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "dismissal",
"extension-plan": false
}
}
'import requests
url = "https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}"
payload = { "exclusion-details": {
"end-date": "2024-12-31",
"exclusion-reason": "dismissal",
"extension-plan": False
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
'exclusion-details': {
'end-date': '2024-12-31',
'exclusion-reason': 'dismissal',
'extension-plan': false
}
})
};
fetch('https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'exclusion-details' => [
'end-date' => '2024-12-31',
'exclusion-reason' => 'dismissal',
'extension-plan' => false
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}"
payload := strings.NewReader("{\n \"exclusion-details\": {\n \"end-date\": \"2024-12-31\",\n \"exclusion-reason\": \"dismissal\",\n \"extension-plan\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"exclusion-details\": {\n \"end-date\": \"2024-12-31\",\n \"exclusion-reason\": \"dismissal\",\n \"extension-plan\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pipo.health/v1/enrollment/exclusion/{member-tax-id}/product/{product-id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"exclusion-details\": {\n \"end-date\": \"2024-12-31\",\n \"exclusion-reason\": \"dismissal\",\n \"extension-plan\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"request-id": "aaa11111-e89b-12d3-a456-426614174006"
}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.
"12345678900"
"123.456.789-00"
ID do produto 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.
approve, reject Body
Show child attributes
Show child attributes
Response
Movimentação processada com sucesso.
Identificador da requisição. Use em GET /v1/request/{request-id}.