Employments
Emergency Contact

Update emergency contact

Changed on

Updates the employment's emergency contact details.

This endpoint requires country-specific data. Query the Show form schema endpoint passing the country code and emergency_contact_details as path parameters to see the required fields for a given country.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage employments (employment:write)
put/v2/employments/{employment_id}/emergency-contact

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v2/employments/{employment_id}/emergency-contact
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, employment:write, employments, all:write)

Path parameters

employment_idstring required

Employment ID

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"
    }
  }
}

Changes

  • 9410f5f18a91Revision changes
    • warning

      added the new invited enum value to the // response property for the response status

  • be4636f25834Revision changes
    • info

      removed the offboarding enum value from the // response property for the response status