> ## Documentation Index
> Fetch the complete documentation index at: https://trygradient.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Settings
> Update organization settings and brand assets
# Settings
Manage your organization's display settings and brand assets.
## Update Settings
```
PATCH /api/settings
```
This endpoint requires a session cookie - API key authentication is not currently supported for settings updates.
Your display name
Organization name
Your job role
Turn email-domain auto-join on or off for the organization. Owners/admins only.
Allowed email domains for auto-join (e.g. `["acme.com"]`). Generic providers (gmail.com, outlook.com, etc.) are rejected.
Email the org when a candidate submits an assessment.
Free-text description of the company, used to ground AI generation. Trimmed; an empty string clears it.
Org-wide toggle for capturing candidate session replays.
```json theme={null}
{
"ok": true
}
```
## Upload Logo or Wordmark
```
POST /api/settings/logo
```
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.
Image file (PNG, JPG, SVG, or WebP). Max 2 MB.
Either `logo` (square icon) or `wordmark` (horizontal lockup).
```json theme={null}
{
"url": "https://your-project.supabase.co/storage/v1/object/public/org-assets/org-id/wordmark.png?v=1713000000000"
}
```
## Remove Logo or Wordmark
```
DELETE /api/settings/logo
```
Remove a previously uploaded logo or wordmark.
Requires session cookie with owner or admin role.
Either `logo` or `wordmark`.
```json theme={null}
{
"ok": true
}
```
## Preview Branded Invite Email
```
POST /api/settings/branding/preview
```
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.
Company name shown in the copy/subject. Falls back to the saved org name.
Public wordmark URL to render on a white header. Omit/null for the Gradient header.
`#rrggbb` accent applied to the stripe and button. Ignored when not a valid hex.
Custom first sentence. Blank uses the default org/role sentence.
```json theme={null}
{
"subject": "Assessment invitation from Acme",
"html": " … "
}
```
## Upload Profile Photo
```
POST /api/settings/avatar
```
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.
Image file (PNG, JPG, or WebP). Max 5 MB.
```json theme={null}
{
"url": "https://your-project.supabase.co/storage/v1/object/public/user-avatars/user-id/avatar.png?v=1713000000000"
}
```
## Remove Profile Photo
```
DELETE /api/settings/avatar
```
Remove the signed-in user's profile photo, reverting to initials.
Requires an admin-portal session cookie. Candidate sessions are rejected.
```json theme={null}
{
"ok": true
}
```