---
title: Update Products
slug: data-platform/api/update-products
docTags:
createdAt: 2026-09-02T14:41:00.110Z
---
{
"id": "WGitJk-sLSKaj9YXyDs5l",
"type": "api-oas-v2",
"data": {
"method": "POST",
"url": "https://api.us1.odp.optimizely.com/v3/objects/products",
"servers": [
{
"url": "https://api.us1.odp.optimizely.com/v3/objects/products",
"description": "United States"
},
{
"url": "https://api.eu1.odp.optimizely.com/v3/objects/products",
"description": "Europe"
},
{
"url": "https://api.au1.odp.optimizely.com/v3/objects/products",
"description": "Asia-Pacific"
}
],
"name": "Update Products",
"description": "Update products with new metadata as your inventory updates.",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [
{
"name": "accept",
"type": "string",
"kind": "optional",
"description": "Generated from available response content types",
"enum": [
"application/json"
],
"default": "application/json"
}
],
"queryParameters": [],
"bodyDataParameters": [
{
"kind": "required",
"name": "body",
"type": "array",
"example": "[{\"product_id\":123,\"name\":\"Red Shirt\"},{\"product_id\":456,\"name\":\"Blue Shirt\"}]",
"examples": [
{
"label": "Example Payload",
"value": "[{\"product_id\":123,\"name\":\"Red Shirt\"},{\"product_id\":456,\"name\":\"Blue Shirt\"}]"
}
],
"description": "",
"customType": "Product[]",
"schema": [
{
"name": "product_id",
"kind": "required",
"type": "string",
"description": "the product_id associated with the product
"
},
{
"name": "{product_field}",
"kind": "optional",
"type": "map",
"description": "Any other product field. Refer to the product reference above for the full list of available fields.",
"example": "",
"customType": "map",
"schema": []
}
],
"modelRef": "#/components/schemas/Product",
"isExpanded": true
}
],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "x-api-key",
"name": "x-api-key",
"kind": "optional",
"type": "apiKey",
"in": "header"
}
],
"cookieParameters": []
},
"responses": [
{
"statusCode": "202",
"description": "Accepted",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "GenericUpdateResponse",
"schema": [
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "status",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "timestamp",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/GenericUpdateResponse",
"isExpanded": true
}
]
},
{
"statusCode": "400",
"description": "Bad Request",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"title\":\"Bad Request\",\"status\":400,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"invalids\":[{\"field\":\"delimiter\",\"reason\":\"Unrecognized delimiter, valid options are comma, tab or pipe\"}]}}",
"description": "",
"customType": "40xResponse",
"schema": [
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "status",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "timestamp",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "invalids",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "event",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
}
],
"modelRef": "#/components/schemas/40xResponse",
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "Forbidden",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{ \"message\": \"Forbidden\"}",
"description": "",
"customType": "403Response",
"schema": [
{
"name": "message",
"kind": "optional",
"type": "string",
"description": ""
}
],
"modelRef": "#/components/schemas/403Response",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Not Found",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"example": "{\"title\":\"Bad Request\",\"status\":404,\"timestamp\":\"2018-09-10T21:07:10-05:00\",\"detail\":{\"message\":\"Not found description\"}}",
"description": "",
"customType": "40xResponse",
"schema": [
{
"name": "title",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "status",
"kind": "optional",
"type": "integer",
"description": "",
"format": "int32"
},
{
"name": "timestamp",
"kind": "optional",
"type": "string",
"description": ""
},
{
"name": "detail",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "invalids",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "event",
"kind": "optional",
"type": "integer",
"description": ""
},
{
"name": "message",
"kind": "optional",
"type": "string",
"description": ""
}
]
}
]
}
],
"modelRef": "#/components/schemas/40xResponse",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "v21yAB33zGWNPf0qi_oH7",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n --url https://api.us1.odp.optimizely.com/v3/objects/products \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '[\n {\n \"product_id\": \"\"\n }\n ]'"
},
{
"id": "eTAhMsMCrh4-T10Vj7EtJ",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify([\n {\n \"product_id\": \"\"\n }\n]);\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.us1.odp.optimizely.com/v3/objects/products\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "AbeIDk8uGPv85q5bK_5bA",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.us1.odp.optimizely.com/v3/objects/products\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump([\n {\n \"product_id\": \"\"\n }\n])\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "1czWKQrvxY0T6N9V_ikzo",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.us1.odp.optimizely.com/v3/objects/products\"\n\npayload = json.dumps([\n {\n \"product_id\": \"\"\n }\n])\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "v21yAB33zGWNPf0qi_oH7"
},
"results": {
"languages": [
{
"id": "response-0-202",
"language": "202",
"code": "// Accepted\n{\n \"title\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\"\n}"
},
{
"id": "response-1-400",
"language": "400",
"code": "// Bad Request\n{\n \"title\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\",\n \"detail\": {\n \"invalids\": [\n {\n \"event\": 0,\n \"message\": \"\"\n }\n ]\n }\n}"
},
{
"id": "response-2-403",
"language": "403",
"code": "// Forbidden\n{\n \"message\": \"\"\n}"
},
{
"id": "response-3-404",
"language": "404",
"code": "// Not Found\n{\n \"title\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\",\n \"detail\": {\n \"invalids\": [\n {\n \"event\": 0,\n \"message\": \"\"\n }\n ]\n }\n}"
}
],
"selectedLanguageId": "response-0-202"
}
},
"children": [
{
"text": ""
}
]
}