Synq Docs
Management APIBrands

Send a test of a brand's email

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`.

POST/v1/orgs/{org}/brands/{brand}/email/test

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.

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 POST "https://example.com/v1/orgs/string/brands/string/email/test"
{  "sender": {    "email_domain_id": "string",    "local_part": "string",    "name": "string"  },  "reply_to": {    "address": "string",    "status": "string"  },  "effective": {    "from": {      "name": "string",      "address": "string"    },    "reply_to": "string",    "kind": "string",    "fallback_reason": "string"  }}