Skip to main content
PATCH
Update a shopper

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Body

application/json
email_address
string<email> | null

Email address on file for the shopper.

Maximum string length: 254
enrolled_in_loyalty_program
boolean
default:false

Whether the shopper is enrolled in the loyalty program. Shoppers must explicitly opt into the loyalty program, typically at the POS. Digital gift card recipients are also stored as shoppers, but are only opted into the loyalty program after giving explicit permission.

first_name
string | null

Given name of the shopper.

last_name
string | null

Family name of the shopper.

phone_number
string<phone>

Phone number on file for the shopper, and what a loyalty member gives at checkout to be identified.

Pattern: ^\+[1-9]\d{1,14}$
postal_code
string | null

Postal code on file for the shopper.

Response

A person a store can recognize at checkout, whether as a loyalty member or as the holder of a gift card. A shopper belongs to the banner rather than to any one store.

id
string
required

Unique identifier for the record.

created_at
string<date-time>
required

When the record was created.

email_address
string<email> | null
required

Email address on file for the shopper.

Maximum string length: 254
email_validated
boolean
required

Whether the shopper has confirmed their email address.

enrolled_in_loyalty_program
boolean
required

Whether the shopper is enrolled in the loyalty program. Shoppers must explicitly opt into the loyalty program, typically at the POS. Digital gift card recipients are also stored as shoppers, but are only opted into the loyalty program after giving explicit permission.

first_name
string | null
required

Given name of the shopper.

joined_at_store_id
string | null
required

ID of the store where the shopper enrolled.

Pattern: ^[0-9]+$
last_name
string | null
required

Family name of the shopper.

phone_number
string<phone>
required

Phone number on file for the shopper, and what a loyalty member gives at checkout to be identified.

Pattern: ^\+[1-9]\d{1,14}$
point_balance
string
required

Loyalty points currently available to the shopper.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"199.99"

postal_code
string | null
required

Postal code on file for the shopper.

subscribed_to_email
boolean
required

Whether the shopper has opted in to marketing emails.

subscribed_to_sms
boolean
required

Whether the shopper has opted in to marketing text messages.

updated_at
string<date-time>
required

When the record was last changed.