Create verify domain

POST

/account/sending/verify_domain

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/account/sending/verify_domain \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

Check with Amazon SES whether the domain of the merchant’s own sending address (email_reply_to_address) is verified for sending, and return the DKIM DNS records to add when it is not, as the email settings’ domain check does.

Note: Registers the domain with SES the first time, as the dashboard does, so the DNS records exist. dkim_verified is what SES reports now; DNS changes can take up to 72 hours to show. dns_records lists the CNAME records ({ name, type, value }) to add, empty once DKIM is on: the records for a pending custom_address_status on GET /account/sending, as the Address drawer’s Download records gives them. A pass is saved, so custom_address_status turns verified and mail goes from the address at once.

Authorizations

• ApiKeyAuth

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}