Update a worker contact
curl --request PATCH \
--url https://api.plane.com/v1/worker-contacts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"purpose": "<string>",
"name": {},
"relationship": "<string>",
"phones": [
{}
],
"emails": [
{}
],
"address": {},
"priority": 123,
"status": "<string>"
}
'import requests
url = "https://api.plane.com/v1/worker-contacts/{id}"
payload = {
"purpose": "<string>",
"name": {},
"relationship": "<string>",
"phones": [{}],
"emails": [{}],
"address": {},
"priority": 123,
"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({
purpose: '<string>',
name: {},
relationship: '<string>',
phones: [{}],
emails: [{}],
address: {},
priority: 123,
status: '<string>'
})
};
fetch('https://api.plane.com/v1/worker-contacts/{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-contacts/{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([
'purpose' => '<string>',
'name' => [
],
'relationship' => '<string>',
'phones' => [
[
]
],
'emails' => [
[
]
],
'address' => [
],
'priority' => 123,
'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-contacts/{id}"
payload := strings.NewReader("{\n \"purpose\": \"<string>\",\n \"name\": {},\n \"relationship\": \"<string>\",\n \"phones\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"address\": {},\n \"priority\": 123,\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-contacts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"purpose\": \"<string>\",\n \"name\": {},\n \"relationship\": \"<string>\",\n \"phones\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"address\": {},\n \"priority\": 123,\n \"status\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/worker-contacts/{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 \"purpose\": \"<string>\",\n \"name\": {},\n \"relationship\": \"<string>\",\n \"phones\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"address\": {},\n \"priority\": 123,\n \"status\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyContacts
Update a worker contact
Update a worker contact.
PATCH
/
v1
/
worker-contacts
/
{id}
Update a worker contact
curl --request PATCH \
--url https://api.plane.com/v1/worker-contacts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"purpose": "<string>",
"name": {},
"relationship": "<string>",
"phones": [
{}
],
"emails": [
{}
],
"address": {},
"priority": 123,
"status": "<string>"
}
'import requests
url = "https://api.plane.com/v1/worker-contacts/{id}"
payload = {
"purpose": "<string>",
"name": {},
"relationship": "<string>",
"phones": [{}],
"emails": [{}],
"address": {},
"priority": 123,
"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({
purpose: '<string>',
name: {},
relationship: '<string>',
phones: [{}],
emails: [{}],
address: {},
priority: 123,
status: '<string>'
})
};
fetch('https://api.plane.com/v1/worker-contacts/{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-contacts/{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([
'purpose' => '<string>',
'name' => [
],
'relationship' => '<string>',
'phones' => [
[
]
],
'emails' => [
[
]
],
'address' => [
],
'priority' => 123,
'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-contacts/{id}"
payload := strings.NewReader("{\n \"purpose\": \"<string>\",\n \"name\": {},\n \"relationship\": \"<string>\",\n \"phones\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"address\": {},\n \"priority\": 123,\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-contacts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"purpose\": \"<string>\",\n \"name\": {},\n \"relationship\": \"<string>\",\n \"phones\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"address\": {},\n \"priority\": 123,\n \"status\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.com/v1/worker-contacts/{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 \"purpose\": \"<string>\",\n \"name\": {},\n \"relationship\": \"<string>\",\n \"phones\": [\n {}\n ],\n \"emails\": [\n {}\n ],\n \"address\": {},\n \"priority\": 123,\n \"status\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyParameters
ID of the worker contact to update.
Contact purpose. Currently
emergency.The contact’s name. Same shape as a worker’s name.
Free-text relationship to the worker.
Phone numbers for this contact. Phone types are
mobile, home, work, or
other.Email addresses for this contact. Email types are
personal, work, or
other.Optional mailing address for this contact.
Contact priority within the purpose.
Contact status. One of
active or inactive.Returns
Returns the updated Worker contact object.Was this page helpful?
⌘I