Skip to main content
POST
Create User Offboarding

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
user_id
string
required

The UUID of the identity to offboard.

scheduled_at
string<date-time> | null

When to run the offboarding, as an ISO 8601 datetime. Omit to trigger the offboarding immediately; provide a future datetime to schedule it.

Response

Successful Response

id
string
required

The unique UUID of the user offboarding.

user_id
string
required

The UUID of the offboarded identity.

status
enum<string>
required

The status of the offboarding.

Available options:
SCHEDULED,
IN_PROGRESS,
DIVERTED,
CANCELLED,
FAILED,
EXPIRED,
COMPLETED
scheduled_at
string<date-time> | null
required

When the offboarding is scheduled to run, if scheduled.

created_at
string<date-time> | null
required

When the offboarding was created.

cancelled_at
string<date-time> | null
required

When the offboarding was cancelled, if it was cancelled.

completed_at
string<date-time> | null
required

When the offboarding completed, if it has completed.