Skip to main content

​
Settings

Manage your organization’s display settings and brand assets.

​
Update Settings

This endpoint requires a session cookie - API key authentication is not currently supported for settings updates.
​
userName
string
Your display name
​
orgName
string
Organization name
​
jobRole
string
Your job role
​
autoJoinEnabled
boolean
Turn email-domain auto-join on or off for the organization. Owners/admins only.
​
autoJoinDomains
string[]
Allowed email domains for auto-join (e.g. ["acme.com"]). Generic providers (gmail.com, outlook.com, etc.) are rejected.
​
notifyOnSubmit
boolean
Email the org when a candidate submits an assessment.
​
companyDescription
string
Free-text description of the company, used to ground AI generation. Trimmed; an empty string clears it.
​
captureReplaysEnabled
boolean
Org-wide toggle for capturing candidate session replays.

​
Upload Logo or Wordmark

Upload a square logo or horizontal wordmark for your organization. The image is stored in Supabase storage and the URL is saved to the organization record.
Requires session cookie with owner or admin role.
​
file
file
required
Image file (PNG, JPG, SVG, or WebP). Max 2 MB.
​
kind
string
required
Either logo (square icon) or wordmark (horizontal lockup).

​
Remove Logo or Wordmark

Remove a previously uploaded logo or wordmark.
Requires session cookie with owner or admin role.
​
kind
string
required
Either logo or wordmark.

​
Preview Branded Invite Email

Requires admin role (owner or admin).
Renders the real candidate invite email (the same builder that sends it) with the supplied branding values — which may be unsaved edits from the Branding settings form — so the settings page can show a truthful live preview. The Gradient logo (shown only when no wordmark is set) is inlined as a data URI so it renders in-browser.
​
orgName
string
Company name shown in the copy/subject. Falls back to the saved org name.
​
wordmarkUrl
string
Public wordmark URL to render on a white header. Omit/null for the Gradient header.
​
accentColor
string
#rrggbb accent applied to the stripe and button. Ignored when not a valid hex.
​
inviteIntro
string
Custom first sentence. Blank uses the default org/role sentence.

​
Upload Profile Photo

Upload a profile photo for the signed-in user. The image is stored in Supabase storage and the URL is saved to the user record, replacing the initials avatar shown in the top bar.
Requires an admin-portal session cookie. Candidate sessions are rejected.
​
file
file
required
Image file (PNG, JPG, or WebP). Max 5 MB.

​
Remove Profile Photo

Remove the signed-in user’s profile photo, reverting to initials.
Requires an admin-portal session cookie. Candidate sessions are rejected.