Synq Docs
Management APIEmail domains

Read a sending domain

Its records, and what Synq last saw at each. Needs `org.emailDomains.view`, on any plan.

GET/v1/orgs/{org}/email-domains/{domain}

Its records, and what Synq last saw at each. Needs org.emailDomains.view, on any plan.

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
domain*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/orgs/string/email-domains/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"}

Delete a sending domain DELETE

Its name is free at once, and Synq removes it from its email provider. Refused while a brand sends from it. On any plan, so an org that moved down can clean up. Needs `org.emailDomains.edit`. Recorded as `email_domain.deleted`.

List an org's sending domains GET

Needs `org.emailDomains.view`, on any plan.