Synq Docs
Management APIBrands

Change a brand's theme

Changes the settings sent and keeps the rest; null unsets one. Settings only: raw CSS, or anything else, is refused. Advanced settings need a plan with the advanced theme, and hiding "Powered by Synq" a plan that allows it; unsetting either needs neither. Needs `org.brands.edit`. Recorded as `brand.updated`, each setting as `theme.<name>`.

PATCH/v1/orgs/{org}/brands/{brand}/theme

Changes the settings sent and keeps the rest; null unsets one. Settings only: raw CSS, or anything else, is refused. Advanced settings need a plan with the advanced theme, and hiding "Powered by Synq" a plan that allows it; unsetting either needs neither. Needs org.brands.edit. Recorded as brand.updated, each setting as theme.<name>.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string
brand*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/orgs/string/brands/string/theme" \  -H "Content-Type: application/json" \  -d '{}'
{  "layout": "centered",  "method_order": [    "string"  ],  "font": "string",  "surface_color": "string",  "glow_color": "string",  "button_style": "pill",  "card_radius": 0,  "card_shadow": "none",  "heading": "string",  "background_image_url": "string",  "background_blur": 0,  "powered_by": true,  "not_shown": [    "string"  ]}

Change how a brand's email goes out PATCH

Who its email is from: one of the org's sending domains, on a plan with `branding.custom_email_domain` (it is used once the domain is verified, and `<brand> via Synq` meanwhile and whenever the plan or the domain stops allowing it), the part before the @ and the name, on every plan. Sets where replies to the brand's email go, on every plan, and keeps what isn't sent. A new reply-to address waits until someone who reads it opens the link Synq emails it (`status: pending_confirmation`); the caller's own verified address, and one on a sending domain the org verified, are confirmed at once. Needs `org.brands.edit`. Recorded as `brand.updated`, and the confirmation as `brand.reply_to_confirmed`.

Change a brand PATCH

Its name, branding, links, sign-up switch and built-in ways to sign in; never its issuer slug. Needs `org.brands.edit`. Recorded as `brand.updated`; send null to clear a setting.