Skip to main content
PATCH
/
v1
/
benefit
/
events
/
{id}
Update a benefit event
curl --request PATCH \
  --url https://api.plane.com/v1/benefit/events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "starts": "<string>",
  "ends": "<string>",
  "metadata": {}
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

Move the enrollment window or update metadata. An open-enrollment window is commonly extended this way. The event’s identity — its type, point date, and who it’s for — is fixed at creation; to change those, create a new event.

​
Parameters

​
id
string
required
ID of the benefit event.
​
starts
string
First day the enrollment window is open.
​
ends
string
Last day the enrollment window is open.
​
metadata
object
Set of key-value pairs attached to the event.

​
Returns

Returns the updated Benefit event object.