Create a draft package
Requires studio_catalog:write, a Live key, and Idempotency-Key.
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/packages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"add_ons": [
{
"active": true,
"price": {
"amount": 1,
"currency": "USD"
},
"product_id": "<string>",
"digital_configuration_id": "<string>",
"sort_order": 1
}
],
"lines": [
{
"product_id": "<string>",
"quantity": 50,
"digital_configuration_id": "<string>"
}
],
"name": "<string>",
"price": {
"amount": 1,
"currency": "USD"
},
"description": "<string>",
"media_asset_ids": [
"<string>"
],
"sort_order": 1
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/packages"
payload = {
"add_ons": [
{
"active": True,
"price": {
"amount": 1,
"currency": "USD"
},
"product_id": "<string>",
"digital_configuration_id": "<string>",
"sort_order": 1
}
],
"lines": [
{
"product_id": "<string>",
"quantity": 50,
"digital_configuration_id": "<string>"
}
],
"name": "<string>",
"price": {
"amount": 1,
"currency": "USD"
},
"description": "<string>",
"media_asset_ids": ["<string>"],
"sort_order": 1
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
add_ons: [
{
active: true,
price: {amount: 1, currency: 'USD'},
product_id: '<string>',
digital_configuration_id: '<string>',
sort_order: 1
}
],
lines: [{product_id: '<string>', quantity: 50, digital_configuration_id: '<string>'}],
name: '<string>',
price: {amount: 1, currency: 'USD'},
description: '<string>',
media_asset_ids: ['<string>'],
sort_order: 1
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/packages', 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}/packages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'add_ons' => [
[
'active' => true,
'price' => [
'amount' => 1,
'currency' => 'USD'
],
'product_id' => '<string>',
'digital_configuration_id' => '<string>',
'sort_order' => 1
]
],
'lines' => [
[
'product_id' => '<string>',
'quantity' => 50,
'digital_configuration_id' => '<string>'
]
],
'name' => '<string>',
'price' => [
'amount' => 1,
'currency' => 'USD'
],
'description' => '<string>',
'media_asset_ids' => [
'<string>'
],
'sort_order' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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}/packages"
payload := strings.NewReader("{\n \"add_ons\": [\n {\n \"active\": true,\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"product_id\": \"<string>\",\n \"digital_configuration_id\": \"<string>\",\n \"sort_order\": 1\n }\n ],\n \"lines\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 50,\n \"digital_configuration_id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://api.batchrelay.com/v1/studios/{studio_id}/packages")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"add_ons\": [\n {\n \"active\": true,\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"product_id\": \"<string>\",\n \"digital_configuration_id\": \"<string>\",\n \"sort_order\": 1\n }\n ],\n \"lines\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 50,\n \"digital_configuration_id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/packages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"add_ons\": [\n {\n \"active\": true,\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"product_id\": \"<string>\",\n \"digital_configuration_id\": \"<string>\",\n \"sort_order\": 1\n }\n ],\n \"lines\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 50,\n \"digital_configuration_id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n}"
response = http.request(request)
puts response.read_body{
"add_ons": [
{
"active": true,
"price": {
"amount": 1,
"currency": "USD"
},
"product_id": "<string>",
"digital_configuration_id": "<string>",
"sort_order": 1
}
],
"availability": {
"active": true,
"as_add_on": true,
"in_packages": true,
"listed": true,
"standalone": true
},
"edit_version": 123,
"id": "<string>",
"lines": [
{
"photo_configuration": "individual",
"product_id": "<string>",
"quantity": 50,
"digital_configuration_id": "<string>"
}
],
"media_asset_ids": [
"<string>"
],
"name": "<string>",
"price": {
"amount": 1,
"currency": "USD"
},
"status": "<string>",
"description": "<string>",
"sort_order": 123
}{
"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
1 - 200Untrusted 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_-]+$Body
Response
Draft package
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/packages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"add_ons": [
{
"active": true,
"price": {
"amount": 1,
"currency": "USD"
},
"product_id": "<string>",
"digital_configuration_id": "<string>",
"sort_order": 1
}
],
"lines": [
{
"product_id": "<string>",
"quantity": 50,
"digital_configuration_id": "<string>"
}
],
"name": "<string>",
"price": {
"amount": 1,
"currency": "USD"
},
"description": "<string>",
"media_asset_ids": [
"<string>"
],
"sort_order": 1
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/packages"
payload = {
"add_ons": [
{
"active": True,
"price": {
"amount": 1,
"currency": "USD"
},
"product_id": "<string>",
"digital_configuration_id": "<string>",
"sort_order": 1
}
],
"lines": [
{
"product_id": "<string>",
"quantity": 50,
"digital_configuration_id": "<string>"
}
],
"name": "<string>",
"price": {
"amount": 1,
"currency": "USD"
},
"description": "<string>",
"media_asset_ids": ["<string>"],
"sort_order": 1
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
add_ons: [
{
active: true,
price: {amount: 1, currency: 'USD'},
product_id: '<string>',
digital_configuration_id: '<string>',
sort_order: 1
}
],
lines: [{product_id: '<string>', quantity: 50, digital_configuration_id: '<string>'}],
name: '<string>',
price: {amount: 1, currency: 'USD'},
description: '<string>',
media_asset_ids: ['<string>'],
sort_order: 1
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/packages', 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}/packages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'add_ons' => [
[
'active' => true,
'price' => [
'amount' => 1,
'currency' => 'USD'
],
'product_id' => '<string>',
'digital_configuration_id' => '<string>',
'sort_order' => 1
]
],
'lines' => [
[
'product_id' => '<string>',
'quantity' => 50,
'digital_configuration_id' => '<string>'
]
],
'name' => '<string>',
'price' => [
'amount' => 1,
'currency' => 'USD'
],
'description' => '<string>',
'media_asset_ids' => [
'<string>'
],
'sort_order' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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}/packages"
payload := strings.NewReader("{\n \"add_ons\": [\n {\n \"active\": true,\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"product_id\": \"<string>\",\n \"digital_configuration_id\": \"<string>\",\n \"sort_order\": 1\n }\n ],\n \"lines\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 50,\n \"digital_configuration_id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://api.batchrelay.com/v1/studios/{studio_id}/packages")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"add_ons\": [\n {\n \"active\": true,\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"product_id\": \"<string>\",\n \"digital_configuration_id\": \"<string>\",\n \"sort_order\": 1\n }\n ],\n \"lines\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 50,\n \"digital_configuration_id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/packages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"add_ons\": [\n {\n \"active\": true,\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"product_id\": \"<string>\",\n \"digital_configuration_id\": \"<string>\",\n \"sort_order\": 1\n }\n ],\n \"lines\": [\n {\n \"product_id\": \"<string>\",\n \"quantity\": 50,\n \"digital_configuration_id\": \"<string>\"\n }\n ],\n \"name\": \"<string>\",\n \"price\": {\n \"amount\": 1,\n \"currency\": \"USD\"\n },\n \"description\": \"<string>\",\n \"media_asset_ids\": [\n \"<string>\"\n ],\n \"sort_order\": 1\n}"
response = http.request(request)
puts response.read_body{
"add_ons": [
{
"active": true,
"price": {
"amount": 1,
"currency": "USD"
},
"product_id": "<string>",
"digital_configuration_id": "<string>",
"sort_order": 1
}
],
"availability": {
"active": true,
"as_add_on": true,
"in_packages": true,
"listed": true,
"standalone": true
},
"edit_version": 123,
"id": "<string>",
"lines": [
{
"photo_configuration": "individual",
"product_id": "<string>",
"quantity": 50,
"digital_configuration_id": "<string>"
}
],
"media_asset_ids": [
"<string>"
],
"name": "<string>",
"price": {
"amount": 1,
"currency": "USD"
},
"status": "<string>",
"description": "<string>",
"sort_order": 123
}{
"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>"
}