Employments
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

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

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

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/cancel-onboarding/{employment_id}
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, onboarding:write, employments, all:write)

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 operation across all 65 revisions of this API.