Skip to main content
POST
/
v1
/
worker-contacts
Create a worker contact
curl --request POST \
  --url https://api.plane.com/v1/worker-contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "worker": "<string>",
  "purpose": "<string>",
  "name": {},
  "relationship": "<string>",
  "phones": [
    {}
  ],
  "emails": [
    {}
  ],
  "address": {},
  "priority": 123,
  "status": "<string>"
}
'
{
  "worker": "wrkr_8oWZpQ2rL4sk",
  "purpose": "emergency",
  "name": { "full": "Amara Okafor", "display": "Amara Okafor" },
  "relationship": "spouse",
  "phones": [{ "type": "mobile", "value": "+14155550123", "primary": true }],
  "emails": [{ "type": "personal", "value": "amara@example.com", "primary": true }],
  "priority": 1
}

​
Parameters

​
worker
string
required
ID of the worker this contact belongs to.
​
purpose
string
required
Contact purpose. Currently emergency.
​
name
object
required
The contact’s name. Same shape as a worker’s name (e.g. first, last, full, display).
​
relationship
string
required
Free-text relationship to the worker.
​
phones
array
Phone numbers for this contact. Each entry requires type and value, and may include extension and primary. Phone types are mobile, home, work, or other.
​
emails
array
Email addresses for this contact. Each entry requires type and value, and may include primary. Email types are personal, work, or other.
​
address
object
Optional mailing address for this contact.
​
priority
integer
Contact priority within the purpose. Required for emergency contacts.
​
status
string
Contact status. One of active or inactive. Defaults to active.

​
Returns

Returns the created Worker contact object. 
{
  "worker": "wrkr_8oWZpQ2rL4sk",
  "purpose": "emergency",
  "name": { "full": "Amara Okafor", "display": "Amara Okafor" },
  "relationship": "spouse",
  "phones": [{ "type": "mobile", "value": "+14155550123", "primary": true }],
  "emails": [{ "type": "personal", "value": "amara@example.com", "primary": true }],
  "priority": 1
}