Update a product draft
Requires studio_catalog:write, a Live key, and expected_edit_version. Updating a published product creates or updates its server-owned draft revision.
curl --request PATCH \
--url https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_edit_version": 2,
"availability": {
"as_add_on": true,
"in_packages": true,
"listed": true,
"standalone": true
},
"description": "<string>",
"media_asset_ids": [
"<string>"
],
"name": "<string>",
"option_selections": [
{
"option_id": "<string>",
"allowed_values": [
"<string>"
],
"default_value": "<string>",
"value": "<string>"
}
],
"sort_order": 1
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}"
payload = {
"expected_edit_version": 2,
"availability": {
"as_add_on": True,
"in_packages": True,
"listed": True,
"standalone": True
},
"description": "<string>",
"media_asset_ids": ["<string>"],
"name": "<string>",
"option_selections": [
{
"option_id": "<string>",
"allowed_values": ["<string>"],
"default_value": "<string>",
"value": "<string>"
}
],
"sort_order": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_edit_version: 2,
availability: {as_add_on: true, in_packages: true, listed: true, standalone: true},
description: '<string>',
media_asset_ids: ['<string>'],
name: '<string>',
option_selections: [
{
option_id: '<string>',
allowed_values: ['<string>'],
default_value: '<string>',
value: '<string>'
}
],
sort_order: 1
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_edit_version' => 2,
'availability' => [
'as_add_on' => true,
'in_packages' => true,
'listed' => true,
'standalone' => true
],
'description' => '<string>',
'media_asset_ids' => [
'<string>'
],
'name' => '<string>',
'option_selections' => [
[
'option_id' => '<string>',
'allowed_values' => [
'<string>'
],
'default_value' => '<string>',
'value' => '<string>'
]
],
'sort_order' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}"
payload := strings.NewReader("{\n \"expected_edit_version\": 2,\n \"availability\": {\n \"as_add_on\": true,\n \"in_packages\": true,\n \"listed\": true,\n \"standalone\": true\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"option_selections\": [\n {\n \"option_id\": \"<string>\",\n \"allowed_values\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort_order\": 1\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_edit_version\": 2,\n \"availability\": {\n \"as_add_on\": true,\n \"in_packages\": true,\n \"listed\": true,\n \"standalone\": true\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"option_selections\": [\n {\n \"option_id\": \"<string>\",\n \"allowed_values\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort_order\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_edit_version\": 2,\n \"availability\": {\n \"as_add_on\": true,\n \"in_packages\": true,\n \"listed\": true,\n \"standalone\": true\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"option_selections\": [\n {\n \"option_id\": \"<string>\",\n \"allowed_values\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort_order\": 1\n}"
response = http.request(request)
puts response.read_body{
"availability": {
"active": true,
"as_add_on": true,
"in_packages": true,
"listed": true,
"standalone": true
},
"canonical_product_id": "<string>",
"canonical_product_revision": 123,
"edit_version": 123,
"id": "<string>",
"media_asset_ids": [
"<string>"
],
"name": "<string>",
"option_selections": [
{
"mode": "studio_fixed",
"option_id": "<string>",
"allowed_values": [
"<string>"
],
"default_value": "<string>",
"value": "<string>"
}
],
"price": {
"amount": 1,
"currency": "USD"
},
"status": "draft",
"description": "<string>",
"sort_order": 123,
"variant_parent_product_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}Authorizations
Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.
Headers
Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.
1 - 100Path Parameters
Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.
5 - 256^stu_[A-Za-z0-9_-]+$1 - 256Body
x >= 1Show child attributes
Show child attributes
121 - 240Show child attributes
Show child attributes
Show child attributes
Show child attributes
x >= 0Response
Updated draft
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
draft, published, archived curl --request PATCH \
--url https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_edit_version": 2,
"availability": {
"as_add_on": true,
"in_packages": true,
"listed": true,
"standalone": true
},
"description": "<string>",
"media_asset_ids": [
"<string>"
],
"name": "<string>",
"option_selections": [
{
"option_id": "<string>",
"allowed_values": [
"<string>"
],
"default_value": "<string>",
"value": "<string>"
}
],
"sort_order": 1
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}"
payload = {
"expected_edit_version": 2,
"availability": {
"as_add_on": True,
"in_packages": True,
"listed": True,
"standalone": True
},
"description": "<string>",
"media_asset_ids": ["<string>"],
"name": "<string>",
"option_selections": [
{
"option_id": "<string>",
"allowed_values": ["<string>"],
"default_value": "<string>",
"value": "<string>"
}
],
"sort_order": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_edit_version: 2,
availability: {as_add_on: true, in_packages: true, listed: true, standalone: true},
description: '<string>',
media_asset_ids: ['<string>'],
name: '<string>',
option_selections: [
{
option_id: '<string>',
allowed_values: ['<string>'],
default_value: '<string>',
value: '<string>'
}
],
sort_order: 1
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expected_edit_version' => 2,
'availability' => [
'as_add_on' => true,
'in_packages' => true,
'listed' => true,
'standalone' => true
],
'description' => '<string>',
'media_asset_ids' => [
'<string>'
],
'name' => '<string>',
'option_selections' => [
[
'option_id' => '<string>',
'allowed_values' => [
'<string>'
],
'default_value' => '<string>',
'value' => '<string>'
]
],
'sort_order' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}"
payload := strings.NewReader("{\n \"expected_edit_version\": 2,\n \"availability\": {\n \"as_add_on\": true,\n \"in_packages\": true,\n \"listed\": true,\n \"standalone\": true\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"option_selections\": [\n {\n \"option_id\": \"<string>\",\n \"allowed_values\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort_order\": 1\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_edit_version\": 2,\n \"availability\": {\n \"as_add_on\": true,\n \"in_packages\": true,\n \"listed\": true,\n \"standalone\": true\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"option_selections\": [\n {\n \"option_id\": \"<string>\",\n \"allowed_values\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort_order\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/products/{product_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_edit_version\": 2,\n \"availability\": {\n \"as_add_on\": true,\n \"in_packages\": true,\n \"listed\": true,\n \"standalone\": true\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"name\": \"<string>\",\n \"option_selections\": [\n {\n \"option_id\": \"<string>\",\n \"allowed_values\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"sort_order\": 1\n}"
response = http.request(request)
puts response.read_body{
"availability": {
"active": true,
"as_add_on": true,
"in_packages": true,
"listed": true,
"standalone": true
},
"canonical_product_id": "<string>",
"canonical_product_revision": 123,
"edit_version": 123,
"id": "<string>",
"media_asset_ids": [
"<string>"
],
"name": "<string>",
"option_selections": [
{
"mode": "studio_fixed",
"option_id": "<string>",
"allowed_values": [
"<string>"
],
"default_value": "<string>",
"value": "<string>"
}
],
"price": {
"amount": 1,
"currency": "USD"
},
"status": "draft",
"description": "<string>",
"sort_order": 123,
"variant_parent_product_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}