Personalization Experiment Update

Update a personalization experiment.
Resource
1/personalization/abn-experiments/${IdOrName}?action=${action}
Available version
65.0
HTTP method
PATCH
Request body
Personalization Experiment Input
Request parameters
Parameter Name Type Description Required or Optional
IdOrName String The ID or API name of the experiment definition. Required
action Personalization Experiment Action Enum Starts, stops, or archives the experiment. Optional
Response body
Personalization Experiment

Example

Request:

1{
2    "label": "newExperimentLabel",
3    "description": "new description"
4}

Response:

1{
2    "chanceToWinThreshold": 95,
3    "cohorts": [
4        {
5            "allocationWeight": 5000,
6            "attributeValues": [
7                {
8                    "attributeEnum": null,
9                    "attributeName": "Attr1",
10                    "value": "1"
11                }
12            ],
13            "createdById": "005SB000002HvvEYAS",
14            "createdDate": "2025-04-01T14:23:03.000Z",
15            "id": "1GcSB000000032j0AA",
16            "isControl": true,
17            "isFallThrough": false,
18            "label": "Cohort 1 (Control)",
19            "name": "cohort_1"
20        },
21        {
22            "allocationWeight": 5000,
23            "attributeValues": [
24                {
25                    "attributeEnum": null,
26                    "attributeName": "Attr1",
27                    "value": "2"
28                }
29            ],
30            "createdById": "005SB000002HvvEYAS",
31            "createdDate": "2025-04-01T14:23:03.000Z",
32            "id": "1GcSB000000032k0AA",
33            "isControl": false,
34            "isFallThrough": false,
35            "label": "Cohort 2",
36            "name": "cohort_2"
37        }
38    ],
39    "createdById": "005SB000002HvvEYAS",
40    "createdDate": "2025-04-01T14:23:02.000Z",
41    "dataSpaceName": "default",
42    "description": "new description",
43    "id": "1GaSB00000Cojr30AB",
44    "isRemote": false,
45    "label": "newExperimentLabel",
46    "lastAnalyzed": null,
47    "lastModifiedById": "005SB000002HsR5YAK",
48    "lastModifiedDate": "2026-01-07T14:55:21.000Z",
49    "maximumDurationInMinutes": 129600,
50    "minimumDurationInMinutes": 20160,
51    "minimumRequiredParticipants": 1000,
52    "name": "testExp50",
53    "parameters": [
54        {
55            "engagementSignalName": "Flow_Email_Click_3",
56            "parameterName": "DeviceModel",
57            "values": [
58                "iPhone 16",
59                "iPad Air",
60                "iPad Mini"
61            ]
62        },
63        {
64            "engagementSignalName": "Flow_Email_Click_3",
65            "parameterName": "EmailsInFlowExp",
66            "values": [
67                "testEmail1",
68                "testEmail1"
69            ]
70        },
71        {
72            "engagementSignalName": "A_New_Flow_Email_Click_New",
73            "parameterName": "EmailsInFlowExp2",
74            "values": [
75                "testEmail3",
76                "testEmail3"
77            ]
78        },
79        {
80            "engagementSignalName": "Flow_Email_Click_3",
81            "parameterName": "OS",
82            "values": [
83                "iOS 26",
84                "iOS 18"
85            ]
86        }
87    ],
88    "primaryMetrics": [
89        {
90            "higherIsBetter": true,
91            "metricName": "TwoCompound",
92            "metricType": "EngagementSignalCompound",
93            "overallScoreWeight": 10000
94        }
95    ],
96    "profileDataGraphName": "RTDG",
97    "scheduleFrequencyInMinutes": 1440,
98    "schemaName": "AResponseTemplate",
99    "secondaryMetrics": [
100        {
101            "engagementSignalName": "Flow_Email_Click_3",
102            "higherIsBetter": true,
103            "metricName": "Count Indv_Flow_Email_Click_3",
104            "metricType": "EngagementSignal"
105        }
106    ],
107    "source": "FlowBuilder",
108    "sourceRecordId": null,
109    "startedDate": "2025-06-17T01:46:53.000Z",
110    "state": "Started",
111    "status": "Active",
112    "stoppedDate": null,
113    "url": "/services/data/v65.0/personalization/abn-experiments/1GaSB00000Cojr30AB",
114    "winnerSelectionMode": "Manual"
115}