Skip to content

Set A/B test winner

Selects the winning content version for an A/B test newsletter.

This method can be used only for A/B test newsletters created with manual winner selection.

Request#

POST https://api.esv2.com/v2/Api/SetAbTestWinner

Request data format#

Data element children:

Element/attributeTypeDescription
NewsletterIdintegerID of the A/B test newsletter. Required.
WinnerContentVersionIdintegerID of the winning content version. Required.
SendDatedatetimeDate and time when the winning version should be sent. Optional. If not specified, the winner is sent immediately.
TimeZonestringTime zone for SendDate. Optional. If not specified, the business unit time zone is used. See the list of supported time zones in the newsletter documentation.

Response#

If the request is valid, the method returns HTTP status 201 Created.

This method does not return any response body.

Additional notes 

  • This method can be used only for newsletters created with WinnerPickMethod set to Manual.
  • WinnerContentVersionId must point to one of the content versions created for the specified A/B test.
  • If SendDate is earlier than the current date and time, the winner is sent immediately.

Examples#

Send the winner immediately

Request:

<ApiRequest>
  <ApiKey>test_api_key</ApiKey>
  <Data>
    <NewsletterId>125269</NewsletterId>
    <WinnerContentVersionId>206286</WinnerContentVersionId>
  </Data>
</ApiRequest>

Schedule sending the winner for a specific date.

Request:

<ApiRequest>
  <ApiKey>test_api_key</ApiKey>
  <Data>
    <NewsletterId>125269</NewsletterId>
    <WinnerContentVersionId>206286</WinnerContentVersionId>
    <SendDate>2026-04-24T22:00:00Z</SendDate>
    <TimeZone>Central European Standard Time</TimeZone>
  </Data>
</ApiRequest>

Privacy policy