Skip to main content
PATCH
Update a customer portal (PATCH, same as PUT)

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. Only the fields sent change; an omitted field keeps its current value.

name
string

Trimmed. Omitted or blank leaves the existing name unchanged.

event_types
string[]

Replaces the exposed datasets when sent; omitted keeps them. An empty list exposes nothing: the portal's customers receive nothing.

branding
object

What the portal page applies (#198, PORT-12). Only these two keys; anything else is a 400. Omit to keep what is stored; {} clears it.

enabled
boolean

true or false; omitted keeps the current state. A switched-off portal refuses its tokens and delivers nothing to its customers' destinations.

embed_origins
string[]

The sites allowed to frame the portal page (#198, PORT-13): its CSP frame-ancestors. Empty (the default) means no site may. Omit to keep what is stored.

Maximum array length: 10

An exact https origin, e.g. https://app.example.com: no path, no wildcard. A trailing slash is removed.

Response

Updated.

ok
enum<boolean>
required
Available options:
true