Synq Docs
Management APIEmail domains

Add a sending domain

A domain the org's brands' email can come from, on a plan with `branding.custom_email_domain` (Pro and up). Synq registers it with its email provider at once and answers the DNS records to publish; when it can't yet, the domain is `pending_setup` and its records appear once it can. A name is held by one org at a time. At most 10 a day, and 10 in all. Needs `org.emailDomains.edit`. Recorded as `email_domain.created`.

POST/v1/orgs/{org}/email-domains

A domain the org's brands' email can come from, on a plan with branding.custom_email_domain (Pro and up). Synq registers it with its email provider at once and answers the DNS records to publish; when it can't yet, the domain is pending_setup and its records appear once it can. A name is held by one org at a time. At most 10 a day, and 10 in all. Needs org.emailDomains.edit. Recorded as email_domain.created.

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

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 POST "https://example.com/v1/orgs/string/email-domains" \  -H "Content-Type: application/json" \  -d '{    "domain": "string"  }'
{  "id": "string",  "domain": "string",  "status": "string",  "records": [    {      "purpose": "string",      "type": "string",      "host": "string",      "value": "string",      "required": true,      "status": "string",      "seen": "string"    }  ],  "problem": "string",  "used_by": [    "string"  ],  "verified_at": "2019-08-24T14:15:22Z",  "last_checked_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}

Check a sending domain now POST

Looks at the domain again now rather than at its next scheduled check: registers it if it is still `pending_setup`, else looks its records up and, when they are all there and Postmark agrees, verifies it. Once a minute for a domain. Needs `org.emailDomains.edit` and a plan with `branding.custom_email_domain`.

Get a file GET

Its state, and where it is read once ready. Needs `org.brands.view`.