One recipient per Journey send. To takes one recipient in any RecipientInput shape ("a@example.com", "Pat a@example.com", { email, name }, or a one-element list); Cc and Bcc must be empty. reply_to defaults to the Journey's mailbox (an empty list also means the default); Product email needs exactly one. A new API Journey defaults to managed source content; legacy code Journeys retain complete-content sends. A refusal (4xx) leaves nothing frozen for the recipient, so a corrected call with a new idempotency key sends.

post/v1/workspaces/{workspaceId}/transactional-sends

Request

  • Base URL: https://api.bangermail.com
  • URL: https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Request body

journeystring

Key of the Journey this email belongs to, such as welcome. A key Banger has not seen yet records a new Journey from this email and sends it; claim that Journey later to manage its content. The key of a Journey you created sends once that Journey is approved and on. Without a key the send is refused with 422 journey_key_required, unless the workspace accepts sends without one. POST /journeys/{journeyKey}/send is the same send with the key in the path.

mailbox_idstring uuid

Sender mailbox. Optional when the named Journey has one, which then sends.

subjectstring
expires_atstring date-time

Discard a deferred Journey send after this instant; at most seven days from the original request.

expires_after_secondsinteger
body_textstring
body_htmlstring
headersobject

Response

Successful response.

Changes

No recorded changes to this operation across all 2 revisions of this API.