Skip to main content
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>"
}
'

​
Parameters

​
id
string
required
ID of the worker contact to update.
​
purpose
string
Contact purpose. Currently emergency.
​
name
object
The contact’s name. Same shape as a worker’s name.
​
relationship
string
Free-text relationship to the worker.
​
phones
array
Phone numbers for this contact. Phone types are mobile, home, work, or other.
​
emails
array
Email addresses for this contact. Email types are personal, work, or other.
​
address
object
Optional mailing address for this contact.
​
priority
integer
Contact priority within the purpose.
​
status
string
Contact status. One of active or inactive.

​
Returns

Returns the updated Worker contact object.