Place a gate
curl --request POST \
--url https://api.botshield.ai/operations/gates-api/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "presale-nyc-1120",
"name": "NYC presale",
"message": "Two tickets per fan.",
"preset": "presale",
"policy": {
"version": 3,
"link": "required",
"schedule": {
"opensAt": "2026-11-20T17:00:00Z"
}
},
"destinationUrl": "https://example.com/presale/nyc",
"activate": true
}
'import requests
url = "https://api.botshield.ai/operations/gates-api/create"
payload = {
"key": "presale-nyc-1120",
"name": "NYC presale",
"message": "Two tickets per fan.",
"preset": "presale",
"policy": {
"version": 3,
"link": "required",
"schedule": { "opensAt": "2026-11-20T17:00:00Z" }
},
"destinationUrl": "https://example.com/presale/nyc",
"activate": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: 'presale-nyc-1120',
name: 'NYC presale',
message: 'Two tickets per fan.',
preset: 'presale',
policy: {version: 3, link: 'required', schedule: {opensAt: '2026-11-20T17:00:00Z'}},
destinationUrl: 'https://example.com/presale/nyc',
activate: true
})
};
fetch('https://api.botshield.ai/operations/gates-api/create', 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.botshield.ai/operations/gates-api/create",
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([
'key' => 'presale-nyc-1120',
'name' => 'NYC presale',
'message' => 'Two tickets per fan.',
'preset' => 'presale',
'policy' => [
'version' => 3,
'link' => 'required',
'schedule' => [
'opensAt' => '2026-11-20T17:00:00Z'
]
],
'destinationUrl' => 'https://example.com/presale/nyc',
'activate' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.botshield.ai/operations/gates-api/create"
payload := strings.NewReader("{\n \"key\": \"presale-nyc-1120\",\n \"name\": \"NYC presale\",\n \"message\": \"Two tickets per fan.\",\n \"preset\": \"presale\",\n \"policy\": {\n \"version\": 3,\n \"link\": \"required\",\n \"schedule\": {\n \"opensAt\": \"2026-11-20T17:00:00Z\"\n }\n },\n \"destinationUrl\": \"https://example.com/presale/nyc\",\n \"activate\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.botshield.ai/operations/gates-api/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"presale-nyc-1120\",\n \"name\": \"NYC presale\",\n \"message\": \"Two tickets per fan.\",\n \"preset\": \"presale\",\n \"policy\": {\n \"version\": 3,\n \"link\": \"required\",\n \"schedule\": {\n \"opensAt\": \"2026-11-20T17:00:00Z\"\n }\n },\n \"destinationUrl\": \"https://example.com/presale/nyc\",\n \"activate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/gates-api/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"presale-nyc-1120\",\n \"name\": \"NYC presale\",\n \"message\": \"Two tickets per fan.\",\n \"preset\": \"presale\",\n \"policy\": {\n \"version\": 3,\n \"link\": \"required\",\n \"schedule\": {\n \"opensAt\": \"2026-11-20T17:00:00Z\"\n }\n },\n \"destinationUrl\": \"https://example.com/presale/nyc\",\n \"activate\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"gate": {
"key": "presale-nyc-1120",
"name": "NYC presale",
"message": "<string>",
"status": "draft",
"state": "scheduled",
"environment": "development",
"destination_url": "<string>",
"policy": {
"preset": "presale",
"gate_type": "human",
"age_threshold": 13,
"signed_up": true,
"link": "required",
"passes_per_person": {
"limit": 2,
"window": "ever"
},
"real_days_at_least": 182,
"schedule": {
"opensAt": "2023-11-07T05:31:56Z",
"closesAt": "2023-11-07T05:31:56Z"
},
"line": "2 per person · ever"
},
"placed_at": "2023-11-07T05:31:56Z",
"placed_by_api": true
},
"activated": true,
"activation_error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
},
"error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Gates API
Place a gate
Place a gate from your server. It is placed as a draft; send activate: true to make it live in the same call. In Production the Console’s checks apply to activation — business verified, a verified domain, the plan’s gate allowance — and if they block it the gate is still placed: the call succeeds with activated: false and activation_error. The policy document is the preset’s pre-fill overlaid by policy, validated whole (version defaults to 3 when neither sends one). A key is never auto-suffixed: a key already placed in this environment is refused with gate_key_taken. Nothing is half-placed — if the policy cannot be saved, the gate is removed.
POST
/
gates-api
/
create
Place a gate
curl --request POST \
--url https://api.botshield.ai/operations/gates-api/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "presale-nyc-1120",
"name": "NYC presale",
"message": "Two tickets per fan.",
"preset": "presale",
"policy": {
"version": 3,
"link": "required",
"schedule": {
"opensAt": "2026-11-20T17:00:00Z"
}
},
"destinationUrl": "https://example.com/presale/nyc",
"activate": true
}
'import requests
url = "https://api.botshield.ai/operations/gates-api/create"
payload = {
"key": "presale-nyc-1120",
"name": "NYC presale",
"message": "Two tickets per fan.",
"preset": "presale",
"policy": {
"version": 3,
"link": "required",
"schedule": { "opensAt": "2026-11-20T17:00:00Z" }
},
"destinationUrl": "https://example.com/presale/nyc",
"activate": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: 'presale-nyc-1120',
name: 'NYC presale',
message: 'Two tickets per fan.',
preset: 'presale',
policy: {version: 3, link: 'required', schedule: {opensAt: '2026-11-20T17:00:00Z'}},
destinationUrl: 'https://example.com/presale/nyc',
activate: true
})
};
fetch('https://api.botshield.ai/operations/gates-api/create', 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.botshield.ai/operations/gates-api/create",
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([
'key' => 'presale-nyc-1120',
'name' => 'NYC presale',
'message' => 'Two tickets per fan.',
'preset' => 'presale',
'policy' => [
'version' => 3,
'link' => 'required',
'schedule' => [
'opensAt' => '2026-11-20T17:00:00Z'
]
],
'destinationUrl' => 'https://example.com/presale/nyc',
'activate' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.botshield.ai/operations/gates-api/create"
payload := strings.NewReader("{\n \"key\": \"presale-nyc-1120\",\n \"name\": \"NYC presale\",\n \"message\": \"Two tickets per fan.\",\n \"preset\": \"presale\",\n \"policy\": {\n \"version\": 3,\n \"link\": \"required\",\n \"schedule\": {\n \"opensAt\": \"2026-11-20T17:00:00Z\"\n }\n },\n \"destinationUrl\": \"https://example.com/presale/nyc\",\n \"activate\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.botshield.ai/operations/gates-api/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"presale-nyc-1120\",\n \"name\": \"NYC presale\",\n \"message\": \"Two tickets per fan.\",\n \"preset\": \"presale\",\n \"policy\": {\n \"version\": 3,\n \"link\": \"required\",\n \"schedule\": {\n \"opensAt\": \"2026-11-20T17:00:00Z\"\n }\n },\n \"destinationUrl\": \"https://example.com/presale/nyc\",\n \"activate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/gates-api/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"presale-nyc-1120\",\n \"name\": \"NYC presale\",\n \"message\": \"Two tickets per fan.\",\n \"preset\": \"presale\",\n \"policy\": {\n \"version\": 3,\n \"link\": \"required\",\n \"schedule\": {\n \"opensAt\": \"2026-11-20T17:00:00Z\"\n }\n },\n \"destinationUrl\": \"https://example.com/presale/nyc\",\n \"activate\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"gate": {
"key": "presale-nyc-1120",
"name": "NYC presale",
"message": "<string>",
"status": "draft",
"state": "scheduled",
"environment": "development",
"destination_url": "<string>",
"policy": {
"preset": "presale",
"gate_type": "human",
"age_threshold": 13,
"signed_up": true,
"link": "required",
"passes_per_person": {
"limit": 2,
"window": "ever"
},
"real_days_at_least": 182,
"schedule": {
"opensAt": "2023-11-07T05:31:56Z",
"closesAt": "2023-11-07T05:31:56Z"
},
"line": "2 per person · ever"
},
"placed_at": "2023-11-07T05:31:56Z",
"placed_by_api": true
},
"activated": true,
"activation_error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
},
"error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Authorizations
Your secret server API key (bs_dev_… or bs_production_…) with Gates API access: the gates:write scope, granted in the Console under Settings → Developer Tools → API Keys. Without it every Gates API call answers gates_scope_required. The organization and environment always come from the key. Site keys are refused.
Body
application/json
A gate's policy document (versioned; validated whole). Unknown fields are refused. When preset is also sent on the create call, the preset pre-fills these fields and any field here overrides it.
Show child attributes
Show child attributes
Example:
{
"version": 3,
"preset": "presale",
"link": "required",
"passesPerPerson": { "limit": 2, "window": "ever" },
"realDaysAtLeast": 0,
"schedule": {
"opensAt": "2026-11-20T17:00:00Z",
"closesAt": null
}
}
Response
The placed gate. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: invalid_key (401 — missing, malformed or inactive key), gates_scope_required (403 — the key lacks Gates API access), org_not_found (404), age_threshold_required (400), invalid_policy (400), gate_key_taken (409), internal (500).