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).
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
ParamsAuthorization
Bearer {{ access_token | api_key }}Accept
application/jsoncontact_identifier_valuestringREQUIREDThe 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": []
}Code
Message
1003Invalid input.
60003Contact identifier not found.
60004Contact identifier inactive.
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-identifiersHeaders
Authorization
Bearer {{ access_token | api_key }}Accept
application/jsonBody
contact_identifier_valuestringREQUIREDThe unique value for the Contact Identifier, which will serve as the identifier.
contact_uuidstringOPTIONALThe 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_namestringOPTIONALA 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": []
}Code
Message
1003Invalid input.
55031Contact not found.
60006Contact identifier already exists.
Link Contact Identifier
Links an existing, unlinked Contact Identifier to an existing Contact.
PUT
https://api.piggy.eu/api//contact-identifiers/linkHeaders
Authorization
Bearer {{ access_token | api_key }}Accept
application/jsonBody
contact_identifier_valuestringREQUIREDThe unique value of the Contact Identifier that you want to link to the Contact.
contact_uuidstringREQUIREDThe 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": []
}Code
Message
1003Invalid input.
60003Contact identifier not found.
60004Contact identifier inactive.
55031Contact not found.
60014Contact identifier is already linked.
Unlink Contact Identifier
Removes a linked Contact from a Contact Identifier.
PUT
https://api.piggy.eu/api//contact-identifiers/unlinkHeaders
Authorization
Bearer {{ access_token | api_key }}Accept
application/jsonBody
contact_identifier_valuestringREQUIREDThe unique value of the Contact Identifier that you want to unlink the contact from.
Response Example
Show more
1
2
3
4
5
6
7
8
9
{
"data": {
"name": "Loyalty Card",
"value": "ABCDE12356-90",
"active": true,
"contact": null
},
"meta": []
}Code
Message
1003Invalid input.
60003Contact identifier not found.
60004Contact identifier inactive.
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-identifiersHeaders
Authorization
Bearer {{ access_token | api_key }}Accept
application/jsonBody
contact_identifier_valuestringREQUIREDThe unique value of the Contact Identifier.
contact_identifier_namestringOPTIONALA name for the Contact Identifier.
contact_identifier_activebooleanOPTIONALActive 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": []
}Code
Message
1003Invalid input.
55031Contact not found.
60006Contact identifier already exists.
Delete Contact Identifier
Deletes an Contact Identifier.
DELETE
https://api.piggy.eu/api//contact-identifiersHeaders
Authorization
Bearer {{ access_token | api_key }}Accept
application/jsonBody
contact_identifier_valuestringREQUIREDThe unique value of the Contact Identifier that you want to delete.
Code
Message
1003Invalid input.
60003Contact identifier not found.