Synq Docs
Management APIBrands

Change how a brand's email goes out

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`.

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

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.

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

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/orgs/string/brands/string/email" \  -H "Content-Type: application/json" \  -d '{}'
{  "sender": {    "email_domain_id": "string",    "local_part": "string",    "name": "string"  },  "reply_to": {    "address": "string",    "status": "string"  },  "effective": {    "from": {      "name": "string",      "address": "string"    },    "reply_to": "string",    "kind": "string",    "fallback_reason": "string"  }}

List an org's brands GET

Oldest first. Needs `org.brands.view`.

Change a brand's theme PATCH

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>`.