Append a studio offer revision
Offer terms are immutable after creation. PATCH appends a new revision and requires expected_revision plus Idempotency-Key; stale revisions fail with 409. The authorized mutation projection contains the latest candidate revision, so offers:write is sufficient.
curl --request PATCH \
--url https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"expected_revision": 2,
"terms": {
"currency": "USD",
"limits": {
"max_redemptions": 2,
"once_per_person": true
},
"name": "<string>",
"scope": {
"event_id": "<string>",
"guardian_id": "<string>",
"sellable_ids": [
"<string>"
]
},
"amount_off_cents": 2,
"code": "<string>",
"customer_service_reason": "<string>",
"ends_at": "2023-11-07T05:31:56Z",
"minimum_subtotal_cents": 1,
"percent_off": 50,
"starts_at": "2023-11-07T05:31:56Z"
}
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id}"
payload = {
"expected_revision": 2,
"terms": {
"currency": "USD",
"limits": {
"max_redemptions": 2,
"once_per_person": True
},
"name": "<string>",
"scope": {
"event_id": "<string>",
"guardian_id": "<string>",
"sellable_ids": ["<string>"]
},
"amount_off_cents": 2,
"code": "<string>",
"customer_service_reason": "<string>",
"ends_at": "2023-11-07T05:31:56Z",
"minimum_subtotal_cents": 1,
"percent_off": 50,
"starts_at": "2023-11-07T05:31:56Z"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
expected_revision: 2,
terms: {
currency: 'USD',
limits: {max_redemptions: 2, once_per_person: true},
name: '<string>',
scope: {event_id: '<string>', guardian_id: '<string>', sellable_ids: ['<string>']},
amount_off_cents: 2,
code: '<string>',
customer_service_reason: '<string>',
ends_at: '2023-11-07T05:31:56Z',
minimum_subtotal_cents: 1,
percent_off: 50,
starts_at: '2023-11-07T05:31:56Z'
}
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_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}/offers/{offer_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_revision' => 2,
'terms' => [
'currency' => 'USD',
'limits' => [
'max_redemptions' => 2,
'once_per_person' => true
],
'name' => '<string>',
'scope' => [
'event_id' => '<string>',
'guardian_id' => '<string>',
'sellable_ids' => [
'<string>'
]
],
'amount_off_cents' => 2,
'code' => '<string>',
'customer_service_reason' => '<string>',
'ends_at' => '2023-11-07T05:31:56Z',
'minimum_subtotal_cents' => 1,
'percent_off' => 50,
'starts_at' => '2023-11-07T05:31:56Z'
]
]),
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}/offers/{offer_id}"
payload := strings.NewReader("{\n \"expected_revision\": 2,\n \"terms\": {\n \"currency\": \"USD\",\n \"limits\": {\n \"max_redemptions\": 2,\n \"once_per_person\": true\n },\n \"name\": \"<string>\",\n \"scope\": {\n \"event_id\": \"<string>\",\n \"guardian_id\": \"<string>\",\n \"sellable_ids\": [\n \"<string>\"\n ]\n },\n \"amount_off_cents\": 2,\n \"code\": \"<string>\",\n \"customer_service_reason\": \"<string>\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"minimum_subtotal_cents\": 1,\n \"percent_off\": 50,\n \"starts_at\": \"2023-11-07T05:31:56Z\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_revision\": 2,\n \"terms\": {\n \"currency\": \"USD\",\n \"limits\": {\n \"max_redemptions\": 2,\n \"once_per_person\": true\n },\n \"name\": \"<string>\",\n \"scope\": {\n \"event_id\": \"<string>\",\n \"guardian_id\": \"<string>\",\n \"sellable_ids\": [\n \"<string>\"\n ]\n },\n \"amount_off_cents\": 2,\n \"code\": \"<string>\",\n \"customer_service_reason\": \"<string>\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"minimum_subtotal_cents\": 1,\n \"percent_off\": 50,\n \"starts_at\": \"2023-11-07T05:31:56Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_revision\": 2,\n \"terms\": {\n \"currency\": \"USD\",\n \"limits\": {\n \"max_redemptions\": 2,\n \"once_per_person\": true\n },\n \"name\": \"<string>\",\n \"scope\": {\n \"event_id\": \"<string>\",\n \"guardian_id\": \"<string>\",\n \"sellable_ids\": [\n \"<string>\"\n ]\n },\n \"amount_off_cents\": 2,\n \"code\": \"<string>\",\n \"customer_service_reason\": \"<string>\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"minimum_subtotal_cents\": 1,\n \"percent_off\": 50,\n \"starts_at\": \"2023-11-07T05:31:56Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"application": "automatic",
"created_at": "2023-11-07T05:31:56Z",
"currency": "USD",
"id": "<string>",
"kind": "percent",
"limits": {
"max_redemptions": 2,
"once_per_person": true
},
"name": "<string>",
"provisioning_status": "pending",
"revision": 2,
"revision_id": "<string>",
"scope": {
"kind": "storewide",
"event_id": "<string>",
"guardian_id": "<string>",
"sellable_ids": [
"<string>"
]
},
"status": "draft",
"updated_at": "2023-11-07T05:31:56Z",
"usage": {
"redeemed": 1,
"reserved": 1,
"max_uses": 2,
"remaining": 1
},
"amount_off_cents": 123,
"code": "<string>",
"customer_service_reason": "<string>",
"ends_at": "2023-11-07T05:31:56Z",
"minimum_subtotal_cents": 123,
"percent_off": 123,
"starts_at": "2023-11-07T05:31:56Z"
}{
"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>"
}{
"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_-]+$1 - 240Body
Response
Revised studio offer
automatic, code "USD"percent, fixed Show child attributes
Show child attributes
pending, processing, succeeded, failed, uncertain, unsupported x >= 1Immutable candidate revision ID to pass to activate or schedule.
1Show child attributes
Show child attributes
draft, scheduled, active, paused, expired, exhausted, revoked, sync_error Show child attributes
Show child attributes
curl --request PATCH \
--url https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"expected_revision": 2,
"terms": {
"currency": "USD",
"limits": {
"max_redemptions": 2,
"once_per_person": true
},
"name": "<string>",
"scope": {
"event_id": "<string>",
"guardian_id": "<string>",
"sellable_ids": [
"<string>"
]
},
"amount_off_cents": 2,
"code": "<string>",
"customer_service_reason": "<string>",
"ends_at": "2023-11-07T05:31:56Z",
"minimum_subtotal_cents": 1,
"percent_off": 50,
"starts_at": "2023-11-07T05:31:56Z"
}
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id}"
payload = {
"expected_revision": 2,
"terms": {
"currency": "USD",
"limits": {
"max_redemptions": 2,
"once_per_person": True
},
"name": "<string>",
"scope": {
"event_id": "<string>",
"guardian_id": "<string>",
"sellable_ids": ["<string>"]
},
"amount_off_cents": 2,
"code": "<string>",
"customer_service_reason": "<string>",
"ends_at": "2023-11-07T05:31:56Z",
"minimum_subtotal_cents": 1,
"percent_off": 50,
"starts_at": "2023-11-07T05:31:56Z"
}
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
expected_revision: 2,
terms: {
currency: 'USD',
limits: {max_redemptions: 2, once_per_person: true},
name: '<string>',
scope: {event_id: '<string>', guardian_id: '<string>', sellable_ids: ['<string>']},
amount_off_cents: 2,
code: '<string>',
customer_service_reason: '<string>',
ends_at: '2023-11-07T05:31:56Z',
minimum_subtotal_cents: 1,
percent_off: 50,
starts_at: '2023-11-07T05:31:56Z'
}
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_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}/offers/{offer_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_revision' => 2,
'terms' => [
'currency' => 'USD',
'limits' => [
'max_redemptions' => 2,
'once_per_person' => true
],
'name' => '<string>',
'scope' => [
'event_id' => '<string>',
'guardian_id' => '<string>',
'sellable_ids' => [
'<string>'
]
],
'amount_off_cents' => 2,
'code' => '<string>',
'customer_service_reason' => '<string>',
'ends_at' => '2023-11-07T05:31:56Z',
'minimum_subtotal_cents' => 1,
'percent_off' => 50,
'starts_at' => '2023-11-07T05:31:56Z'
]
]),
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}/offers/{offer_id}"
payload := strings.NewReader("{\n \"expected_revision\": 2,\n \"terms\": {\n \"currency\": \"USD\",\n \"limits\": {\n \"max_redemptions\": 2,\n \"once_per_person\": true\n },\n \"name\": \"<string>\",\n \"scope\": {\n \"event_id\": \"<string>\",\n \"guardian_id\": \"<string>\",\n \"sellable_ids\": [\n \"<string>\"\n ]\n },\n \"amount_off_cents\": 2,\n \"code\": \"<string>\",\n \"customer_service_reason\": \"<string>\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"minimum_subtotal_cents\": 1,\n \"percent_off\": 50,\n \"starts_at\": \"2023-11-07T05:31:56Z\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id}")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_revision\": 2,\n \"terms\": {\n \"currency\": \"USD\",\n \"limits\": {\n \"max_redemptions\": 2,\n \"once_per_person\": true\n },\n \"name\": \"<string>\",\n \"scope\": {\n \"event_id\": \"<string>\",\n \"guardian_id\": \"<string>\",\n \"sellable_ids\": [\n \"<string>\"\n ]\n },\n \"amount_off_cents\": 2,\n \"code\": \"<string>\",\n \"customer_service_reason\": \"<string>\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"minimum_subtotal_cents\": 1,\n \"percent_off\": 50,\n \"starts_at\": \"2023-11-07T05:31:56Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/offers/{offer_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_revision\": 2,\n \"terms\": {\n \"currency\": \"USD\",\n \"limits\": {\n \"max_redemptions\": 2,\n \"once_per_person\": true\n },\n \"name\": \"<string>\",\n \"scope\": {\n \"event_id\": \"<string>\",\n \"guardian_id\": \"<string>\",\n \"sellable_ids\": [\n \"<string>\"\n ]\n },\n \"amount_off_cents\": 2,\n \"code\": \"<string>\",\n \"customer_service_reason\": \"<string>\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"minimum_subtotal_cents\": 1,\n \"percent_off\": 50,\n \"starts_at\": \"2023-11-07T05:31:56Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"application": "automatic",
"created_at": "2023-11-07T05:31:56Z",
"currency": "USD",
"id": "<string>",
"kind": "percent",
"limits": {
"max_redemptions": 2,
"once_per_person": true
},
"name": "<string>",
"provisioning_status": "pending",
"revision": 2,
"revision_id": "<string>",
"scope": {
"kind": "storewide",
"event_id": "<string>",
"guardian_id": "<string>",
"sellable_ids": [
"<string>"
]
},
"status": "draft",
"updated_at": "2023-11-07T05:31:56Z",
"usage": {
"redeemed": 1,
"reserved": 1,
"max_uses": 2,
"remaining": 1
},
"amount_off_cents": 123,
"code": "<string>",
"customer_service_reason": "<string>",
"ends_at": "2023-11-07T05:31:56Z",
"minimum_subtotal_cents": 123,
"percent_off": 123,
"starts_at": "2023-11-07T05:31:56Z"
}{
"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>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}