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

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2")
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=identify
 
|DisplayName=identify
−
|Platform=GenesysEngage-onpremises, PureConnect, PureCloud
 
 
|TocName=identify
 
|TocName=identify
 +
|Context=Learn how to use the <tt>identify</tt> method to add information to a customer record.
 +
|Dimension=DevTracking
 
|ComingSoon=No
 
|ComingSoon=No
−
|Dimension=DevTracking
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
−
|Context=Learn how to use the <tt>identify</tt> method to add information to a customer record.
 
 
|Section={{Section
 
|Section={{Section
 +
|alignment=Vertical
 +
|structuredtext={{NoteFormat|On January 31, 2023, Genesys removed the functionality of the identify method that is used to add a customer record. For more information, see [https://rcstaging.wpengine.com/articles/deprecation-identify-journey-sdk-method/ Deprecation: identify journey SDK method].|}}{{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
 +
|Status=No
 +
}}{{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=The <tt>identify</tt> method adds information to a customer record.  
 
|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.}}
+
{{NoteFormat|<tt>identify</tt> affects the next web event sent using the <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Pageview}}</tt> or <tt>{{Link-SomewhereInThisVersion|manual=SDK|topic=Record}}</tt> method.|}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Signature
 
|sectionHeading=Signature
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=<tt>ac('identify', [loginId], [traits], [callback])</tt>
 
|structuredtext=<tt>ac('identify', [loginId], [traits], [callback])</tt>
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Arguments
 
|sectionHeading=Arguments
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=*[[#loginID|loginId]]
 
|structuredtext=*[[#loginID|loginId]]
 
*[[#traits|traits]]
 
*[[#traits|traits]]
 
*[[#callback|callback]]
 
*[[#callback|callback]]
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=login
 
|sectionHeading=login
 
|anchor=login
 
|anchor=login
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=*Description: an Id that can be used to stitch customer identities together
+
|structuredtext=*'''Description:''' ID used to stitch customer identities together
−
*Type: string/null
+
*'''Type:''' String/null
−
*Status: required
+
*'''Status:''' Required
−
*Note: If loginId is null, the current identity will be cleared.
+
*'''Note:''' If loginId is null, the current identity is cleared.
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=traits
 
|sectionHeading=traits
 
|anchor=traits
 
|anchor=traits
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=*Description: information about a customer
+
|structuredtext=*'''Description:''' Information about a customer
−
*Type: object
+
*'''Type:''' Object
−
*Status: optional
+
*'''Status:''' Optional
−
*Restrictions: A flat object with properties of type string, number, or boolean
+
*'''Restrictions:''' 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.}}
+
For more information about how to link different customer records, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper|display text=Traits mapper.}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=callback
 
|sectionHeading=callback
 
|anchor=callback
 
|anchor=callback
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=*Description: callback
+
|structuredtext=*'''Description:''' Callback
−
*Type: function
+
*'''Type:''' Function
−
*Status: optional
+
*'''Status:''' Optional
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 07:15, February 3, 2023

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.

Important
On January 31, 2023, Genesys removed the functionality of the identify method that is used to add a customer record. For more information, see Deprecation: identify journey SDK method.
Important
This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.

Description

The identify method adds information to a customer record.

Important
identify affects the next web event sent using the pageview or record method.

Signature

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

Arguments

login

  • Description: ID used to stitch customer identities together
  • Type: String/null
  • Status: Required
  • Note: If loginId is null, the current identity is cleared.

traits

  • Description: Information about a customer
  • Type: Object
  • Status: Optional
  • Restrictions: Flat object with properties of type string, number, or Boolean

For more information about how to link different customer records, 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:44:20)"
Comments or questions about this documentation? Contact us for support!