sending

Reply to a message

Replies to message_id: a ready received message or an accepted sent message in the sending inbox that has a Message-ID header. Write the reply in text, optionally with html, new attachments and labels. Quoted history and the original's attachments aren't included.

Cherami derives the rest:

  • To: the received message's Reply-To, or its From when there is none. A reply to your own sent message goes to its original To.
  • Subject: the original with Re: added, unless it already starts with Re:.
  • Conversation: the reply joins the original's.

For a received message, these recipients come from headers the sender wrote: check its content.reply_to and content.from against your assignment before calling, or create a reply draft to review them first. To choose recipients or subject yourself, use send with in_reply_to; this endpoint refuses those fields. Reply-all also includes the other participants.

Outcomes are those of send.

Retry a reply or forward

Retry as for send: repeat the exact request to the same endpoint with the same key.

post/v1/inboxes/{inbox_id}/reply

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/inboxes/{inbox_id}/reply
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

Cherami resource ID returned by the API.

Request body

message_idstring required

ID of a ready received message or an accepted sent message in this inbox that has a Message-ID header.

textstring required

Nonblank reply text; quoted history isn't added.

htmlstring

HTML alternative, sent as supplied.

labelsLabel[]

Label names, case-sensitive; order and duplicates don't matter.

idempotency_keystring

Your unique value for this one operation. Save it with the exact request before sending; repeating that request with the same key within 24 hours returns what the first one did instead of acting again.

Response

A retry matched an earlier request: this is that request's result as it is now. Nothing new was created or sent.

limitedunknown required
outcome_persistedboolean required

false: this response is the only record of the outcome; keep it rather than resending.

replayedtrue required

true when a retry matched an earlier request: the result is that request's, and nothing new was created or sent.

idempotency_expires_atstring date-time required

When the key stops protecting retries.

Changes

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