onboarding

Stop the running onboarding run

Stop setup and hand the workspace back.

Deliberately not a 409 when the run has already finished: the button exists because a run looked stuck, and telling someone their stop failed because the thing stopped on its own is a worse answer than the run itself.

post/api/v1/onboarding/cancel

Request

  • Base URL: https://api.cadencz.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cadencz.com/api/v1/onboarding/cancel
  • Auth: HTTP bearer

Response

Successful Response

idstring required
source_kindstring
urlstring nullable
company_namestring nullable
statusstring required
current_stepstring nullable
errorstring nullable
brain_idstring nullable
content_plan_idstring nullable
created_atstring date-time required
finished_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.