Create a studio offer

POST

studios

{studio_id}

offers

curl --request POST \
  --url https://api.batchrelay.com/v1/studios/{studio_id}/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "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"

payload = {
    "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.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({
    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', 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",
  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([
    '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"

	payload := strings.NewReader("{\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}")

	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}/offers")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

Authorizations

Authorization

string

header

required

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

Idempotency-Key

string

required

Required string length: 1 - 200

X-BatchRelay-Client-Surface

string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

X-BatchRelay-Client-Version

string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

X-BatchRelay-Invocation-Mode

string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

studio_id

string

required

Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.

Required string length: 5 - 256

Pattern: ^stu_[A-Za-z0-9_-]+$

Body

application/json

application

enum<string>

required

Available options:

automatic,

code

currency

string

required

Allowed value: "USD"

kind

enum<string>

required

Available options:

percent,

fixed

limits

object

required

Show child attributes

name

string

required

Required string length: 1 - 120

scope

object

required

Show child attributes

amount_off_cents

integer

Required range: x >= 1

code

string

Maximum string length: 80

Pattern: ^[A-Z0-9_-]+$

customer_service_reason

string

Maximum string length: 500

ends_at

string<date-time>

minimum_subtotal_cents

integer

Required range: x >= 0

percent_off

integer

Required range: 1 <= x <= 100

starts_at

string<date-time>

Optional; Convex assigns a stable server start during the idempotent write.

Response

Created studio offer

application

enum<string>

required

Available options:

automatic,

code

created_at

string<date-time>

required

currency

string

required

Allowed value: "USD"

string

required

kind

enum<string>

required

Available options:

percent,

fixed

limits

object

required

Show child attributes

name

string

required

provisioning_status

enum<string>

required

Available options:

pending,

processing,

succeeded,

failed,

uncertain,

unsupported

revision

integer

required

Required range: x >= 1

revision_id

string

required

Immutable candidate revision ID to pass to activate or schedule.

Minimum string length: 1

scope

object

required

Show child attributes

status

enum<string>

required

Available options:

draft,

scheduled,

active,

paused,

expired,

exhausted,

revoked,

sync_error

updated_at

string<date-time>

required

usage

object

required

Show child attributes

amount_off_cents

integer

code

string

customer_service_reason

string

ends_at

string<date-time>

minimum_subtotal_cents

integer

percent_off

integer

starts_at

string<date-time>

Create a studio offer

curl --request POST \
  --url https://api.batchrelay.com/v1/studios/{studio_id}/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "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"

payload = {
    "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.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({
    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', 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",
  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([
    '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"

	payload := strings.NewReader("{\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}")

	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}/offers")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

System

Authentication

Anonymous sessions

API accounts

API keys

Managed assets

Browser previews

Catalog

Event team changes

Studio management

Print orders

Template renders

Studio assets

Studio audit

Asset sessions

Assets

Studio catalog assets

Checkout links

Image imports

Studio messages

Studio offers

Studio catalog

Sandbox promotions

Storefront

Templates

Authorizations

Headers

Path Parameters

Body

Response