Sign in

v1

latestOpenAPI 3.0.2Jammed Bookings2026-07-147540124.9 KB
Customer Endpoints

Create a customer

Create a new customer on Jammed.

With a new customer, you must at least provide an name and email address.

You can also issue actions to the endpoint, to create and invite the customer to set a password - Jammed will then send them an email from your account with a link to set their password.

You can't create a customer with an email address that already exists as a registered customer on Jammed. You can create a customer with an email address that already exists, so long as the customer is not yet registered on Jammed.

Jammed API doesn't accept passwords for customer creation process - they must be set by the customer themselves in the invitation process to verify the email and to improve security.

post/customers.json

Headers

Authorizationstring required

Response

Customer created

idinteger

Use to identify the customer in other API calls

namestring

The customers given full name

emailstring

The customers email address

mobilestring

The customers mobile phone number

avatarstring

The customers avatar image URL, if any

credit_balanceinteger

The customers current credit balance in cents/pence/units

This cannot be changed via the API

status'unregistered' | 'invited' | 'registered' | 'banned' | 'behind_payment'

The status of the customer

unregistered: The customer has booked but not registered an account invited: The customer has been invited to register an account registered: The customer has registered an account banned: The customer has been marked as banned from booking (and will not be able to book) behind_payment: The customer has been marked as behind on payments (and will not be able to book)

reminders_opt_inboolean

Whether this customer wants to receive reminders

mailing_list_opt_inboolean

Whether this customer wants to be on the mailing list

signed_upboolean

Whether the customer has signed up

signed_up_atinteger

Unix timestamp from epoch - when the customer signed up

bookings_countinteger

The number of bookings the customer has made

created_atinteger

Unix timestamp from epoch - when the customer was created

updated_atinteger

Unix timestamp from epoch - when the customer was last updated

last_booking_atinteger

Unix timestamp from epoch - when the customer last booked