Update a benefit program
curl --request PATCH \
--url https://api.plane.com/v1/benefit/programs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"year": 123,
"starts": {},
"ends": {},
"status": "<string>",
"eligibility": {},
"metadata": {}
}
'import requests
url = "https://api.plane.com/v1/benefit/programs/{id}"
payload = {
"name": "<string>",
"year": 123,
"starts": {},
"ends": {},
"status": "<string>",
"eligibility": {},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
year: 123,
starts: {},
ends: {},
status: '<string>',
eligibility: {},
metadata: {}
})
};
fetch('https://api.plane.com/v1/benefit/programs/{id}', 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/programs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'year' => 123,
'starts' => [
],
'ends' => [
],
'status' => '<string>',
'eligibility' => [
],
'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/programs/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"year\": 123,\n \"starts\": {},\n \"ends\": {},\n \"status\": \"<string>\",\n \"eligibility\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.plane.com/v1/benefit/programs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"year\": 123,\n \"starts\": {},\n \"ends\": {},\n \"status\": \"<string>\",\n \"eligibility\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/benefit/programs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"year\": 123,\n \"starts\": {},\n \"ends\": {},\n \"status\": \"<string>\",\n \"eligibility\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyPrograms
Update a benefit program
Update a benefit program.
PATCH
/
v1
/
benefit
/
programs
/
{id}
Update a benefit program
curl --request PATCH \
--url https://api.plane.com/v1/benefit/programs/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"year": 123,
"starts": {},
"ends": {},
"status": "<string>",
"eligibility": {},
"metadata": {}
}
'import requests
url = "https://api.plane.com/v1/benefit/programs/{id}"
payload = {
"name": "<string>",
"year": 123,
"starts": {},
"ends": {},
"status": "<string>",
"eligibility": {},
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
year: 123,
starts: {},
ends: {},
status: '<string>',
eligibility: {},
metadata: {}
})
};
fetch('https://api.plane.com/v1/benefit/programs/{id}', 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/programs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'year' => 123,
'starts' => [
],
'ends' => [
],
'status' => '<string>',
'eligibility' => [
],
'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/programs/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"year\": 123,\n \"starts\": {},\n \"ends\": {},\n \"status\": \"<string>\",\n \"eligibility\": {},\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.plane.com/v1/benefit/programs/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"year\": 123,\n \"starts\": {},\n \"ends\": {},\n \"status\": \"<string>\",\n \"eligibility\": {},\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/benefit/programs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"year\": 123,\n \"starts\": {},\n \"ends\": {},\n \"status\": \"<string>\",\n \"eligibility\": {},\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_bodyParameters
ID of the benefit program.
Human-readable program name.
Human renewal label for the program.
Start date for the program year.
End date for the program year.
Program status. One of
draft, open, or closed.CEL expression deciding which workers the program is offered to, evaluated
against the worker shape.
Set of key-value pairs attached to the program.
Returns
Returns the updated Benefit program object.Was this page helpful?
⌘I