Create Offboarding

post

https://gateway.remote.com/v1/offboardings

Creates an Offboarding request

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employments (`employments`)	-	Manage offboarding (`offboarding:write`)
Company-scoped access token (assertion)	Manage employments (`employments`)	-	Manage offboarding (`offboarding:write`)
Customer API token	Manage employments (`employments`)	-	Manage offboarding (`offboarding:write`)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Callback

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json