Synq Docs
Management APIBrands

Remove a brand's custom domain

It stops answering at once, and Synq takes it out of Cloudflare: every app that signs in with its issuer stops working, while the brand's own issuer goes on. Once it has served, the hostname is kept from other brands for 30 days. Needs `org.brands.edit`, on any plan. Recorded as `brand.custom_domain_removed`.

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

It stops answering at once, and Synq takes it out of Cloudflare: every app that signs in with its issuer stops working, while the brand's own issuer goes on. Once it has served, the hostname is kept from other brands for 30 days. Needs org.brands.edit, on any plan. Recorded as brand.custom_domain_removed.

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

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X DELETE "https://example.com/v1/orgs/string/brands/string/custom-domain"
{  "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"}

Make an app POST

A web, SPA, native or machine app of the brand. A web or machine app's secret is in the response, this once; only its hash is kept. Needs `org.apps.edit`, and room under the org's plan (403 `plan_quota_exceeded`, naming the plan that has room in `required_plan`; apps that registered themselves don't count). Recorded as `app.created`.

Remove a brand's logo DELETE

Its logo file is kept a while for email already sent, then deleted. Needs `org.brands.edit`. Recorded as `brand.updated`.