API Reference

Update an AB test

patch
https://api.purchasely.io/management/v1/applications//ab_tests/

Update an AB test.

  • Most fields apply only while the AB test is DRAFT (see individual field descriptions).
  • category_tag_ids and placement_ids, when provided, fully replace the existing set: send the complete list, not a diff. Omit either to leave the existing set untouched.
  • ab_test_variants, when provided, is a full resend of every variant.

Required scope: experimentation.ab_tests:edit

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Public ID of the resource.

string
required

Public ID of the resource.

Query Params
fields[]
array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]
Body Params
ab_test_variants
array of objects
length ≥ 2

Variants to create/update/remove. DRAFT only. An entry with id (a variant's public_id) updates that variant; an existing variant whose id is NOT included is removed; an entry with no id creates a new variant.

ab_test_variants
config
object
string

Existing variant public ID when updating; omit for a new variant.

integer
required
≥ 0

Zero-based position; saving a standalone draft or launching an embedded campaign test requires consecutive positions 0..n-1.

string
required
length ≥ 1

Screen/flow public ID from screens_list, not its vendor_id.

string
required
length ≥ 1

Variant identifier, unique across the application. Use a test-specific prefix.

integer
required
1 to 99

Traffic percent. Saving a standalone draft or launching an embedded campaign test requires 1–99 per variant, summing to 100.

config
object
string

Existing variant public ID when updating; omit for a new variant.

integer
required
≥ 0

Zero-based position; saving a standalone draft or launching an embedded campaign test requires consecutive positions 0..n-1.

string
required
length ≥ 1

Screen/flow public ID from screens_list, not its vendor_id.

string
required
length ≥ 1

Variant identifier, unique across the application. Use a test-specific prefix.

integer
required
1 to 99

Traffic percent. Saving a standalone draft or launching an embedded campaign test requires 1–99 per variant, summing to 100.

string

Audience public ID (aud_… or caud_… or rtaud_…) to target. DRAFT only.

category_tag_ids
array of strings

Category tag public IDs (cat_…) to associate. Omit to leave existing category tags untouched.

category_tag_ids
string

Free-text description of the test.

string

Display name shown in console.

placement_ids
array of strings

Placement public IDs (plac_…) this test runs on. DRAFT only. Omit to leave existing placements untouched.

placement_ids
string

USER_INTERFACE or PRICING. DRAFT only.

string

Stable machine identifier used in SDK calls. DRAFT only.

Responses

Updated 24 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago

Did this page help you?