update_contact
Update Contact
Update a contact's attributes such as name, phone, birthdate, or any custom attributes. System-managed values like credit balance and creation date cannot be updated through this tool.
update_contact
Update a contact's attributes such as name, phone, birthdate, or any custom attributes. System-managed values like credit balance and creation date cannot be updated through this tool.
delete_contact
Delete a contact from the loyalty system. Supports standard deletion or GDPR-compliant deletion which ensures full data removal. This is an asynchronous operation.
list_contacts
List loyalty program contacts with filtering and pagination. Use this to browse contacts, find recently created contacts, or retrieve a paginated list of all contacts in the system.
create_contact
Create a new contact in the loyalty system. Supports creating a contact by email, finding or creating by email (idempotent), or creating an anonymous contact. Use **findOrCreate** mode to avoid duplicates.
manage_giftcards
Create, list, get, and find gift cards. Also supports creating transactions (adding/deducting balance) on gift cards. Gift cards are anonymous and not linked to contacts.
list_rewards
List available rewards in the loyalty program. Optionally filter by shop or contact to see which rewards are claimable by a specific contact.
list_loyalty_transactions
List loyalty transactions including credit receptions and reward receptions. Filter by contact, shop, type, and date range to track credit activity.
get_loyalty_program
Retrieve the loyalty program configuration including program name, max credit amount, custom credit name, and unit settings. Also lists available tiers and gift card programs.
list_shops
List all shops connected to the account. Shops represent physical locations or web shops and are required for many operations like awarding credits, redeeming vouchers, and gift card transactions.
manage_vouchers
Create, list, find, update, or redeem vouchers. Vouchers are tied to promotions and can be assigned to contacts. Use this tool to manage the entire voucher lifecycle.
manage_prepaid
Manage a contact's prepaid balance. Create transactions to top up or deduct from prepaid balance, list transaction history, or check current balance. Prepaid balances are linked directly to contacts.
manage_contact_identifiers
Create, find, link, or unlink contact identifiers. Contact identifiers are used to associate physical cards, QR codes, or other identifiers with contacts in the loyalty system.
list_promotions
List all promotions in the account. Promotions define voucher campaigns and are required when creating vouchers. Optionally retrieve a single promotion by UUID.
claim_reward
Claim a reward for a contact, deducting the required credits from their balance. Also supports reversing a previously claimed reward to restore credits.
get_contact
Retrieve a single contact by UUID or email address. Also returns the contact's credit balance, prepaid balance, tier, and identifiers in a single call.
trigger_automation
Trigger an automation run for a specific contact. Automations are workflows configured in the Piggy dashboard that can send emails, award credits, or perform other actions. Optionally list available automations.
award_credits
Award loyalty credits to a contact. Credits can be awarded directly by specifying a credit amount, or calculated from a unit value (e.g. purchase amount). Use this to reward customers for purchases or other activities.
Manage customer loyalty programs, rewards, gift cards, promotions, and vouchers. Create, update, and look up CRM contacts with custom attributes. Track loyalty credits and transactions, issue credit receptions, and manage credit balances. Create and redeem vouchers and promotions. Manage gift cards and prepaid balances. Configure rewards including digital and collectable types. Track orders, products, bookings, and visits. Manage shops, forms, automations, and portal sessions. Subscribe to webhooks for events including contact changes, credit receptions, voucher redemptions, gift card transactions, form submissions, and referrals.
Common questions about connecting Piggy to AI agents with Metorial.