Skip to main content
New to Corsair? See API access, authentication, and error handling.

Businesses

getProfile

businesses.getProfile Read one business profile by UUID Risk: read
Input Output

listProfiles

businesses.listProfiles List the account business profiles Risk: read
Input: empty object Output

Contacts

claim

contacts.claim Claim an anonymous contact with a real email; merges into a matching contact, which cannot be undone Risk: destructive
Input Output

create

contacts.create Create a contact from an email address Risk: write
Input Only the email is required; Piggy answers with the new UUID only. Use contacts.update to add attributes. Output

createAnonymous

contacts.createAnonymous Create an anonymous contact with a fictional email Risk: write
Input Output

delete

contacts.delete Delete a contact (DEFAULT or GDPR); cannot be undone Risk: destructive
Input Schedules the removal; DEFAULT keeps a detailed log and GDPR removes personal data references. Cannot be undone. Output

findOneByEmail

contacts.findOneByEmail Read one contact by email address Risk: read
Input Output

findOrCreate

contacts.findOrCreate Read a contact by email, creating one when missing Risk: write
Input Output

get

contacts.get Read one contact by UUID with balances and subscriptions Risk: read
Input Output

getCreditBalance

contacts.getCreditBalance Read a contact credit balance Risk: read
Input Output

getPrepaidBalance

contacts.getPrepaidBalance Read a contact prepaid balance Risk: read
Input Output

getTier

contacts.getTier Read the contact current loyalty tier Risk: read
Input Output

list

contacts.list List contacts with paging, date and attribute filters Risk: read
Input Attribute filters ride through attributesQuery with Piggy bracketed parameter names, e.g. “attributes[visits][gte]”: 10 or “attributes[likes_pizza]”: true; a contact must match every filter. Output

merge

contacts.merge Merge a source contact into a destination contact; cannot be undone Risk: destructive
Input The source contact ceases to exist and the merge cannot be undone; verify both emails belong to the same person first. Output: empty object

update

contacts.update Update contact attributes keyed by attribute name Risk: write
Input Output

Giftcards

create

giftcards.create Issue a digital giftcard with a balance; it carries real value and uses Leat tokens Risk: destructive
Input The public API only creates digital giftcards (the plugin sends type 1); physical cards are refused with error 55021. Output

findOneByHash

giftcards.findOneByHash Read one giftcard by hash or QR value Risk: read
Input Output

get

giftcards.get Read one giftcard by UUID Risk: read
Input Output

list

giftcards.list List giftcards with program and paging filters Risk: read
Input Output

listPrograms

giftcards.listPrograms List the giftcard programs Risk: read
Input: empty object Output

sendByEmail

giftcards.sendByEmail Email a giftcard to a contact; the email cannot be recalled Risk: destructive
Input Output

Loyalty

getProgram

loyalty.getProgram Read the account loyalty program settings Risk: read
Input: empty object Output

listTransactions

loyalty.listTransactions List loyalty transactions with type, shop and date filters Risk: read
Input type filters to credit_receptions or reward_receptions; shopUuid takes a business profile UUID. Output

Points

create

points.create Add or subtract points on a contact balance directly Risk: write
Input A negative points value subtracts; the transaction can be reversed once with points.reverse. Output

get

points.get Read one direct points transaction Risk: read
Input Output

reverse

points.reverse Reverse a direct points transaction (once per transaction) Risk: write
Input Output

Promotions

get

promotions.get Read one promotion by UUID Risk: read
Input Output

list

promotions.list List the account promotions Risk: read
Input: empty object Output

Rewards

get

rewards.get Read one reward by UUID Risk: read
Input Output

list

rewards.list List rewards, optionally claimable by a contact Risk: read
Input Output

redeem

rewards.redeem Create a reward reception: claim a reward for a contact Risk: write
Input The claim fails with documented codes when credits are insufficient (1017), stock is empty (1018) or the per-contact limit is reached (1019). Output

reverseRedemption

rewards.reverseRedemption Reverse a reward redemption, reissuing the credits Risk: write
Input Output

update

rewards.update Update a reward title, description or required credits Risk: write
Input Output

Vouchers

create

vouchers.create Create a voucher for a promotion Risk: write
Input Output

find

vouchers.find Read one voucher by code Risk: read
Input Output

list

vouchers.list List vouchers with promotion, contact and status filters Risk: read
Input Output

lock

vouchers.lock Lock a voucher and receive a release key Risk: write
Input Returns a release_key needed for later redemption or release; Piggy auto-releases the lock after one hour. Output

redeem

vouchers.redeem Redeem a voucher by code at a business profile Risk: write
Input contactUuid is required when the voucher has no linked contact; pass the releaseKey from vouchers.lock for locked vouchers. Output

release

vouchers.release Release a locked voucher with its release key Risk: write
Input Output

reverseRedemption

vouchers.reverseRedemption Reverse a voucher redemption Risk: write
Input Output: empty object

update

vouchers.update Update voucher status, attributes or expiration Risk: write
Input Output

validate

vouchers.validate Check whether a voucher is redeemable at a business profile Risk: read
Input Output: empty object

Webhooks

create

webhooks.create Create a webhook subscription for one event type Risk: write
Input One subscription per event type: creating again for the same event_type overwrites the existing subscription. version V2 batches events and is the recommended envelope. Output

delete

webhooks.delete Delete a webhook subscription; it cannot be restored Risk: destructive
Input Output

get

webhooks.get Read one webhook subscription by UUID Risk: read
Input Output

list

webhooks.list List webhook subscriptions with event type and status filters Risk: read
Input Output

update

webhooks.update Update a subscription name, URL or status Risk: write
Input Output