Search docs ⌘K
esc
Type to search across all documentation pages
Booking

Customers

Manage booking customers and their contact details.

Create a customer

POST
/modules/booking/customers
booking:write

Create a new booking customer.

curl
curl -X POST https://api.saasignal.saastemly.com/modules/booking/customers \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name":"example"}'
json — 201 Created
{ "status": "ok" }
Body field
Type
Description
name required
string
1–256 chars
external_id
string
phone
string
email
string
pattern ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
tags
array
max 50 items
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

List customers

GET
/modules/booking/customers
booking:read

List booking customers.

curl
curl https://api.saasignal.saastemly.com/modules/booking/customers \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Query param
Type
Description
email
string
q
string
tags
string
limit
integer
range ≥1 .. ≤100default 25
cursor
string
Error responses
401 Unauthorized
402 Insufficient tokens
429 Rate limited

Get a customer

GET
/modules/booking/customers/{customer_id}
booking:read

Retrieve a single booking customer.

curl
curl https://api.saasignal.saastemly.com/modules/booking/customers/{customer_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
customer_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Update a customer

PATCH
/modules/booking/customers/{customer_id}
booking:write

Update a booking customer.

curl
curl -X PATCH https://api.saasignal.saastemly.com/modules/booking/customers/{customer_id} \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
customer_id required
string
Body field
Type
Description
name
string
1–256 chars
external_id
mixed
phone
string
email
string
pattern ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
tags
array
max 50 items
metadata
object
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited

Delete a customer

DELETE
/modules/booking/customers/{customer_id}
booking:admin

Permanently remove a booking customer.

curl
curl -X DELETE https://api.saasignal.saastemly.com/modules/booking/customers/{customer_id} \
  -H "Authorization: Bearer sk_live_..."
json — 200 OK
{ "status": "ok" }
Path param
Type
Description
customer_id required
string
Error responses
401 Unauthorized
402 Insufficient tokens
404 Not found
429 Rate limited