Product Fruits · Schema

Identify User Request

Request body for creating or updating a tracked user in Product Fruits

Product AdoptionUser OnboardingIn-App GuidanceChecklistsNPS SurveysAnnouncementsUser SegmentationSaaS

Properties

Name Type Description
user object
View JSON Schema on GitHub

JSON Schema

identify-user-request.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.productfruits.com/schemas/identify-user-request",
  "title": "Identify User Request",
  "description": "Request body for creating or updating a tracked user in Product Fruits",
  "type": "object",
  "required": ["user"],
  "properties": {
    "user": {
      "type": "object",
      "required": ["username"],
      "properties": {
        "username": {
          "type": "string",
          "description": "Unique identifier for the user. Must be unique across the workspace."
        },
        "firstname": {
          "type": "string",
          "description": "User's first name"
        },
        "lastname": {
          "type": "string",
          "description": "User's last name"
        },
        "role": {
          "type": "string",
          "description": "User's role within their organization"
        },
        "signUpAt": {
          "type": "string",
          "format": "date-time",
          "description": "ISO 8601 date-time when the user signed up"
        },
        "props": {
          "type": "object",
          "description": "Custom user properties for segmentation and targeting",
          "additionalProperties": {
            "oneOf": [
              { "type": "number" },
              { "type": "boolean" },
              { "type": "string" },
              { "type": "array" }
            ]
          }
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}