Update an existing section in an MVT experience

post

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

Modifies an existing section within a multivariate (MVT) experience. This can include changing the section's name or updating its versions and their associated changes. The entire list of versions for the section must be provided; versions not included will be removed.

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 updated section

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 strings

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

Updates an existing section in an MVT experience. Requires the section's id and name. The versions array provided will replace all existing versions for this section. Each version object should include its id, name, and changes. If a version ID is new, it will be created. Existing versions not in the list will be removed. IMPORTANT: Modifying sections impacts MVT variation combinations.

Base properties for a section within a Multivariate (MVT) experience.

string

length between 1 and 2

A unique identifier for this section within the MVT experience (e.g., "s1", "01", "ab"). Typically a short string (1-2 characters). This ID helps in structuring the MVT test.

name

string

length ≤ 200

A user-defined, friendly name for this section (e.g., "Page Headline", "Main Call-to-Action Button", "Hero 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.

versions

array of objects

required

Version definition.

Each Multivariate experience is made of a list of Sections and a list of Versions

Than, variations of a Multivariate experience are made of all possible combinations of versions, takin one from each section.

Example: Experience has Section A and Section B. Section A has Version 1 and Version 2, Section B has Version 3 and Version 4

The resulting experience's variations will be the following:

Section A - Version 1 + Section B - Version 3
Section A - Version 2 + Section B - Version 3
Section A - Version 1 + Section B - Version 4
Section A - Version 1 + Section B - Version 4

versions*

Responses

200A list of sections defined for a multivariate (MVT) experience. Each section includes its id, name, and an array of its versions (alternatives).

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.