Get dashboard email sender — StatusDashboard Docs

GET /app/dashboards/{id}/branding/email-sender

Returns the configured notification email sender for a dashboard, including verification status and DKIM DNS records when applicable. Requires the Custom Branding feature entitlement.

This endpoint is separate from Get dashboard branding — logos, colors, and header links are managed via the branding endpoints; the email sender has its own domain verification lifecycle.

Path parameters

Parameter	Description
`id`	The UUID of the dashboard.

Request

See API Basics for required headers.

This endpoint takes no request body.

Sample request

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

Sample response

Status: 200 OK — sender configured, awaiting DNS

{
  "address": "support@acme.com",
  "domain": "acme.com",
  "status": "pending_dns",
  "dnsRecords": [
    {
      "type": "CNAME",
      "name": "abc123._domainkey.acme.com",
      "value": "abc123.dkim.amazonses.com"
    }
  ]
}

Status: 200 OK — no sender configured

{
  "status": "unset"
}

Response fields

Field	Type	Description
`status`	string	`unset`, `pending_dns`, `verifying`, `verified`, `failed`, `unverified`, or `removing`.
`address`	string	Full sender email address (e.g. `support@acme.com`). Omitted when `status` is `unset`.
`domain`	string	Sending domain derived from `address`. Omitted when `status` is `unset`.
`dnsRecords`	array	DKIM CNAME records to publish in DNS. Present while verification is in progress or after unverification.
`verifiedAt`	string	ISO 8601 timestamp when the domain was last verified.
`unverifiedAt`	string	ISO 8601 timestamp when verification was lost.
`error`	string	Human-readable error when `status` is `failed` or `unverified`.

Error responses

Status	When
`403`	Insufficient permissions, or the Custom Branding feature is not enabled.
`404`	Dashboard not found or does not belong to the caller's organization.