Inbox

Forward a conversation

Forwards the conversation with its history and attachments to up to 10 addresses, from the mailbox that received it. It goes out at once with delivery: checking; within three minutes the conversation shows delivered or rejected with the reason.

CostWhat it doesKey scopes
FreeSends emailargorant:manage_lists
post/api/v1/inbox/{event_id}/forward

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/inbox/{event_id}/forward
  • Auth: HTTP bearer

Path parameters

event_idstring required

The conversation id from GET /api/v1/inbox.

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

tostring[] required

1 to 10 addresses.

notestring

A note above the forwarded text, up to 4,000 characters.

Response

OK

okboolean
forwarded_tostring[]
fromstring
forward_idstring
deliverystring

Changes

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