Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.

Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search



This method is intended for identifying a Contact based on user data values. If one or more Contact is found, the Contact identifiers are returned. If no matching Contact is found, a new Contact may be created.


  • POST /Contact/Identify/



Key ValueType Value Description Mandatory Unique Default
ReturnUnique String true or false If more than 1 contact is found, and ReturnUnique is true, UCS won't return a sublist of found contact Ids false true false
CreateContact String true or false false true Get creation strategy from Media configuration if any, otherwise, use true
UpdateUserData String false true


Key ValueType Value Description Mandatory Unique Default
TenantId Integer true true



Key ValueType Value Description Mandatory Unique Default
NumberOfContactsFound Integer Number of matching Contacts. Cannot be superior to 1 if "CreateContact" parameter is true. Cannot be higher than the configured schema/select-limit. true true
ContactIdList String List of matching Contact Ids. Contains (NumberOfContactsFound) Ids. false false
ContactCreated String true or false true if a Contact has been created as a result of this call true true
ContactId String Id of the matching Contact if unique false true
LastCalledAgent_EmployeeID String Agent who handled previous interaction false false
LastCalledAgent_TimeStamp String false false
PreferredAgent_EmployeeID String false false
EmailAddress String false false
PhoneNumber String false false
FirstName String false false
LastName String false false


FaultCode FaultString Description
201 Missing parameter 'SubscriberId' SubscriberId was not provided but is a required parameter.
921 SubscriberId '{0}' is invalid or not active. The provided SubscriberId is not valid.
This page was last edited on May 18, 2018, at 15:04.


Comment on this article:

blog comments powered by Disqus