API Reference

Bulk delete customers

delete
https://api.smoothpos.net/customers.json

Deletes every customer that matches the filters you pass. The filters are the same ones GET /customers.json takes.

This deletes every record that matches your filters, so double-check them with the matching list call first. Run GET /customers.json with exactly the same filters and check the result before you delete.

Multiple tags delete more

tagged=a,b matches records with any of the tags, so this deletes everything tagged a or b. List first with the same filters to check what will go.

Required permission:

GroupPermission
CustomersCreate, edit and delete customers (includes view)
Query Params
integer

Only return customers with an ID greater than this one. Handy for picking up where you left off.

string

Comma-separated list of customer IDs to fetch, e.g. 2099268,2099269.

string

Free-text search across customer details.

string

Only return customers with this email address.

string

Only return customers with this first name.

string

Only return customers with this last name.

string

Deletes records with any of these tags. Send one tag or a comma-separated list, up to 50.

string

Partial match on middle_name.

string

Partial match on full_name.

string

Exact match on loyalty_optin.

Responses

Updated 8 days ago

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

Updated 8 days ago

Did this page help you?