Skip to main content
POST
Create 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

Body

application/json
name
string
required

Trimmed; must be non-empty.

Minimum string length: 1
slug
string

Slugified server-side (lowercase, [a-z0-9-], max 48, falling back to 'portal'). Defaults to a slug of name. Unique per workspace.

event_types
string[]

Dataset names the portal exposes. Non-string entries are dropped. This also bounds what a portal customer may filter their own destinations to.

branding
object

Stored verbatim as JSON; shape not validated.

Response

Created and enabled.

id
string
required
slug
string
required

The slug actually stored, after slugification.

ok
enum<boolean>
required
Available options:
true