Synq Docs
Management APIBrands

Try a brand's sign-in

A link that opens the brand's hosted sign-in page as Synq's own preview app, so you sign in as one of its users before writing any code. The page the sign-in comes back to, on the brand's issuer, says who signed in and links back to `return_path` on Synq's dashboard. The link works once, within 10 minutes; preview sign-ins count for no monthly active user. Needs `org.brands.view`.

POST/v1/orgs/{org}/brands/{brand}/sign-in-preview

A link that opens the brand's hosted sign-in page as Synq's own preview app, so you sign in as one of its users before writing any code. The page the sign-in comes back to, on the brand's issuer, says who signed in and links back to return_path on Synq's dashboard. The link works once, within 10 minutes; preview sign-ins count for no monthly active user. Needs org.brands.view.

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 POST "https://example.com/v1/orgs/string/brands/string/sign-in-preview" \  -H "Content-Type: application/json" \  -d '{}'
{  "url": "string",  "expires_at": "2019-08-24T14:15:22Z"}

Send a test of a brand's email POST

A sample of the brand's email, from exactly who its next one is from and with its reply-to, to the calling person's own verified address: never another. A person only, since an API key has no address. At most 5 an hour. Needs `org.brands.edit`.

Preview a brand's theme POST

The brand's sign-in page with these settings on top of its theme, saving nothing: what the dashboard's editor shows. It renders whatever the plan allows or not, and `needs` names what saving it would need. Render `html` only in a sandboxed iframe (`srcdoc`, with neither `allow-scripts` nor `allow-same-origin`) under the returned `content_security_policy`, never inline. Needs `org.brands.view`.