Promote an A/B winner
/v1/campaigns/{campaign_id}/ab-testing/promoteEnds the test in one arm's favour. With winner: "a", every new lead gets variation A and nothing else moves. With winner: "b", B's steps are copied over variation A with fresh step ids, and every new lead gets them; leads still in flight on A continue on B's remaining steps.
Neither arm is deleted and A/B testing stays enabled, so leads already on B finish B either way. The request needs a running test: 409 AB_TESTING_DISABLED when the test is off, 409 VARIATION_B_MISSING when the campaign has no variation B. Promoting B rewrites the sequence, so a campaign changed since it was read answers 409 SEQUENCE_MODIFIED; retry.
Headers
AuthorizationstringRequiredBearerfollowed by a space and your API key, for exampleBearer vk_….
Path parameters
campaign_idstring · uuidRequiredID of the campaign.
Request body
winnerstringRequireda: every new lead gets A. b: B's steps are copied over A and every new lead gets them; leads in flight on A continue on B's remaining steps. Leads already on B finish B either way.
One of"a""b"
Response
200
messagestringRequiredab_testing_enabledboolean or nullcampaign_idstring or nullsuccessbooleanDefaulttruetraffic_splitinteger or nullwinnerstring or null
Errors
Errors share one JSON body: success, error, message, optional details, and request_id.
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_ERROR | The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. |
| 400 | SEQUENCE_VALIDATION_FAILED | The sequence breaks a structural rule, such as an unknown step type or a |
| 401 | UNAUTHORIZED | The |
| 401 | API_KEY_EXPIRED | The API key is past its expiry date. Create a new key in the Victoria AI app. |
| 403 | INSUFFICIENT_SCOPE | The API key doesn't have the scope this endpoint requires, such as |
| 403 | ORGANIZATION_DEACTIVATED | The organization that owns this API key has been deactivated. |
| 404 | CAMPAIGN_NOT_FOUND | No campaign with this ID exists in your organization. |
| 404 | NOT_FOUND | No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers |
| 409 | VARIATION_B_MISSING | The campaign's sequence has no |
| 409 | AB_TESTING_DISABLED | A/B testing is off for this campaign, so there's no test to promote a winner from. Turn it on with Turn A/B testing on or off first. |
| 409 | SEQUENCE_MODIFIED | The sequence changed after it was read. Retrieve the campaign again and retry. |
| 413 | PAYLOAD_TOO_LARGE | The request body is larger than 1 MB. |
| 429 | RATE_LIMITED | Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the |
| 500 | INTERNAL_ERROR | Something failed on our side. The response never includes internal details; quote its |
| 503 | UPSTREAM_TIMEOUT | A service the API depends on timed out. The request is safe to retry. |
| 503 | AUTH_UNAVAILABLE | The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry. |
Response headers
| Header | Description |
|---|---|
X-Request-ID | Correlation ID for the request, also returned as |
RateLimit-Limit | Requests allowed to this endpoint per minute. |
RateLimit-Remaining | Requests you can still send to this endpoint right now. |
RateLimit-Reset | Seconds until the endpoint's full limit is available again. |
Retry-After | On a |