Skip to main content
POST
/
v1
/
benefit
/
enrollments
Create a benefit enrollment
curl --request POST \
  --url https://api.plane.com/v1/benefit/enrollments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "worker": "<string>",
  "event": "<string>",
  "metadata": {}
}
'
{
  "worker": "wrkr_8oWZpQ2rL4sk",
  "event": "benev_K2mP9qR4xL7s"
}

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.

Open a worker’s run against an event. The enrollment starts in not_started. There is one enrollment per worker per event — creating a second for the same pair returns an error.

​
Parameters

​
worker
string
required
ID of the worker whose run this is.
​
event
string
required
ID of the event the run is under.
​
metadata
object
Set of key-value pairs attached to the enrollment.

​
Returns

Returns the created Benefit enrollment object. 
{
  "worker": "wrkr_8oWZpQ2rL4sk",
  "event": "benev_K2mP9qR4xL7s"
}