Update an existing experience optimization variant for an experience by ID

PUT

https://api.contentful.com/spaces/:spaceId/environments/:environmentId/experiences/:id/optimization_variants/:variantId

PUT

/spaces/:spaceId/environments/:environmentId/experiences/:id/optimization_variants/:variantId

$ curl -X PUT https://api.contentful.com/spaces/spaceId/environments/environmentId/experiences/id/optimization_variants/variantId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "string",
>   "description": "string",
>   "viewports": [
>     {
>       "id": "string",
>       "query": "string",
>       "displayName": "string",
>       "previewSize": "string"
>     }
>   ],
>   "designProperties": {},
>   "dimensionKeyMap": {
>     "designProperties": {}
>   }
> }'

1 {
2   "sys": {
3     "id": "string",
4     "type": "string",
5     "space": {
6       "sys": {
7         "type": "string",
8         "linkType": "string",
9         "id": "string"
10       }
11     },
12     "environment": {
13       "sys": {
14         "type": "string",
15         "linkType": "string",
16         "id": "string"
17       }
18     },
19     "template": {
20       "sys": {
21         "type": "string",
22         "linkType": "string",
23         "urn": "string"
24       }
25     },
26     "createdAt": "string",
27     "updatedAt": "string",
28     "archivedAt": "string",
29     "archivedBy": {
30       "sys": {
31         "type": "string",
32         "linkType": "string",
33         "id": "string"
34       }
35     },
36     "archivedVersion": 1.1,
37     "createdBy": {
38       "sys": {
39         "type": "string",
40         "linkType": "string",
41         "id": "string"
42       }
43     },
44     "updatedBy": {
45       "sys": {
46         "type": "string",
47         "linkType": "string",
48         "id": "string"
49       }
50     },
51     "variant": "string",
52     "variantType": "string",
53     "variantDimension": "string",
54     "publishedAt": "string",
55     "publishedVersion": 1.1,
56     "publishedCounter": 1.1,
57     "firstPublishedAt": "string",
58     "publishedBy": {
59       "sys": {
60         "type": "string",
61         "linkType": "User",
62         "id": "string"
63       }
64     },
65     "localeStatus": {},
66     "version": 1.1
67   },
68   "name": "string",
69   "description": "string",
70   "viewports": [
71     {
72       "id": "string",
73       "query": "string",
74       "displayName": "string",
75       "previewSize": "string"
76     }
77   ],
78   "designProperties": {},
79   "dimensionKeyMap": {
80     "designProperties": {}
81   },
82   "contentBindings": {
83     "sys": {
84       "type": "string",
85       "linkType": "string",
86       "urn": "string"
87     },
88     "parameters": {}
89   },
90   "metadata": {
91     "tags": [
92       {
93         "sys": {
94           "type": "string",
95           "linkType": "string",
96           "id": "string"
97         }
98       }
99     ],
100     "concepts": [
101       {
102         "sys": {
103           "type": "string",
104           "linkType": "string",
105           "id": "string"
106         }
107       }
108     ],
109     "name": "string"
110   },
111   "slots": {}
112 }

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

environmentIdstringRequired

idstringRequired

variantIdstringRequired

Query parameters

access_tokenstringOptional

Request

Body

namestringRequired

descriptionstringRequired

viewportslist of objectsRequired

designPropertiesmap from strings to maps from strings to objectsRequired

dimensionKeyMapobjectRequired

contentBindingsobjectOptional

slotsmap from strings to lists of objectsOptional

metadataobjectOptional

Response

200

sysobject

namestring

descriptionstring

viewportslist of objects

designPropertiesmap from strings to maps from strings to objects

dimensionKeyMapobject

contentBindingsobject

metadataobject

slotsmap from strings to lists of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error