Definition

Customers

A customer is a persisted person record for a shopper or creator in a merchant account. Partner API customers can be created, enrolled in a program, and credited.

Response blueprint

Fields returned for this resource. Expand nested objects to inspect their fields.

array of objects — item fields

idinteger
emailstring
Email address for this person.
phonestring | null
Phone number for this person.
first_namestring | null
Person's given name.
last_namestring | null
Person's family name.
instagram_handlestring | null
The instagram handle for this resource.
tiktok_handlestring | null
The tiktok handle for this resource.
balancestring
Store credit amount in wallet. Eg. "12.3", meaning $12.30
codestring | null
May be blank if customer is not enrolled yet. Public, to share with friends/followers
microsite_urlstring | null
May be blank if customer is not enrolled yet. Public, to share with friends/followers
reward_codestring | null
May be blank if customer is not enrolled yet. Private, to redeem their wallet balance.
redeem_urlstring | null
May be blank if customer is not enrolled yet. Private, to redeem their wallet balance.
campaign_idinteger | null
May be blank if customer is not enrolled yet.
enrolled_atstring | null
ISO8601 timestamp when customer was enrolled. May be blank if customer is not enrolled yet.
tagsarray of strings
Customer tags added via the admin app

Endpoints

GETSearch for customers/api/v1/customersPOSTCreate customer/api/v1/customersPOSTEnroll a customer/api/v1/customers/{id}/enrollPOSTAdd balance/api/v1/customers/{id}/add_balanceGETGet customer insights/api/v1/customers/{id}/insightsPOSTRedact a customer/api/v1/customers/{id}/redact