Skip to main content
POST
/
v1
/
benefit
/
elections
Create a benefit election
curl --request POST \
  --url https://api.plane.com/v1/benefit/elections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "worker": "<string>",
  "plan": "<string>",
  "enrollment": "<string>",
  "dependents": [
    {}
  ],
  "status": "<string>",
  "starts": "<string>",
  "ends": "<string>",
  "metadata": {}
}
'
{
  "worker": "wrkr_daniel",
  "plan": "benpl_V6nP3qR9tY2m"
}

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.

​
Parameters

​
worker
string
required
ID of the worker to enroll.
​
plan
string
required
ID of the plan the worker elects.
​
enrollment
string
ID of the enrollment run this election belongs to. Omit for a standalone election.
​
dependents
array
IDs of the worker dependents this election covers. They must belong to the electing worker. The coverage tier is derived from this set.
​
status
string
Election status. One of active, waived, or terminated. Defaults to active.
​
starts
string
First day the coverage is in effect.
​
ends
string
Last day the coverage is in effect.
​
metadata
object
Set of key-value pairs attached to the election.

​
Returns

Returns the created Benefit election object. 
{
  "worker": "wrkr_daniel",
  "plan": "benpl_V6nP3qR9tY2m"
}