Drafts

Create a draft. Requires message_send or draft_write. draft_write does not send mail. in_reply_to or forward_of derives threading from that message. send_at schedules it and adds the scheduled label. Idempotency-Key and client_id replay the original draft.

post/api/v1/inboxes/{id}/drafts

Request

  • Base URL: https://cooperemail.com
  • URL: https://cooperemail.com/api/v1/inboxes/{id}/drafts
  • Auth: HTTP bearer

Path parameters

idstring required

Headers

Idempotency-Keystring

Optional. 1 to 256 characters: letters, digits, and - . _ ~. The same key and the same request within 24 hours returns the stored message with HTTP 200, idempotent true, and Idempotent-Replayed: true, and does not send again. A different request is 409 idempotency_key_conflict. A second call while the first is still running is 409 idempotency_request_in_progress. An empty or invalid value is 400 invalid_idempotency_key. A failed send removes the key. When client_id is also set, client_id is checked first. Keys expire after 24 hours.

Request body

tostring[]
ccstring[]
bccstring[]
reply_tostring
subjectstring
textstring
htmlstring
in_reply_tostring

Reply to this message. Mutually exclusive with forward_of.

forward_ofstring

Forward this message. Mutually exclusive with in_reply_to.

reply_allboolean
send_atstring date-time nullable
client_idstring

Response

Created draft

object'draft'
idstring
inbox_idstring
tostring[]
ccstring[]
bccstring[]
reply_tostring nullable
subjectstring
textstring
htmlstring nullable
previewstring
labelsstring[]
in_reply_tostring nullable
forward_ofstring nullable
reply_allboolean
send_status'scheduled' | 'sending' | 'failed' | 'null' nullable
send_atstring date-time nullable
approval_status'pending' | 'approved' | 'rejected' | 'null' nullable
client_idstring nullable
created_atstring date-time
updated_atstring date-time

Changes

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