Create an immutable sandbox-to-Live promotion plan

curl --request POST \
  --url https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "includes": [
    "forms",
    "catalog"
  ]
}
'

import requests

url = "https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions"

payload = { "includes": ["forms", "catalog"] }
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({includes: ['forms', 'catalog']})
};

fetch('https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions', 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",
  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([
    'includes' => [
        'forms',
        'catalog'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"includes\": [\n    \"forms\",\n    \"catalog\"\n  ]\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")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"includes\": [\n    \"forms\",\n    \"catalog\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/sandbox-promotions")

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  \"includes\": [\n    \"forms\",\n    \"catalog\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "spr_01H",
  "includes": [
    "forms",
    "catalog"
  ],
  "mappings": [
    {
      "resource_type": "form",
      "source_id": "frv_test",
      "target_id": "frv_live"
    }
  ],
  "plan_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "plan_version": 2,
  "resources": [
    {
      "action": "create",
      "after": {
        "name": "Fall registration 2026"
      },
      "after_sha256": "cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc",
      "before": {
        "name": "Fall registration"
      },
      "before_sha256": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
      "changed_fields": [
        "form_fields",
        "name"
      ],
      "source_id": "frv_test",
      "source_version": 5,
      "target_id": "frv_live",
      "target_version": 3,
      "type": "form"
    }
  ],
  "status": "ready",
  "studio_id": "stu_01H"
}

{
  "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>"
}