Roll back one applied sandbox-to-Live promotion
Requires a production br_ API key with sandbox_promotions:apply, the exact studio grant, Idempotency-Key, and the applied version plus SHA-256. Content-Type must be application/json and the strict body limit is 32 KiB. Convex returns 409 when newer Live edits make rollback unsafe; clients must inspect the current plan instead of assuming an inverse change can be applied.
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"applied_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"expected_applied_version": 3
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback"
payload = {
"applied_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"expected_applied_version": 3
}
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({
applied_sha256: 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb',
expected_applied_version: 3
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback', 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}/sandbox-promotions/{promotion_id}/rollback",
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([
'applied_sha256' => 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb',
'expected_applied_version' => 3
]),
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}/sandbox-promotions/{promotion_id}/rollback"
payload := strings.NewReader("{\n \"applied_sha256\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n \"expected_applied_version\": 3\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}/sandbox-promotions/{promotion_id}/rollback")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applied_sha256\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n \"expected_applied_version\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback")
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 \"applied_sha256\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n \"expected_applied_version\": 3\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"includes": [
"forms"
],
"plan_sha256": "<string>",
"plan_version": 2,
"resources": [
{
"action": "create",
"after_sha256": "<string>",
"before_sha256": "<string>",
"changed_fields": [
"<string>"
],
"type": "<string>",
"after": {
"active": true,
"description": "<string>",
"item_count": 1,
"name": "<string>",
"price_cents": 1,
"status": "<string>"
},
"before": {
"active": true,
"description": "<string>",
"item_count": 1,
"name": "<string>",
"price_cents": 1,
"status": "<string>"
},
"blocking_errors": [
"<string>"
],
"resulting_target_version": 2,
"source_id": "<string>",
"source_version": 2,
"target_id": "<string>",
"target_version": 2,
"warnings": [
"<string>"
]
}
],
"status": "preparing",
"studio_id": "<string>",
"applied_sha256": "<string>",
"applied_version": 2,
"errors": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z",
"failure_code": "<string>",
"failure_message": "<string>",
"lifecycle": "preparing",
"mappings": [
{
"resource_type": "<string>",
"source_id": "<string>",
"target_id": "<string>"
}
],
"warnings": [
"<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>"
}{
"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_-]+$Opaque public promotion identifier.
5 - 256^spr_Body
Response
Rolled-back promotion status
An immutable, bounded review and lifecycle record. It never returns secret material, storage IDs/object keys, signed URLs, raw source documents, provider payloads, or customer-context prices. status is authoritative; lifecycle is a compatibility duplicate. preparing is a current state only: trusted internal media staging must settle before apply, without promising asynchronous readiness or byte-copy behavior to the API caller.
5 - 256^spr_1 - 3 elementsforms, catalog, storefront ^[a-f0-9]{64}$x >= 1250Show child attributes
Show child attributes
preparing, ready, applying, applied, conflicted, failed, rolled_back, expired 5 - 256^stu_^[a-f0-9]{64}$x >= 11001 - 1000801000preparing, ready, applying, applied, conflicted, failed, rolled_back, expired 250Show child attributes
Show child attributes
1001 - 1000curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"applied_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"expected_applied_version": 3
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback"
payload = {
"applied_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"expected_applied_version": 3
}
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({
applied_sha256: 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb',
expected_applied_version: 3
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback', 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}/sandbox-promotions/{promotion_id}/rollback",
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([
'applied_sha256' => 'bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb',
'expected_applied_version' => 3
]),
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}/sandbox-promotions/{promotion_id}/rollback"
payload := strings.NewReader("{\n \"applied_sha256\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n \"expected_applied_version\": 3\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}/sandbox-promotions/{promotion_id}/rollback")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applied_sha256\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n \"expected_applied_version\": 3\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions/{promotion_id}/rollback")
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 \"applied_sha256\": \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\",\n \"expected_applied_version\": 3\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"includes": [
"forms"
],
"plan_sha256": "<string>",
"plan_version": 2,
"resources": [
{
"action": "create",
"after_sha256": "<string>",
"before_sha256": "<string>",
"changed_fields": [
"<string>"
],
"type": "<string>",
"after": {
"active": true,
"description": "<string>",
"item_count": 1,
"name": "<string>",
"price_cents": 1,
"status": "<string>"
},
"before": {
"active": true,
"description": "<string>",
"item_count": 1,
"name": "<string>",
"price_cents": 1,
"status": "<string>"
},
"blocking_errors": [
"<string>"
],
"resulting_target_version": 2,
"source_id": "<string>",
"source_version": 2,
"target_id": "<string>",
"target_version": 2,
"warnings": [
"<string>"
]
}
],
"status": "preparing",
"studio_id": "<string>",
"applied_sha256": "<string>",
"applied_version": 2,
"errors": [
"<string>"
],
"expires_at": "2023-11-07T05:31:56Z",
"failure_code": "<string>",
"failure_message": "<string>",
"lifecycle": "preparing",
"mappings": [
{
"resource_type": "<string>",
"source_id": "<string>",
"target_id": "<string>"
}
],
"warnings": [
"<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>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}