JAjammed-org
Customer

Invite an existing customer

Changed on

Send a registration invitation to an existing customer who has not yet created their account.

Jammed emails the customer a link to set their password, exactly as if they had been created with the invite action on POST /customers.json - but without creating a duplicate customer record. Use this when the customer already exists (for example, they've already made a booking) and you want them to register.

On success, the customer's status becomes invited. The invitation link is valid for 2 days - after it expires, calling this endpoint again issues a fresh invitation.

Returns a 422 error if the customer has already registered an account, or if they already have a valid (unexpired) invitation. Returns a 404 if the customer does not exist or has been deleted.

post/customers/{id}/invite

Request

  • Base URL
    https://api.jammed.app/api/v2
  • Auth
    none declared. Required headers: Authorization

Path parameters

idinteger required

Headers

Authorizationstring required

Response

Invitation sent

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

Changes