emails

PUT /emails/{id}/

Changed on

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required

A UUID string identifying this email.

Query parameters

format'json' | 'xlsx'

Request body

idstring uuid required
urlstring uri required
accountstring uri required
external_idstring
state'queued' | 'over_quota' | 'sent' | 'failed' | 'received' required
notificationstring uri required
senderstring uri required
from_emailstring email
reply_to_emailstring email
to_emailsstring[]
subjectstring required
messagestring required
sent_atstring date-time required
failed_atstring date-time required
received_atstring date-time required
created_atstring date-time required

Response

idstring uuid required
urlstring uri required
accountstring uri required
external_idstring
state'queued' | 'over_quota' | 'sent' | 'failed' | 'received' required
notificationstring uri required
senderstring uri required
from_emailstring email
reply_to_emailstring email
to_emailsstring[]
subjectstring required
messagestring required
sent_atstring date-time required
failed_atstring date-time required
received_atstring date-time required
created_atstring date-time required

Changes

    • info

      media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status

    • info

      media type application/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status

    • info

      media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status

    • info

      media type application/xlsx; version=2.4.11 was changed to application/xlsx; version=2.4.12 for the response status