Skip to content
OnCoreDocs
WhatsApp

DELETEhttps://core-api.heysadie.ai/whatsapp/onboarding-sessions/{id}

id success data status metadata timestamp version path error code message details field

Cancel onboarding session

Cancel / reset an onboarding session (reseller self-service recovery). Behaviour by current status: - `pending` / `authorized` / `verifying` — **cancellable**: the number's WhatsApp link is cleared and the session becomes `abandoned` (a subsequent `GET` reports `failureReason: "cancelled"`). The number can immediately be re-onboarded. - `failed` / `abandoned` / `name_rejected` — already terminal: **idempotent no-op**, returns the current status (`200`). - `tier_pending` / `completed` / `live` — a verified/registered or live number is **not** cancelled here → `409 WHATSAPP_ONBOARDING_NOT_CANCELLABLE`. Cross-tenant / unknown ids return `404` (anti-enumeration). DB-only: no Meta call is made (the number may remain attached at Meta; a re-onboard idempotently re-attaches it) and **no webhook fires** (you initiated the cancel).

Try it in the API Explorer

Example request

Terminal
curl -X DELETE "https://core-api.heysadie.ai/whatsapp/onboarding-sessions/ONBOARDING_SESSION_ID" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

The resource's UUID.

Responses

200
successbooleanrequired
dataobjectoptional
Show 1 child properties
statusstringrequired

Resulting status. A cancellable in-flight session (`pending`/`authorized`/`verifying`) becomes `abandoned`; an already-terminal session echoes its current status (idempotent).

metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
400
successbooleanrequired
errorobjectoptional
Show 3 child properties
codeenumrequired
Allowed values:"VALIDATION_ERROR"
messagestringrequired
detailsobject[]optional
Show 2 item properties
fieldstringrequired
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
401
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"UNAUTHORIZED"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
403
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"FORBIDDEN"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
404
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
500
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional