StatusDashboard
DashboardsBrandingEmail Sender

Activate email sender verification

Start email sender domain verification after completing DNS setup.

View Markdown

POST /app/dashboards/{id}/branding/email-sender/activate

Starts domain verification after the customer has created the required DKIM CNAME records.

This endpoint is only valid when the dashboard email sender status is pending_dns or unverified. Calling it transitions the status to verifying and enrolls the domain in the scheduled validation worker (checks every 15 minutes). The 72-hour timeout starts at activation.

Requires the Custom Branding feature entitlement and admin role.


Email sender lifecycle

StatusWhen
pending_dnsSender saved; add the DKIM CNAME records shown in the UI. Times out after 72 hours if never activated.
verifyingCustomer confirmed DNS; verification in progress (up to 72 hours from activation).
verifiedDomain verified; custom sender is active for notification emails.
unverifiedVerification was lost (e.g. DKIM records removed). Restore DNS and activate again.
failedVerification timed out after 72 hours or was rejected. Remove the sender and retry.
removingDomain cleanup in progress after a remove request.

Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

This endpoint takes no request body.


Sample request

curl -X POST https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/branding/email-sender/activate \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "message": "Email sender verification started",
  "address": "support@acme.com",
  "domain": "acme.com",
  "status": "verifying",
  "dnsRecords": [
    {
      "type": "CNAME",
      "name": "abc123._domainkey.acme.com",
      "value": "abc123.dkim.amazonses.com"
    }
  ]
}

Error responses

StatusWhen
400No sender configured, DNS records not ready yet, or status is not pending_dns / unverified.
403Insufficient permissions, or the Custom Branding feature is not enabled.
404Dashboard not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.