Broadcasts

Send a broadcast test email

Sends a test message from an existing Broadcast that has an email delivery connection. Provide a saved Subscriber ID for personalization; use subscribers_list to find one when needed. The recipient may be any test inbox and does not have to match the saved Subscriber.

post/v1/broadcasts/{broadcast_id}/test

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/broadcasts/{broadcast_id}/test
  • Auth: HTTP bearer

Path parameters

broadcast_idstring required

The broadcast identifier.

Headers

Idempotency-Keystring

Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.

Request body

recipientstring email required

The inbox that receives the test message. It may differ from the saved Subscriber used for personalization.

subscriber_idstring required

Required saved Subscriber ID whose profile supplies personalization. Use subscribers_list to find one before sending the test when needed.

Response

Test email sent

Changes

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