Add a new version to an MVT section

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/sections/{section_id}/versions/add

Creates a new version (alternative) within a specific section of a multivariate (MVT) experience. Requires defining the version name and its associated changes (CSS, JS, etc.).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

experience_id

integer

required

The ID of the given experience

section_id

string

required

The ID of the section under which to create the version

Query Params

include

array of objects

Array parameter that would mention extra fields to be included into the response; otherwise those fields would be excluded by default

Read more in the section related to Optional Fields

include

expand

array of objects

Specifies the list of objects which would be expanded in the response. Otherwise, only their id would be returned.

Read more in the section related to Expanding Fields

expand

Body Params

Adds a new version (alternative) to an existing section within an MVT experience. Requires:

id: A unique 1-2 character ID for this version within its section.
name: A descriptive name for the version (e.g., "Red Button", "Short Headline").
changes: An array defining the modifications (JS, CSS) for this specific version. IMPORTANT: Adding versions changes the MVT combinations.

string

length between 1 and 2

A unique identifier for this version within its parent section (e.g., "v1", "02", "ab"). Typically a short string (1-2 characters). This ID is used to construct the overall MVT variation combinations.

name

string

length ≤ 200

A user-defined, friendly name for this version (e.g., "Red Button", "Headline Option A", "Original Image"). This name appears in MVT setup and reports.

concurrency_key

string | null

A server-generated hash that represents the object's state at the time of retrieval. When included in an update request, the operation will only succeed if the object hasn't been modified since this key was obtained. If another update has occurred in the meantime, the request will fail with a conflict error, requiring you to fetch the latest version and retry your update with the new concurrency_key. This implements optimistic concurrency control to prevent lost updates in concurrent scenarios.

changes

array

List of changes to apply. If ID of a change is not provided, the change is gonna be created. Otherwise the change would be updated

changes

Responses

201Details for a single version within an MVT experience section, including its id, name, and the changes (CSS, JS modifications) it applies.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.