Skip to content

Update Org Settings

PATCH
/appointments/org-settings

Change the booking page’s branding. Admin keys only.

Only what you send is written. This is what a PROSPECT sees, so a wrong value here is visible outside the organisation rather than inside it.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Branding for the public booking page.

CLOSED, mirroring the app: these land in a JSONB configuration column and the app forbids extra keys so nothing can be smuggled into it. logo_url is an HttpUrl because the app’s is - typed str here it would pass this layer and then fail inside the proxy as a 500.

object
booking_page_theme
Any of:
string
Allowed values: light dark auto
brand_color
Any of:
string
/^#[0-9a-fA-F]{6}$/
hide_branding
Any of:
boolean
logo_url
Any of:
string format: uri
>= 1 characters <= 2083 characters

Responses

200

Successful Response

object
data
required

An open envelope for a filter, a setting, an embed config or a slot grid.

Open because org settings gain branding fields as the booking page does and the embed config gains styling keys as the widget does. Closing it would drop a field the app had already started returning.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string