Piggy Logo
Postman
Getting started
  • Overview
  • Migrate to v3 🚀
  • Testing
  • Error handling
  • Client Libraries
  • Webhooks
  • Loyalty Tokens
Guides
OAuth API
  • Authorization
  • Automations
  • Bookings
    NEW
  • Brand Kit
  • Collectable Rewards
  • Contacts
  • Contact Attributes
  • Contact Identifiers
  • Contact Subscriptions
  • Contact Verification
  • Contact Session Tokens
  • Contacts Portal
  • Credit Receptions
  • Custom Attributes
  • Forms
  • Giftcards
  • Giftcard Programs
  • Giftcard Transactions
  • Loyalty Program
  • Loyalty Tokens
  • Loyalty Transactions
  • Loyalty Transaction Attributes
  • Portal Sessions
  • Prepaid Transactions
  • Promotions
  • Promotion Attributes
  • Referrals
  • Rewards
  • Reward Attributes
  • Reward Receptions
  • Shops
  • Subscription Types
  • Tiers
  • Units
  • Vouchers
  • Visits
    NEW
  • Webhooks
Registers & POS API

Contact Identifiers

Mostly, Contacts are identified by their email address. However, Contact Identifiers can also be used to retrieve a Contact's information. Most current Contact Identifiers are Loyalty Cards, which have been around since the start of Piggy. However, if needed, virtually anything can be used as a Contact Identifier, provided they use a unique value (within the Account). Please contact us if you'd like to use anything aside from the standard Piggy Loyalty cards as a Contact Identifier.

Find Contact Identifier

Finds the Contact Identifier. Returns contactas null if not yet linked to a Contact.

GET
https://api.piggy.eu/api//contact-identifiers/find?contact_identifier_value={{contact_identifier_value}}
Headers
Authorization
Bearer {{ access_token | api_key }}
Accept
application/json
Params
contact_identifier_valuestring
REQUIRED
The unique value for the Contact Identifier.
Response Example
Show more
1 2 3 4 5 6 7 8 9 10 11 12 { "data": { "name": "Loyalty Card", "value": "ABCDE12356-90", "active": true, "contact": { "uuid": "123abc-def789-qwerty-34567", "email": "john@doe.com } }, "meta": [] }

Create Contact Identifier

Creates a Contact Identifier. You can link it directly to a Contact when you send a contact_uuid along.

POST
https://api.piggy.eu/api//contact-identifiers
Headers
Authorization
Bearer {{ access_token | api_key }}
Accept
application/json

Body

contact_identifier_valuestring
REQUIRED
The unique value for the Contact Identifier, which will serve as the identifier.
contact_uuidstring
OPTIONAL
The Contact's UUID for whom the identifier is to be created. If you want to link a contact later, you can leave this empty.
contact_identifier_namestring
OPTIONAL
A name for the Contact Identifier. When left out, it receives the same value as contact_identifier_value.
Response Example
Show more
1 2 3 4 5 6 7 8 9 10 11 12 { "data": { "name": "Loyalty Card", "value": "ABCDE12356-90", "active": true, "contact": { "uuid": "123abc-def789-qwerty-34567", "email": "john@doe.com } }, "meta": [] }

Link Contact Identifier

Links an existing, unlinked Contact Identifier to an existing Contact.

PUT
https://api.piggy.eu/api//contact-identifiers/link
Headers
Authorization
Bearer {{ access_token | api_key }}
Accept
application/json

Body

contact_identifier_valuestring
REQUIRED
The unique value of the Contact Identifier that you want to link to the Contact.
contact_uuidstring
REQUIRED
The Contact UUID that needs to be linked to the Contact Identifier.
Response Example
Show more
1 2 3 4 5 6 7 8 9 10 11 12 { "data": { "name": "Loyalty Card", "value": "ABCDE12356-90", "active": true, "contact": { "uuid": "123abc-def789-qwerty-34567", "email": "john@doe.com } }, "meta": [] }

Update Contact Identifier

Updates a Contact Identifier. Note: only the identifier's name and active properties can be updated. The value cannot be updated.

PUT
https://api.piggy.eu/api//contact-identifiers
Headers
Authorization
Bearer {{ access_token | api_key }}
Accept
application/json

Body

contact_identifier_valuestring
REQUIRED
The unique value of the Contact Identifier.
contact_identifier_namestring
OPTIONAL
A name for the Contact Identifier.
contact_identifier_activeboolean
OPTIONAL
Active state of the contact identifier.
Response Example
Show more
1 2 3 4 5 6 7 8 9 10 11 12 { "data": { "name": "Loyalty Card", "value": "ABCDE12356-90", "active": true, "contact": { "uuid": "123abc-def789-qwerty-34567", "email": "john@doe.com } }, "meta": [] }