post https://gateway.remote.com/v1/employments//invite
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
andpricing_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.
Callback