openapi: 3.0.1
info:
  title: HubSpot Conversations Visitor Identification
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: PROFESSIONAL
    sales: PROFESSIONAL
    service: PROFESSIONAL
    cms: PROFESSIONAL
    commerce: PROFESSIONAL
    crmHub: PROFESSIONAL
    dataHub: PROFESSIONAL
servers:
- url: https://api.hubapi.com
tags:
- name: Basic
paths:
  /visitor-identification/2026-09/tokens/create:
    post:
      tags:
      - Basic
      summary: Generate visitor token
      description: Generate an identification token for a website visitor who has been authenticated using
        your own system. An identification token returned from this API can be used to pass information
        about your already-authenticated visitor to the chat widget, so that it treats the visitor as
        a known contact. This allows support agents to recognize and assist the visitor more effectively.
      operationId: post-/visitor-identification/2026-09/tokens/create_generateToken
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentificationTokenGenerationRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentificationTokenResponse'
        default:
          description: ''
          $ref: '#/components/responses/Error'
      security:
      - oauth2:
        - conversations.visitor_identification.tokens.create
components:
  schemas:
    Error:
      required:
      - category
      - correlationId
      - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}'
        correlationId:
          type: string
          description: A unique identifier for the request. Include this value with any error reports
            or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: A map of link names to associated URIs containing documentation about the error
            or recommended remediation steps
        message:
          type: string
          description: A human readable message describing the error along with remediation steps where
            appropriate
          example: An error occurred
        subCategory:
          type: string
          description: A specific category that contains more specific detail about the error
      description: Represents an error response returned by the API when an operation fails. This component
        is used in various endpoints to provide detailed information about the error encountered.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
      - message
      type: object
      properties:
        code:
          type: string
          description: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: A human readable message describing the error along with remediation steps where
            appropriate
        subCategory:
          type: string
          description: A specific category that contains more specific detail about the error
      description: Represents detailed information about an error that occurred in the API. This component
        is used to provide additional context and specifics about errors, typically as part of an error
        response.
    IdentificationTokenGenerationRequest:
      required:
      - email
      - hsCustomerAgentContext
      type: object
      properties:
        email:
          type: string
          description: The email of the visitor that you wish to identify
        firstName:
          type: string
          description: 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:
          type: object
          additionalProperties:
            type: string
        lastName:
          type: string
          description: 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.
    IdentificationTokenResponse:
      required:
      - token
      type: object
      properties:
        token:
          type: string
          description: An identification token that allows the visitor to be treated as a known contact.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    developer_hapikey:
      type: apiKey
      name: hapikey
      in: query
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            conversations.visitor_identification.tokens.create: ''
    private_apps:
      type: apiKey
      name: private-app
      in: header
    private_apps_legacy:
      type: apiKey
      name: private-app-legacy
      in: header
x-hubspot-available-client-libraries:
- Node
- Python
- Ruby
- PHP
x-hubspot-product-tier-requirements:
  marketing: PROFESSIONAL
  sales: PROFESSIONAL
  service: PROFESSIONAL
  cms: PROFESSIONAL
  commerce: PROFESSIONAL
  crmHub: PROFESSIONAL
  dataHub: PROFESSIONAL