OpenAPI JSON

API resource

Sender Emails

Sender Emails are email addresses you add to your account so report and notification emails can use them as the From address. Use Sender Emails to see each address, whether ownership is pending or verified, and the DKIM and return-path DNS details used to authenticate it. DKIM details are the DNS hostname and value that help prove emails from the address are authorized by the domain. Return-path details are the DNS hostname and value used by the email provider to handle bounced emails and support sender authentication.

10 operations · Each operation has a stable reference URL.

GET

List sender emails

Returns sender emails in your account with display names, verification status, and DNS details.

/sender-emails
POST

Create sender email

Creates a sender email for a From address and starts ownership verification.

/sender-emails
GET

Show sender email

Returns one sender email from your account with verification status and DNS details.

/sender-emails/{sender_email_id}
DELETE

Delete sender email

Deletes a sender email from your account.

/sender-emails/{sender_email_id}
POST

Update sender email

Updates the display name or return-path hostname for a sender email.

/sender-emails/{sender_email_id}/update
POST

Resend sender email verification

Requests another ownership verification email for a sender email with `status: pending`.

/sender-emails/{sender_email_id}/resend-verification
POST

Rotate sender email DKIM

Rotates the DKIM DNS value for a sender email with `status: verified`.

/sender-emails/{sender_email_id}/rotate-dkim
POST

Verify sender email DKIM

Checks DKIM DNS verification for a sender email with `status: verified`.

/sender-emails/{sender_email_id}/verify-dkim
POST

Verify sender email return path

Checks whether the return-path CNAME is published and accepted for a sender email with `status: verified`.

/sender-emails/{sender_email_id}/verify-return-path
POST

Refresh sender email verification status

Refreshes the current ownership and DNS verification status for a sender email.

/sender-emails/{sender_email_id}/refresh