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": {}
}
'import requests
url = "https://api.plane.com/v1/benefit/enrollments"
payload = {
"worker": "<string>",
"event": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({worker: '<string>', event: '<string>', metadata: {}})
};
fetch('https://api.plane.com/v1/benefit/enrollments', 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/benefit/enrollments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'worker' => '<string>',
'event' => '<string>',
'metadata' => [
]
]),
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/benefit/enrollments"
payload := strings.NewReader("{\n \"worker\": \"<string>\",\n \"event\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.plane.com/v1/benefit/enrollments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"worker\": \"<string>\",\n \"event\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/benefit/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"worker\": \"<string>\",\n \"event\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"worker": "wrkr_8oWZpQ2rL4sk",
"event": "benev_K2mP9qR4xL7s"
}
{
"id": "bene_X8pR5sT1vA4o",
"object": "benefit.enrollment",
"worker": "wrkr_8oWZpQ2rL4sk",
"event": "benev_K2mP9qR4xL7s",
"status": "not_started",
"metadata": {},
"created": "2026-05-29T12:00:00Z",
"updated": "2026-05-29T12:00:00Z"
}
Enrollments
Create a benefit enrollment
Start a worker’s run through an enrollment event.
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": {}
}
'import requests
url = "https://api.plane.com/v1/benefit/enrollments"
payload = {
"worker": "<string>",
"event": "<string>",
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({worker: '<string>', event: '<string>', metadata: {}})
};
fetch('https://api.plane.com/v1/benefit/enrollments', 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/benefit/enrollments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'worker' => '<string>',
'event' => '<string>',
'metadata' => [
]
]),
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/benefit/enrollments"
payload := strings.NewReader("{\n \"worker\": \"<string>\",\n \"event\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.plane.com/v1/benefit/enrollments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"worker\": \"<string>\",\n \"event\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/benefit/enrollments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"worker\": \"<string>\",\n \"event\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"worker": "wrkr_8oWZpQ2rL4sk",
"event": "benev_K2mP9qR4xL7s"
}
{
"id": "bene_X8pR5sT1vA4o",
"object": "benefit.enrollment",
"worker": "wrkr_8oWZpQ2rL4sk",
"event": "benev_K2mP9qR4xL7s",
"status": "not_started",
"metadata": {},
"created": "2026-05-29T12:00:00Z",
"updated": "2026-05-29T12:00:00Z"
}
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
ID of the worker whose run this is.
Set of key-value pairs attached to the enrollment.
Returns
Returns the created Benefit enrollment object.{
"worker": "wrkr_8oWZpQ2rL4sk",
"event": "benev_K2mP9qR4xL7s"
}
{
"id": "bene_X8pR5sT1vA4o",
"object": "benefit.enrollment",
"worker": "wrkr_8oWZpQ2rL4sk",
"event": "benev_K2mP9qR4xL7s",
"status": "not_started",
"metadata": {},
"created": "2026-05-29T12:00:00Z",
"updated": "2026-05-29T12:00:00Z"
}
Was this page helpful?
⌘I