Update a worker beneficiary
curl --request PATCH \
--url https://api.plane.com/v1/worker-beneficiaries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": {},
"type": "<string>",
"relationship": "<string>",
"dob": "<string>",
"status": "<string>"
}
'import requests
url = "https://api.plane.com/v1/worker-beneficiaries/{id}"
payload = {
"name": {},
"type": "<string>",
"relationship": "<string>",
"dob": "<string>",
"status": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: {},
type: '<string>',
relationship: '<string>',
dob: '<string>',
status: '<string>'
})
};
fetch('https://api.plane.com/v1/worker-beneficiaries/{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.plane.com/v1/worker-beneficiaries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => [
],
'type' => '<string>',
'relationship' => '<string>',
'dob' => '<string>',
'status' => '<string>'
]),
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.plane.com/v1/worker-beneficiaries/{id}"
payload := strings.NewReader("{\n \"name\": {},\n \"type\": \"<string>\",\n \"relationship\": \"<string>\",\n \"dob\": \"<string>\",\n \"status\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.plane.com/v1/worker-beneficiaries/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": {},\n \"type\": \"<string>\",\n \"relationship\": \"<string>\",\n \"dob\": \"<string>\",\n \"status\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/worker-beneficiaries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": {},\n \"type\": \"<string>\",\n \"relationship\": \"<string>\",\n \"dob\": \"<string>\",\n \"status\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyBeneficiaries
Update a worker beneficiary
Update a worker beneficiary.
PATCH
/
v1
/
worker-beneficiaries
/
{id}
Update a worker beneficiary
curl --request PATCH \
--url https://api.plane.com/v1/worker-beneficiaries/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": {},
"type": "<string>",
"relationship": "<string>",
"dob": "<string>",
"status": "<string>"
}
'import requests
url = "https://api.plane.com/v1/worker-beneficiaries/{id}"
payload = {
"name": {},
"type": "<string>",
"relationship": "<string>",
"dob": "<string>",
"status": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: {},
type: '<string>',
relationship: '<string>',
dob: '<string>',
status: '<string>'
})
};
fetch('https://api.plane.com/v1/worker-beneficiaries/{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.plane.com/v1/worker-beneficiaries/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => [
],
'type' => '<string>',
'relationship' => '<string>',
'dob' => '<string>',
'status' => '<string>'
]),
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.plane.com/v1/worker-beneficiaries/{id}"
payload := strings.NewReader("{\n \"name\": {},\n \"type\": \"<string>\",\n \"relationship\": \"<string>\",\n \"dob\": \"<string>\",\n \"status\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.plane.com/v1/worker-beneficiaries/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": {},\n \"type\": \"<string>\",\n \"relationship\": \"<string>\",\n \"dob\": \"<string>\",\n \"status\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/worker-beneficiaries/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": {},\n \"type\": \"<string>\",\n \"relationship\": \"<string>\",\n \"dob\": \"<string>\",\n \"status\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyUpdate a beneficiary’s details, or set
status to inactive to remove them
from future beneficiary selections.
Parameters
ID of the worker beneficiary.
The beneficiary’s name.
Beneficiary type. One of
individual, trust, estate, or organization.Relationship to the worker.
Date of birth for an individual beneficiary.
Beneficiary status. One of
active or inactive.Returns
Returns the updated Worker beneficiary object.Was this page helpful?
⌘I