HubSpot: Visitor identification schemas

← Visitor identification operations · All schemas

Generate visitor token — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email of the visitor that you wish to identify
firstName	string	Optional	The first name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where first name is unknown. Optional.
hsCustomerAgentContext	object	Required within parent	An object containing additional context about the customer agent. This field is required and can include various string properties. Additional keys: see wildcard field
hsCustomerAgentContext.*	string	Additional keys
lastName	string	Optional	The last name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where last name is unknown. Optional.

Generate visitor token — response body

Field	Type	Presence	Description and constraints
$	object	Root
token	string	Required within parent	An identification token that allows the visitor to be treated as a known contact.