Difference between revisions of "ATC/Current/SDK/Identify"

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 4: Line 4:
 
|Platform=PureEngage, PureConnect, PureCloud
 
|Platform=PureEngage, PureConnect, PureCloud
 
|TocName=identify
 
|TocName=identify
|Context=The <tt>identify</tt> method adds information to a customer.
+
|ComingSoon=No
 +
|Context=Learn how to use the <tt>identify</tt> method to add information to a customer record.
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
Line 10: Line 11:
 
|alignment=Vertical
 
|alignment=Vertical
 
|gif=No
 
|gif=No
|structuredtext=The <tt>identify</tt> method adds information to a customer.
+
|structuredtext=The <tt>identify</tt> method adds information to a customer record.  
 +
 
 +
{{NoteFormat|<tt>identify</tt> will affect the next web event sent via <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview}}</tt> or <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record}}</tt> method.}}
 
|fullwidth=No
 
|fullwidth=No
 +
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Signature
 
|sectionHeading=Signature
Line 19: Line 23:
 
|structuredtext=<tt>ac('identify', [loginId], [traits], [callback])</tt>
 
|structuredtext=<tt>ac('identify', [loginId], [traits], [callback])</tt>
 
|fullwidth=No
 
|fullwidth=No
 +
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Arguments
 
|sectionHeading=Arguments
Line 28: Line 33:
 
* [[#callback|callback]]
 
* [[#callback|callback]]
 
|fullwidth=No
 
|fullwidth=No
 +
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=login
 
|sectionHeading=login
Line 39: Line 45:
 
* Note: If loginId is null, the current identity will be cleared.
 
* Note: If loginId is null, the current identity will be cleared.
 
|fullwidth=No
 
|fullwidth=No
 +
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=traits
 
|sectionHeading=traits
Line 49: Line 56:
 
* Status: optional
 
* Status: optional
 
* Restrictions: A flat object with properties of type string, number, or boolean
 
* Restrictions: A flat object with properties of type string, number, or boolean
 +
 +
For more information about how to link different customer records together, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper|display text=Traits mapper.}}
 
|fullwidth=No
 
|fullwidth=No
 +
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=callback
 
|sectionHeading=callback
Line 60: Line 70:
 
* Status: optional
 
* Status: optional
 
|fullwidth=No
 
|fullwidth=No
 +
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 14:32, January 9, 2020

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

Learn how to use the identify method to add information to a customer record.

Description

The identify method adds information to a customer record.

Important
identify will affect the next web event sent via pageview or record method.

Signature

ac('identify', [loginId], [traits], [callback])

Arguments

login

  • Description: an Id that can be used to stitch customer identities together
  • Type: string/null
  • Status: required
  • Note: If loginId is null, the current identity will be cleared.

traits

  • Description: information about a customer
  • Type: object
  • Status: optional
  • Restrictions: A flat object with properties of type string, number, or boolean

For more information about how to link different customer records together, see Traits mapper.

callback

  • Description: callback
  • Type: function
  • Status: optional
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Identify (2025-07-26 12:43:07)"
Comments or questions about this documentation? Contact us for support!