Sign in

Test recipient feed configuration

Tests the per-recipient feed configuration by fetching data for a specific contact or a random contact from the broadcast audience. The recipient feed must be enabled for the broadcast before calling this endpoint.

post/api/broadcasts.testRecipientFeed

Request body

workspace_idstring required

The ID of the workspace

broadcast_idstring required

ID of the broadcast

contact_emailstring email

Optional email of a specific contact to test with. If not provided, uses a random contact from the audience.

Example request

{
  "workspace_id": "ws_1234567890",
  "broadcast_id": "broadcast_12345",
  "contact_email": "john@example.com"
}

Response

Recipient feed test completed

successboolean

Whether the test was successful

dataobject

The fetched data from the recipient feed

fetched_atstring date-time

When the data was fetched

errorstring

Error message if the test failed

contact_emailstring email

Email of the contact used for the test

Example response

{
  "success": true,
  "contact_email": "john@example.com"
}

Changes