Turn A/B testing on or off

POST/v1/campaigns/{campaign_id}/ab-testing

Scope: campaigns:write

Turns the campaign's A/B test on or off. traffic_split is the percentage of new leads that get variation_a, from 0 to 100; the rest get variation_b. It applies to leads enrolled from now on: leads already enrolled keep their arm.

Turning the test on needs a variation_b with steps, written with Replace a campaign's sequence; without one, the request answers 409 VARIATION_B_MISSING. With enabled: false, every new lead gets variation A.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

campaign_idstring · uuidRequired
ID of the campaign.

Request body

enabledbooleanRequired
true runs the test; false sends every new lead variation A
traffic_splitinteger
Percentage of NEW leads that get variation A (the rest get B)
≥ 0≤ 100Default 50

Response

200

messagestringRequired
ab_testing_enabledboolean or null
campaign_idstring or null
successboolean
Default true
traffic_splitinteger or null
winnerstring 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. `details.errors` lists each failing field with its `field`, `message` and `type`.
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
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 `leads:write`.
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 `NOT_FOUND`.
409	VARIATION_B_MISSING	The campaign's sequence has no `variation_b` with steps, so there's nothing to test against variation A. Write one with Replace a campaign's sequence before turning A/B testing on or promoting a winner.
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 `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
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 `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`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 `429`: seconds to wait before retrying.