Update a customer

Updates an existing customer. Include the customer's id in the body along with the fields you want to change. You get the updated customer back.

Required permission:

GroupPermission
CustomersCreate, edit and delete customers (includes view)
Body Params
address
object
required
birthdate
object
number
required

Store credit the customer has available.

string
boolean
required

Whether the customer subscribes to email marketing.

string
integer

Unique ID. Set by Smooth POS.

string
boolean
required

Whether the customer has opted in to your loyalty program.

date-time

When the customer opted in to loyalty.

integer
required

The customer's current loyalty points balance.

number
required

What the customer's points are worth in your currency.

integer
required

Index of the customer's loyalty tier.

date-time

When the customer's current loyalty tier expires.

metadata
object
string
sales
array of objects | null

The customer's sales, when included. null in list responses.

sales
string
boolean
required

Whether the customer subscribes to SMS marketing.

tags
array of strings

Tags attached to the customer.

tags
string
integer
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json