FullStory · Schema

CreateUserRequest

Request body for creating or updating a user in FullStory

Session ReplayProduct AnalyticsDigital ExperienceBehavioral AnalyticsFrontend Monitoring

Properties

Name	Type	Description
uid	string	External user identifier. Omit to create an anonymous user.
display_name	string	The display name for the user
email	string	The email address for the user
properties	object	Custom key-value properties to attach to the user. Type suffixes are not required in v2 as types are inferred automatically.
schema	object	Optional explicit type declarations for custom properties to override the default type inference

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateUserRequest",
  "title": "CreateUserRequest",
  "type": "object",
  "description": "Request body for creating or updating a user in FullStory",
  "properties": {
    "uid": {
      "type": "string",
      "description": "External user identifier. Omit to create an anonymous user."
    },
    "display_name": {
      "type": "string",
      "description": "The display name for the user"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "The email address for the user"
    },
    "properties": {
      "type": "object",
      "description": "Custom key-value properties to attach to the user. Type suffixes are not required in v2 as types are inferred automatically.",
      "additionalProperties": true
    },
    "schema": {
      "type": "object",
      "description": "Optional explicit type declarations for custom properties to override the default type inference",
      "additionalProperties": true
    }
  }
}