AGagentmail-to
inboxes > messages

Forward Message

Changed on

CLI:

agentmail inboxes messages forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
post/v0/inboxes/{inbox_id}/messages/{message_id}/forward

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/forward
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

message_idstring required

ID of message.

Request body

labelsstring[]

Labels of message.

subjectstring

Subject of message.

textstring

Plain text body of message.

htmlstring

HTML body of message.

headersMessagesSendMessageHeaders

Headers to include in message.

track_opensboolean

Track when this message is first opened. Requires a custom domain with tracking enabled and an HTML body. Opens surface as the opened label on the message and as a message.opened event. One pixel is injected per message, not per recipient, so a message with several recipients fires once when any of them opens it, and the event does not identify which one.

Response

Response with status 200

message_idstring required

ID of message.

thread_idstring required

ID of thread.

Changes

  • 3f5c7830c952Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property // became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag inboxes > messages added

    • info

      api tag InboxesMessages removed

    • info

      added the new optional request property

    • info

      request body became optional

  • 394ddcdd9c29Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status