Emails

Get an email by id

Requires emails:r.

get/v1/emails/{id}

Request

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

Path parameters

idstring required

Response

The sent email, with its event timeline.

idstring required
fromstring required
tostring[] required
subjectstring required
body_purged_atstring date-time nullable required

Set once retention purged the subject and body.

status'queued' | 'scheduled' | 'sending' | 'sent' | 'delivered' | 'bounced' | 'complained' | 'rejected' | 'failed' | 'cancelled' required
ses_message_idstring nullable required
is_commercialboolean required
attachments_countinteger required
livemodeboolean required
created_atstring date-time required
from_namestring nullable required
ccstring[] required
bccstring[] required
htmlstring nullable required
textstring nullable required
cost_centsinteger required

Whole cents this send debited from the balance; often 0 for one sub-cent email.

charge_millicentsinteger required

The exact price the send consumed, in CAD millicents.

attachment_bytesinteger required

Total attachment bytes the charge was computed on.

scheduled_atstring date-time nullable required
updated_atstring date-time required

Changes

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