Skip to main content
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>"
}
'
Update a beneficiary’s details, or set status to inactive to remove them from future beneficiary selections.

​
Parameters

​
id
string
required
ID of the worker beneficiary.
​
name
object
The beneficiary’s name.
​
type
string
Beneficiary type. One of individual, trust, estate, or organization.
​
relationship
string
Relationship to the worker.
​
dob
string
Date of birth for an individual beneficiary.
​
status
string
Beneficiary status. One of active or inactive.

​
Returns

Returns the updated Worker beneficiary object.