Skip to main content
POST
Create customer

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
email
string<email>
required
name
string

Customer full name

phone
string
address
string
status
enum<string>
default:active
Available options:
active,
inactive
join_date
string<date>
external_id
string

Optional identifier from an external identity provider (Auth0, Clerk, Cognito, Firebase, NextAuth, etc). Must be unique within the store + environment. Use this to map your upstream user to a Galactic Core customer record without keeping a side-table.

Example:

"auth0|66a3f8c2b1d9c204a1f7e3d1"

Whether the customer has opted in to marketing communications. Defaults to false (opt-in). Pass the state of your storefront's marketing opt-in checkbox. When true, the customer is eligible for subscription to the store's connected marketing tools.

Example:

true

Response

Customer created

customer
object
required