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.

Path parameters

employer_idstringRequiredformat: "er_.+"

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

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

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

contactobject or nullOptional
earliest_benefits_start_datestring or nullOptionalformat: "date"

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.

Response

OK
idstringformat: "er_.+"
legal_namestring
legal_addressobject
contactobject
platform_idstring or nullformat: "pt_.+"
statusenum or null
Allowed values:
registration_numberstring or null
offboard_onstring or nullformat: "date-time"
earliest_benefits_start_datestring or nullformat: "date"
objectstring or null
The object type

Errors