Skip to main content
POST
Schedule workspace deletion

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Body

application/json
reason
string
required

Why the workspace is being deleted. Required — a blank one returns a 422.

Example:

"moving_to_another_tool"

feedback
string

Optional free text.

Example:

"Consolidating on one vendor."

Response

Success

marked_for_deletion_at
string | null

When the workspace was scheduled. Deletion happens after a grace period, and this is the clock you are racing.

message
string

Confirmation.