Reference

Get Contact Auth Token

Retrieves a secure authentication token for a specific contact, enabling you to verify their identity and perform protected operations on their behalf.

Update Bookings

Modify the details of an existing booking in Piggy, including party size, status, and company name. Use this when you need to adjust reservation information after the booking has been created.

Update Contact Identifiers

Modify how a contact identifier appears in your system by updating its display name or toggling its active status, without changing the underlying identifier value itself.

Claim Anonymous Contact

Convert anonymous contacts into verified customer records by associating them with real email addresses, enabling you to follow up with and nurture actual leads.

Create Contact Attribute

Allows you to create custom fields for your contacts to capture information specific to your business needs beyond standard contact data.

Merge Contacts

Consolidates duplicate customer records by merging a source contact into a destination contact, transferring all associated data like attributes, balances, and transaction history while removing the source record.

Send Contact Verification Email

Sends a verification email to a contact in Piggy to confirm their identity and grant them access to your Contacts Portal. Use this to secure your customer communications and ensure only verified contacts can access sensitive information.

Get Contact's Credit Balance

Check how much credit a contact currently has available in your system. This helps you determine eligibility for rewards, discounts, or other credit-based offers before processing transactions.

Create Credit Reception

Award credits to your customers based on purchases or fixed amounts, helping you build loyalty and encourage repeat business.

List Forms

Retrieve all forms available in your Piggy account to see what customer interaction tools you have set up. Use this when you need to find specific forms or audit your existing form collection.

List Perks

Retrieve all available perks that can be offered to your customers or associated with their transactions and profiles. This helps you understand what rewards and incentives are available to engage and retain customers.

Find or Create Products

Automatically finds an existing product in your Piggy loyalty system by its external identifier, or creates it if it doesn't exist, ensuring your product catalog stays synchronized for rewards and loyalty programs.

Create Vouchers Batch

Generate multiple vouchers simultaneously for a promotional campaign, with batch processing handled asynchronously to save time versus creating them individually.

Find Voucher By Code

Retrieve detailed information about a specific voucher using its code, including redemption status and validity. Useful for validating voucher codes and checking their current availability before processing transactions.