Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Employment Management

Invite employment

Invite an employment to start the self-enrollment.

Requirements for the invitation to succeed:

  • Employment needs to have the following JSON Schema forms filled: contract_details and pricing_plan_details
  • provisional_start_date must consider the minimum onboarding time of the employment's country

If there are validations errors, they are returned with a Conflict HTTP Status (409) and a descriptive message. HTTP Status OK (200) is returned in case of success.

In case of the following error message: "Please reselect benefits - the previous selection is no longer available" it means that the benefit options have been updated and the employment's benefits are no longer compliant with the new schema.

In this case, reselect benefits by updating contract_details JSON Schema form.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage employments (employment:write)
post/v1/employments/{employment_id}/invite

Path parameters

employment_idstring required

Employment ID

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}