Businesses
getProfile
businesses.getProfile
Read one business profile by UUID
Risk: read
data full type
data full type
listProfiles
businesses.listProfiles
List the account business profiles
Risk: read
data full type
data full type
meta full type
meta full type
Contacts
claim
contacts.claim
Claim an anonymous contact with a real email; merges into a matching contact, which cannot be undone
Risk: destructive
data full type
data full type
create
contacts.create
Create a contact from an email address
Risk: write
data full type
data full type
createAnonymous
contacts.createAnonymous
Create an anonymous contact with a fictional email
Risk: write
data full type
data full type
delete
contacts.delete
Delete a contact (DEFAULT or GDPR); cannot be undone
Risk: destructive
findOneByEmail
contacts.findOneByEmail
Read one contact by email address
Risk: read
data full type
data full type
findOrCreate
contacts.findOrCreate
Read a contact by email, creating one when missing
Risk: write
data full type
data full type
get
contacts.get
Read one contact by UUID with balances and subscriptions
Risk: read
data full type
data full type
getCreditBalance
contacts.getCreditBalance
Read a contact credit balance
Risk: read
data full type
data full type
getPrepaidBalance
contacts.getPrepaidBalance
Read a contact prepaid balance
Risk: read
data full type
data full type
getTier
contacts.getTier
Read the contact current loyalty tier
Risk: read
data full type
data full type
list
contacts.list
List contacts with paging, date and attribute filters
Risk: read
data full type
data full type
meta full type
meta full type
merge
contacts.merge
Merge a source contact into a destination contact; cannot be undone
Risk: destructive
update
contacts.update
Update contact attributes keyed by attribute name
Risk: write
data full type
data full type
Giftcards
create
giftcards.create
Issue a digital giftcard with a balance; it carries real value and uses Leat tokens
Risk: destructive
data full type
data full type
findOneByHash
giftcards.findOneByHash
Read one giftcard by hash or QR value
Risk: read
data full type
data full type
get
giftcards.get
Read one giftcard by UUID
Risk: read
data full type
data full type
list
giftcards.list
List giftcards with program and paging filters
Risk: read
data full type
data full type
meta full type
meta full type
listPrograms
giftcards.listPrograms
List the giftcard programs
Risk: read
data full type
data full type
meta full type
meta full type
sendByEmail
giftcards.sendByEmail
Email a giftcard to a contact; the email cannot be recalled
Risk: destructive
data full type
data full type
Loyalty
getProgram
loyalty.getProgram
Read the account loyalty program settings
Risk: read
data full type
data full type
listTransactions
loyalty.listTransactions
List loyalty transactions with type, shop and date filters
Risk: read
data full type
data full type
meta full type
meta full type
Points
create
points.create
Add or subtract points on a contact balance directly
Risk: write
data full type
data full type
get
points.get
Read one direct points transaction
Risk: read
data full type
data full type
reverse
points.reverse
Reverse a direct points transaction (once per transaction)
Risk: write
data full type
data full type
Promotions
get
promotions.get
Read one promotion by UUID
Risk: read
data full type
data full type
list
promotions.list
List the account promotions
Risk: read
data full type
data full type
meta full type
meta full type
Rewards
get
rewards.get
Read one reward by UUID
Risk: read
data full type
data full type
list
rewards.list
List rewards, optionally claimable by a contact
Risk: read
data full type
data full type
meta full type
meta full type
redeem
rewards.redeem
Create a reward reception: claim a reward for a contact
Risk: write
data full type
data full type
reverseRedemption
rewards.reverseRedemption
Reverse a reward redemption, reissuing the credits
Risk: write
data full type
data full type
update
rewards.update
Update a reward title, description or required credits
Risk: write
data full type
data full type
Vouchers
create
vouchers.create
Create a voucher for a promotion
Risk: write
data full type
data full type
find
vouchers.find
Read one voucher by code
Risk: read
data full type
data full type
list
vouchers.list
List vouchers with promotion, contact and status filters
Risk: read
data full type
data full type
meta full type
meta full type
lock
vouchers.lock
Lock a voucher and receive a release key
Risk: write
data full type
data full type
redeem
vouchers.redeem
Redeem a voucher by code at a business profile
Risk: write
data full type
data full type
release
vouchers.release
Release a locked voucher with its release key
Risk: write
data full type
data full type
reverseRedemption
vouchers.reverseRedemption
Reverse a voucher redemption
Risk: write
update
vouchers.update
Update voucher status, attributes or expiration
Risk: write
data full type
data full type
validate
vouchers.validate
Check whether a voucher is redeemable at a business profile
Risk: read
Webhooks
create
webhooks.create
Create a webhook subscription for one event type
Risk: write
data full type
data full type
delete
webhooks.delete
Delete a webhook subscription; it cannot be restored
Risk: destructive
get
webhooks.get
Read one webhook subscription by UUID
Risk: read
data full type
data full type
list
webhooks.list
List webhook subscriptions with event type and status filters
Risk: read
data full type
data full type
meta full type
meta full type
update
webhooks.update
Update a subscription name, URL or status
Risk: write
data full type
data full type