Skip to main content
PATCH
/
v1
/
worker-dependents
/
{id}
Update a worker dependent
curl --request PATCH \
  --url https://api.plane.com/v1/worker-dependents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {},
  "dob": "<string>",
  "relationship": "<string>",
  "status": "<string>"
}
'
import requests

url = "https://api.plane.com/v1/worker-dependents/{id}"

payload = {
    "name": {},
    "dob": "<string>",
    "relationship": "<string>",
    "status": "<string>"
}
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: {}, dob: '<string>', relationship: '<string>', status: '<string>'})
};

fetch('https://api.plane.com/v1/worker-dependents/{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/worker-dependents/{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' => [
        
    ],
    'dob' => '<string>',
    'relationship' => '<string>',
    'status' => '<string>'
  ]),
  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/worker-dependents/{id}"

	payload := strings.NewReader("{\n  \"name\": {},\n  \"dob\": \"<string>\",\n  \"relationship\": \"<string>\",\n  \"status\": \"<string>\"\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/worker-dependents/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {},\n  \"dob\": \"<string>\",\n  \"relationship\": \"<string>\",\n  \"status\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.plane.com/v1/worker-dependents/{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\": {},\n  \"dob\": \"<string>\",\n  \"relationship\": \"<string>\",\n  \"status\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
Update a dependent’s details, or set status to inactive to remove them from future coverage (e.g. a child who has aged out).

Parameters

id
string
required
ID of the worker dependent.
name
object
The dependent’s name.
dob
string
Date of birth.
relationship
string
Relationship to the worker.
status
string
Dependent status. One of active or inactive.

Returns

Returns the updated Worker dependent object.