Skip to main content
PUT
Update 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

Body

application/json

PATCH is accepted on this path and behaves identically. slug cannot be changed. Note the mixed semantics: name is COALESCE'd (omitted or blank keeps the current name) while event_types and branding are REPLACED — omitting them clears them to [] and {}.

name
string

Trimmed. Omitted or blank leaves the existing name unchanged.

event_types
string[]

Full replacement. Omitted clears it to [].

branding
object

Full replacement. Omitted clears it to {}.

enabled
boolean
default:true

Only the literal false disables; every other value (including omission) re-enables.

Response

Updated.

ok
enum<boolean>
required
Available options:
true