Sign in
Onboarding

Cancel onboarding

Cancel onboarding.

Requirements for the cancellation to succeed:

  • Employment has to be in invited, created, created_awaiting_reserve, created_reserve_paid, pre_hire status
  • Employee must not have signed the employment contract

Scopes

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

Path parameters

employment_idstring required

Employment ID

Query parameters

asyncboolean

Whether the request should be performed async

Response

Success

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.