Skip to main content
POST
Clean up, keep everything, or undo

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Body

application/json
decision
enum<string>
required
Available options:
cleanup,
keep,
undo
ifRevision
string

Refuse with 409 ONBOARDING_REVISION_CHANGED unless the state is still at this revision.

Required string length: 1 - 128

Response

200 response

alreadyDone
boolean
required
result
object
required

The outcome of the Clean up commit, Keep everything, or an undo.

undo
object | null
required
state
object
required