Skip to content

Create an emergency contact

Identity module

POST/emergency-contactsemergencyContacts.create

One of the caller's emergency contacts (Section 4.5.6 item 10), in calling order, at most five (422 emergency_contact_limit). Phones are E.164 (Section 15). Shared with an engagement under the Emergency Contacts category. Creates an emergency contact. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability me.work_details.write.
  • OAuth scopes: me.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: EmergencyContactCreate

emergencyContacts.create: EmergencyContactCreate
FieldTypeRequiredDescription
full_namestringYesContact's name.Constraints: length 1 to 200
relationshipstring | nullNoHow the contact relates to the person.Constraints: length 1 to 60
phone_e164stringYesContact's phone. E.164 format.Constraints: pattern ^\+[1-9][0-9]{6,14}$
alternate_phone_e164string | nullNoA second phone. E.164 format.Constraints: pattern ^\+[1-9][0-9]{6,14}$
emailstring (email) | nullNoContact's email address.
sort_orderintegerNoOrder to call in, lowest first.Constraints: range 0 to any
{
  "full_name": "Marco Marchetti",
  "relationship": "Brother",
  "phone_e164": "+13055550142",
  "alternate_phone_e164": "+13055550142",
  "email": "alex.rivera@northwindlive.example",
  "sort_order": 0
}

Response 201: EmergencyContact

emergencyContacts.create: EmergencyContact
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the emergency contact.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
person_idstring (uuid)YesIdentifier of the person the contact belongs to; always the caller.
full_namestringYesContact's name.Constraints: length 1 to 200
relationshipstring | nullYesHow the contact relates to the person.Constraints: length 1 to 60
phone_e164stringYesContact's phone. E.164 format.Constraints: pattern ^\+[1-9][0-9]{6,14}$
alternate_phone_e164string | nullYesA second phone. E.164 format.Constraints: pattern ^\+[1-9][0-9]{6,14}$
emailstring (email) | nullYesContact's email address.
sort_orderintegerYesOrder to call in, lowest first.Constraints: range 0 to any
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "full_name": "Marco Marchetti",
  "relationship": "Brother",
  "phone_e164": "+13055550142",
  "alternate_phone_e164": "+13055550142",
  "email": "alex.rivera@northwindlive.example",
  "sort_order": 0
}

Code samples

curl -X POST "$XOS_BASE_URL/emergency-contacts" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"full_name":"Marco Marchetti","relationship":"Brother","phone_e164":"+13055550142","alternate_phone_e164":"+13055550142","email":"alex.rivera@northwindlive.example","sort_order":0}'
const { data } = await xos.emergencyContacts.create({
    "full_name": "Marco Marchetti",
    "relationship": "Brother",
    "phone_e164": "+13055550142",
    "alternate_phone_e164": "+13055550142",
    "email": "alex.rivera@northwindlive.example",
    "sort_order": 0
  });
response = xos.emergency_contacts.create({"full_name": "Marco Marchetti", "relationship": "Brother", "phone_e164": "+13055550142", "alternate_phone_e164": "+13055550142", "email": "alex.rivera@northwindlive.example", "sort_order": 0})
xos emergency-contacts create --data '{"full_name":"Marco Marchetti","relationship":"Brother","phone_e164":"+13055550142","alternate_phone_e164":"+13055550142","email":"alex.rivera@northwindlive.example","sort_order":0}'