Skip to main content
PATCH
Change a brand portal

Authorizations

Authorization
string
header
required

An API key: ab_...

Path Parameters

id
string
required

Portal id

Body

application/json
name
string

What visitors see it called, e.g. Press kit

Required string length: 1 - 120
slug
string

Its address: /p/{slug}. Lowercase letters, digits and dashes

Pattern: ^[a-z0-9](?:[a-z0-9-]{0,46}[a-z0-9])?$
intro
string | null

A few paragraphs under the name

Maximum string length: 4000
access
enum<string>

public: anyone; password: whoever has it; members: people with access to the workspace. Either of the last two takes access requests

Available options:
public,
password,
members
password
string

For access: password. Left out on a change, it stays

Required string length: 4 - 200
expiresAt
string<date-time> | null

It closes then

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
presets
enum<string>[]

What images download as; web, print and social when left out

Maximum array length: 6
Available options:
web,
social,
story,
print,
png,
original
theme
object
collections
string<uuid>[]

What it shows, in this order

Required array length: 1 - 50 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
domain
string | null

A host name of its own, e.g. press.example.com; served there once its TXT record is in place

Maximum string length: 253

Response

The portal

data
object
required