LogRocket · Schema

UserIdentificationRequest

Request body for creating or updating user identification traits.

Session ReplayProduct AnalyticsFrontend MonitoringLoggingErrors

Properties

Name Type Description
name string The display name of the user.
email string The email address of the user.
traits object Custom key-value pairs representing user traits such as subscription type, revenue data, or product interest. Values will be converted to strings in the response.
View JSON Schema on GitHub

JSON Schema

logrocket-useridentificationrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserIdentificationRequest",
  "title": "UserIdentificationRequest",
  "type": "object",
  "description": "Request body for creating or updating user identification traits.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The display name of the user."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user."
    },
    "traits": {
      "type": "object",
      "description": "Custom key-value pairs representing user traits such as subscription type, revenue data, or product interest. Values will be converted to strings in the response.",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "integer"
          },
          {
            "type": "boolean"
          }
        ]
      }
    }
  }
}