Skip to main content
POST
Create a sandbox campaign

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Read-only access (GET requests only, plus POST semantic search)
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): Secret key required
  • Payment verification (POST /v1/payments/verify): Secret key required
  • AI Recommendations (POST /v1/recommendations): Secret key required
  • Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
  • All write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Body

application/json
name
string

Defaults to a generated Sandbox campaign … name.

type
string
default:seasonal
budget
number
default:1000

Total spend the campaign may draw down. Must be greater than zero.

discount_type
enum<string>
default:percentage
Available options:
percentage,
fixed_amount
discount_value
number
default:10

Must be greater than zero.

applies_to
enum<string>
default:all

Which sales channel the campaign discounts.

Available options:
all,
online,
pos
start_date
string<date>

Defaults to today. Cannot be in the past.

end_date
string<date>

Defaults to 30 days from today.

status
string
default:active

Response

Sandbox campaign created.

campaign
object

A campaign created in the sandbox — a budget with a discount attached. It discounts an order like a promotion but stops once budget_spent reaches budget.