Amplitude · JSON Structure

User Mapping Api User Map Request Structure

UserMapRequest schema from Amplitude User Mapping API

Type: object Properties: 1 Required: 1
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

UserMapRequest is a JSON Structure definition published by Amplitude, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

mapping

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-structure/user-mapping-api-user-map-request-structure.json",
  "name": "UserMapRequest",
  "description": "UserMapRequest schema from Amplitude User Mapping API",
  "type": "object",
  "properties": {
    "mapping": {
      "type": "array",
      "description": "An array of user mapping objects, each mapping a global_user_id to one or more user_ids.",
      "items": {
        "type": "object",
        "required": [
          "global_user_id",
          "user_id"
        ],
        "properties": {
          "global_user_id": {
            "type": "string",
            "description": "The primary user ID that other identities will be mapped to."
          },
          "user_id": {
            "type": "string",
            "description": "The user ID to map to the global_user_id."
          },
          "unmap": {
            "type": "boolean",
            "description": "When true, removes the mapping instead of creating it."
          }
        }
      }
    }
  },
  "required": [
    "mapping"
  ]
}