Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Employee Emergency Contact

Update employee emergency contact

Updates the authenticated employee's emergency contact.

The employment is derived from the access token's subject — there is no employment id in the path. The token must be an employee-role token (typically obtained via the OAuth2 assertion grant with subject urn:remote-api:employee:employment:<employment_id>).

This endpoint requires country-specific data. The exact required fields vary depending on which country the authenticated employee's employment is in. Query the Show form schema endpoint with emergency_contact_details as the form name to discover the schema for a given country.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage emergency contacts (emergency_contact:write)
put/v1/employee/emergency-contact

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the emergency_contact_details form schema

Request body

emergency_contact_detailsobject required

Emergency contact information. As its properties may vary depending on the country, you must query the Show form schema endpoint passing the country code and emergency_contact_details as path parameters.

Example request

{
  "emergency_contact_details": {
    "name": "Jane Doe",
    "phone_number": "+44 20 1234 5678",
    "relationship": "Spouse"
  }
}

Response

Success

Example response

{
  "data": {
    "employment": {
      "contract_origin": "remote_contract",
      "id": "20a72f86-employment-id-9e4942a902ff",
      "personal_details": {},
      "status": "created",
      "type": "employee",
      "updated_at": "2024-01-15T10:30:00Z",
      "user_status": "active"
    }
  }
}