Skip to navigation
API ReferenceEmployers

Update an employer

Updates the specified employer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the legal_address parameter only the legal_address value will be changed.

Note that the legal_address and contact fields are treated as single objects that are updated entirely. If you provide either of these fields, the entire object will be replaced with the new data, not just the individual sub-fields you include in the request.For instance, if you provide a partial legal_address object, it will overwrite the entire existing legal_address, potentially removing any sub-fields you didn’t include in the request.

This request accepts mostly the same arguments as the employer creation call.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

employer_idstringRequiredformat: "er_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Request

This endpoint expects an object.
legal_namestring or nullOptional
registration_numberstring or nullOptional
legal_addressobjectOptional

Treated as a single object that is updated entirely, null sub-fields (e.g. Line 3) will delete the existing values

contactobjectOptional
earliest_benefits_start_datedate or nullOptional

The earliest date this employer is permitted to set up any benefits scheme. If this date is in the future, benefit setup will be blocked until then. Used to delay scheme setup access (e.g., for onboarding alignment).

Constraints:

  • Can only be set or updated if no group policy or group quote exists.
  • Must be a valid date.
applicable_collective_agreementstring or nullOptional
Name of the collective agreement that applies to the employer's workforce, if any.
metadatamap from strings to strings or nullOptional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters. Treated as a single object that is updated entirely.

Response

OK
idstringformat: "er_.+"
legal_namestring
legal_addressobject
contactobject
platform_idstringOptionalformat: "pt_.+"
statusenumOptional
Allowed values:
registration_numberstring or nullOptional
offboard_ondatetime or nullOptional
earliest_benefits_start_datedate or nullOptional
applicable_collective_agreementstring or nullOptional
Name of the collective agreement that applies to the employer's workforce, if any.
metadatamap from strings to strings or nullOptional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters.

objectstringOptionalRead-only
The object type

Errors

400
Bad Request Error
404
Not Found Error