Create customer
Requires secret key
curl --request POST \
--url https://api.tybritelabs.com/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"address": "<string>",
"status": "active",
"join_date": "2023-12-25",
"external_id": "auth0|66a3f8c2b1d9c204a1f7e3d1",
"marketing_consent": true
}
'import requests
url = "https://api.tybritelabs.com/v1/customers"
payload = {
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"address": "<string>",
"status": "active",
"join_date": "2023-12-25",
"external_id": "auth0|66a3f8c2b1d9c204a1f7e3d1",
"marketing_consent": 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({
email: 'jsmith@example.com',
name: '<string>',
phone: '<string>',
address: '<string>',
status: 'active',
join_date: '2023-12-25',
external_id: 'auth0|66a3f8c2b1d9c204a1f7e3d1',
marketing_consent: true
})
};
fetch('https://api.tybritelabs.com/v1/customers', 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.tybritelabs.com/v1/customers",
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([
'email' => 'jsmith@example.com',
'name' => '<string>',
'phone' => '<string>',
'address' => '<string>',
'status' => 'active',
'join_date' => '2023-12-25',
'external_id' => 'auth0|66a3f8c2b1d9c204a1f7e3d1',
'marketing_consent' => 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.tybritelabs.com/v1/customers"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"status\": \"active\",\n \"join_date\": \"2023-12-25\",\n \"external_id\": \"auth0|66a3f8c2b1d9c204a1f7e3d1\",\n \"marketing_consent\": 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.tybritelabs.com/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"status\": \"active\",\n \"join_date\": \"2023-12-25\",\n \"external_id\": \"auth0|66a3f8c2b1d9c204a1f7e3d1\",\n \"marketing_consent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/customers")
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 \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"status\": \"active\",\n \"join_date\": \"2023-12-25\",\n \"external_id\": \"auth0|66a3f8c2b1d9c204a1f7e3d1\",\n \"marketing_consent\": true\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"id": "c9d0c92d-48e7-47d0-8c4f-706876efdd44",
"name": "John Doe",
"email": "john.doe@example.com",
"phone": "+13105550123",
"status": "active",
"join_date": "2026-06-20",
"external_id": null,
"marketing_consent": false,
"total_purchases": 0,
"store_credit_balance": 0,
"created_at": "2026-06-20T13:47:44.9279+00:00",
"updated_at": "2026-06-20T13:47:44.9279+00:00"
}
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "forbidden",
"message": "This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "conflict",
"message": "A customer with this email already exists for this store"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
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) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Body
Customer full name. Defaults to the part of the email address before the @ when omitted.
Customer phone number. Stored as an empty string when omitted.
active, inactive 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.
"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.
true
Response
Customer created
Show child attributes
Show child attributes
curl --request POST \
--url https://api.tybritelabs.com/v1/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"address": "<string>",
"status": "active",
"join_date": "2023-12-25",
"external_id": "auth0|66a3f8c2b1d9c204a1f7e3d1",
"marketing_consent": true
}
'import requests
url = "https://api.tybritelabs.com/v1/customers"
payload = {
"email": "jsmith@example.com",
"name": "<string>",
"phone": "<string>",
"address": "<string>",
"status": "active",
"join_date": "2023-12-25",
"external_id": "auth0|66a3f8c2b1d9c204a1f7e3d1",
"marketing_consent": 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({
email: 'jsmith@example.com',
name: '<string>',
phone: '<string>',
address: '<string>',
status: 'active',
join_date: '2023-12-25',
external_id: 'auth0|66a3f8c2b1d9c204a1f7e3d1',
marketing_consent: true
})
};
fetch('https://api.tybritelabs.com/v1/customers', 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.tybritelabs.com/v1/customers",
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([
'email' => 'jsmith@example.com',
'name' => '<string>',
'phone' => '<string>',
'address' => '<string>',
'status' => 'active',
'join_date' => '2023-12-25',
'external_id' => 'auth0|66a3f8c2b1d9c204a1f7e3d1',
'marketing_consent' => 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.tybritelabs.com/v1/customers"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"status\": \"active\",\n \"join_date\": \"2023-12-25\",\n \"external_id\": \"auth0|66a3f8c2b1d9c204a1f7e3d1\",\n \"marketing_consent\": 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.tybritelabs.com/v1/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"status\": \"active\",\n \"join_date\": \"2023-12-25\",\n \"external_id\": \"auth0|66a3f8c2b1d9c204a1f7e3d1\",\n \"marketing_consent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/customers")
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 \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"status\": \"active\",\n \"join_date\": \"2023-12-25\",\n \"external_id\": \"auth0|66a3f8c2b1d9c204a1f7e3d1\",\n \"marketing_consent\": true\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"id": "c9d0c92d-48e7-47d0-8c4f-706876efdd44",
"name": "John Doe",
"email": "john.doe@example.com",
"phone": "+13105550123",
"status": "active",
"join_date": "2026-06-20",
"external_id": null,
"marketing_consent": false,
"total_purchases": 0,
"store_credit_balance": 0,
"created_at": "2026-06-20T13:47:44.9279+00:00",
"updated_at": "2026-06-20T13:47:44.9279+00:00"
}
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "forbidden",
"message": "This operation requires a secret key. Publishable keys cover catalogue reads and the actions a shopper takes for themselves."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "conflict",
"message": "A customer with this email already exists for this store"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}
