Email Domains

Update a sending domain's open/click tracking or receiving

Requires email_domains:m.

patch/v1/email-domains/{id}

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/email-domains/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Request body

open_trackingboolean nullable

Track opens on this domain's email. Null restores the platform default.

click_trackingboolean nullable

Track clicks on this domain's email. Null restores the platform default.

receivingboolean

Receive email at this domain. The domain must be verified for sending first; the response adds the inbound MX record to publish.

Response

The updated domain, with the DNS records to publish (the inbound MX while receiving is on).

idstring required
domainstring required
status'pending' | 'verifying' | 'verified' | 'failed' | 'temporarily_failed' required
regionstring required
verified_atstring date-time nullable required
last_checked_atstring date-time nullable required
failure_reasonstring nullable required
revalidation_failed_atstring date-time nullable required
open_trackingboolean nullable required
click_trackingboolean nullable required
receiving_status'off' | 'pending' | 'verified' | 'failed' required
receiving_requested_atstring date-time nullable required
receiving_verified_atstring date-time nullable required
receiving_failure_reasonstring nullable required
receiving_revalidation_failed_atstring date-time nullable required
receiving_last_checked_atstring date-time nullable required

When the inbound MX was last checked on its own; last_checked_at dates the sending check.

receiving_warning'apex_mx' | 'null' nullable required

apex_mx while receiving is on at a likely registrable apex: an MX there takes over the domain's own mail.

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.