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.
https://api.piggy.eu/api//contact-identifiers/find?contact_identifier_value={{contact_identifier_value}}Bearer {{ access_token | api_key }}application/jsoncontact_identifier_valuestringREQUIRED1
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": []
}Code
Message
10036000360004Create Contact Identifier
Creates a Contact Identifier. You can link it directly to a Contact when you send a contact_uuid along.
https://api.piggy.eu/api//contact-identifiersBearer {{ access_token | api_key }}application/jsonBody
contact_identifier_valuestringREQUIREDcontact_uuidstringOPTIONALcontact_identifier_namestringOPTIONAL1
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": []
}Code
Message
10035503160006Link Contact Identifier
Links an existing, unlinked Contact Identifier to an existing Contact.
https://api.piggy.eu/api//contact-identifiers/linkBearer {{ access_token | api_key }}application/jsonBody
contact_identifier_valuestringREQUIREDcontact_uuidstringREQUIRED1
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": []
}Code
Message
100360003600045503160014Unlink Contact Identifier
Removes a linked Contact from a Contact Identifier.
https://api.piggy.eu/api//contact-identifiers/unlinkBearer {{ access_token | api_key }}application/jsonBody
contact_identifier_valuestringREQUIRED1
2
3
4
5
6
7
8
9
{
"data": {
"name": "Loyalty Card",
"value": "ABCDE12356-90",
"active": true,
"contact": null
},
"meta": []
}Code
Message
10036000360004Update Contact Identifier
Updates a Contact Identifier. Note: only the identifier's name and active properties can be updated. The value cannot be updated.
https://api.piggy.eu/api//contact-identifiersBearer {{ access_token | api_key }}application/jsonBody
contact_identifier_valuestringREQUIREDcontact_identifier_namestringOPTIONALcontact_identifier_activebooleanOPTIONAL1
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": []
}Code
Message
10035503160006Delete Contact Identifier
Deletes an Contact Identifier.
https://api.piggy.eu/api//contact-identifiersBearer {{ access_token | api_key }}application/jsonBody
contact_identifier_valuestringREQUIREDCode
Message
100360003