Saltar al contenido

Update an emergency contact

Módulo Identity

PATCH/emergency-contacts/{id}emergencyContacts.update

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. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad me.work_details.write.
  • Alcances de OAuth: me.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

emergencyContacts.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the emergency contact.

Cuerpo de la solicitud: EmergencyContactUpdate

emergencyContacts.update: EmergencyContactUpdate
CampoTipoObligatorioDescripción
full_namestringNoContact's name.Restricciones: length 1 to 200
relationshipstring | nullNoHow the contact relates to the person.Restricciones: length 1 to 60
phone_e164stringNoContact's phone. E.164 format.Restricciones: pattern ^\+[1-9][0-9]{6,14}$
alternate_phone_e164string | nullNoA second phone. E.164 format.Restricciones: pattern ^\+[1-9][0-9]{6,14}$
emailstring (email) | nullNoContact's email address.
sort_orderintegerNoOrder to call in, lowest first.Restricciones: 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
}

Respuesta 200: EmergencyContact

emergencyContacts.update: EmergencyContact
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the emergency contact.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
person_idstring (uuid)SíIdentifier of the person the contact belongs to; always the caller.
full_namestringSíContact's name.Restricciones: length 1 to 200
relationshipstring | nullSíHow the contact relates to the person.Restricciones: length 1 to 60
phone_e164stringSíContact's phone. E.164 format.Restricciones: pattern ^\+[1-9][0-9]{6,14}$
alternate_phone_e164string | nullSíA second phone. E.164 format.Restricciones: pattern ^\+[1-9][0-9]{6,14}$
emailstring (email) | nullSíContact's email address.
sort_orderintegerSíOrder to call in, lowest first.Restricciones: 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
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/emergency-contacts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -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, etag } = await xos.emergencyContacts.update("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
  }, { ifMatch: etag });
response = xos.emergency_contacts.update("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}, if_match=etag)
xos emergency-contacts update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"full_name":"Marco Marchetti","relationship":"Brother","phone_e164":"+13055550142","alternate_phone_e164":"+13055550142","email":"alex.rivera@northwindlive.example","sort_order":0}' --if-match auto