Synq Docs
Management APIBrands

Add a custom domain to a brand

A subdomain the org owns, such as `login.acme.com`, where the brand's issuer will also answer, on a plan with `branding.custom_domain` (Pro and up). Add the one CNAME record the answer names; Synq checks it, issues a certificate, and the domain goes live on its own, usually within minutes. The brand's own issuer keeps working: the domain is a second issuer, with the same users, apps and keys. One per brand. Needs `org.brands.edit`. Recorded as `brand.custom_domain_added`.

POST/v1/orgs/{org}/brands/{brand}/custom-domain

A subdomain the org owns, such as login.acme.com, where the brand's issuer will also answer, on a plan with branding.custom_domain (Pro and up). Add the one CNAME record the answer names; Synq checks it, issues a certificate, and the domain goes live on its own, usually within minutes. The brand's own issuer keeps working: the domain is a second issuer, with the same users, apps and keys. One per brand. Needs org.brands.edit. Recorded as brand.custom_domain_added.

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

application/problem+json

curl -X POST "https://example.com/v1/orgs/string/brands/string/custom-domain" \  -H "Content-Type: application/json" \  -d '{    "hostname": "string"  }'
{  "id": "string",  "hostname": "string",  "status": "string",  "issuer": "string",  "dns_records": [    {      "type": "string",      "name": "string",      "relative_name": "string",      "value": "string",      "status": "string",      "found": "string"    }  ],  "ssl": {    "status": "string",    "expires_at": "2019-08-24T14:15:22Z"  },  "problems": [    {      "code": "string",      "detail": "string"    }  ],  "verified_at": "2019-08-24T14:15:22Z",  "activated_at": "2019-08-24T14:15:22Z",  "grace_ends_at": "2019-08-24T14:15:22Z",  "checked_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Check a brand's custom domain now POST

Looks at its DNS and certificate now rather than at the next scheduled check, and carries it on as far as it can go. Once a minute for a domain. Needs `org.brands.edit` and a plan with `branding.custom_domain`.

Send a brand's reply-to confirmation again POST

A new link to confirm the reply-to address that waits for one; the old link stops working. At most 5 a day for a brand. Needs `org.brands.edit`.