Skip to main content
DELETE
Disable a customer portal

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required
portal_id
string
required

Response

SOFT delete — enabled set to 0. The row and its tokens remain, but every portal token for it stops authenticating immediately.

ok
enum<boolean>
required
Available options:
true