Skip to main content
PATCH
Create or update the project's customer portal (PATCH, same as PUT)

Path Parameters

project_id
string
required

Body

application/json
name
string

Required when creating.

Required string length: 1 - 80
enabled
boolean

A switched-off portal refuses its tokens and sessions and delivers nothing to its customers' destinations.

event_types
string[]

The project's datasets the portal exposes. Each must be a valid dataset name. An empty list exposes nothing: customers cannot add a destination, and existing ones receive nothing. Changes apply to every delivery from then on, including destinations created earlier.

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.

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

The project's customer portal, or null when none has been set up.

portal
object | null
required