FullContact provides the ability to store, manage and extract by certain customer segments/tags. This feature allows customers tags to be stored within a customer’s Identity Streme for continuous updates, retrievals and deletes across both 1st party as well as 2nd party data partnerships.
By default, on all Resolve responses customer tags are disabled. Should you wish to enable this feature and have customer tags included you may include this as a query paramenter in the Resolve request.
curl -X POST https://api.fullcontact.com/v3/identity.resolve?tags=true \-H "Authorization: Bearer {Your API Key}" \-H "Content-Type: application/json" \-d '{"recordId": "customer123"}'
Once a Customer Record ID has been mapped customer tags can continue to be added to the originally provided Record ID.
Example Retrieve Creation Request
curl -X POST https://api.fullcontact.com/v3/tags.create \-H "Authorization: Bearer {Your API Key}" \-H "Content-Type: application/json" \-d '{"recordId": "customer123","tags": [{ "key" : "loyalty", "value" : "true" }]}'
This endpoint will return all client-driven customer tags that have been previously associated with and mapped to an individual.
Example Retrieve Tags Request
curl -X POST https://api.fullcontact.com/v3/tags.get \-H "Authorization: Bearer {Your API Key}" \-H "Content-Type: application/json" \-d '{"recordId": "customer123"}'
Example Retrieval Tags Response:
{"tags": [{ "key" : "segment", "value" : "highspender" },{ "key" : "loyalty", "value" : "true" },{ "key" : "homepage", "value" : "true" }]}
This endpoint will remove specific or all customer tags that are attached to an individual.
Example of Customer Tags Deletion Request
curl -X POST https://api.fullcontact.com/v3/tags.delete \-H "Authorization: Bearer {Your API Key}" \-H "Content-Type: application/json" \-d '{"recordId": "customer123","tags": [{ "key" : "segment", "value" : "highspender" },{ "key" : "segment", "value" : "clothing" },{ "key" : "homepage", "value" : "true" }]}'
Example of Customer Tags Deletion Response
{"status": 204,"message": "No content"}
Customers can use these endpoints in order to obtain multiple individuals based upon the key, value tag inputs (both are required as input) in order to suppress or take action upon certain audiences for data onboarding or audience analysis. Any newly created tags will not be available to use for audience creation for approximately 24hrs.
The Audience Creation endpoint requires a valid webhook URL to be present in order to send a message when the audience creation is complete and ready to be downloaded.
The output of the Audience Download endpoint will contain FullContact PIDs, Hashed Emails and MAIDs based upon the input tag filters separated out by 1st Party and 2nd Party Data partners if participating in Identity Streme Sharing. A customer will receive this output as part of a JSON Gzip response within 24hrs. Should you want to learn more about obtaining 2nd Party Data check out Identity Streme Sharing.
Example of Audience Creation Request
curl -X POST https://api.fullcontact.com/v3/audience.create \-H "Authorization: Bearer {Your API Key}" \-H "Content-Type: application/json" \-d '{"webhookUrl":"http://www.fullcontact.com/hook","tags": [{ "key" : "segment", "value" : "highspender" },{ "key" : "homepage", "value" : "true" }]}'
Example of Audience Creation Response
{"result": {"message": "The Audience Query was completed successfully\n\nPlease download the result from https://api.fullcontact.com/v3/audience.download?requestId=97b7d8b1-757b-4400-8846-0ec47e8f8f56\nThe query result will be available for 30 days for download.\nFullContact Audience Team","downloadUrl": "https://api.fullcontact.com/v3/audience.download?requestId=97b7d8b1-757b-4400-8846-0ec47e8f8f56"},"webhookId": "89aba154-22fb-42fc-a836-b98f5b4e74b7"}
Example of Audience Download
https://api.fullcontact.com/v3/audience.download?requestId=97b7d8b1-757b-4400-8846-0ec47e8f8f56
If you want to learn more about how storing and leveraging customer tags can help your business please contact our Sales team.