Amplitude · JSON Structure

Identify Api Identify Request Body Structure

IdentifyRequestBody schema from Amplitude Identify API

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

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

Properties

api_key identification

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/identify-api-identify-request-body-structure.json",
  "name": "IdentifyRequestBody",
  "description": "IdentifyRequestBody schema from Amplitude Identify API",
  "type": "object",
  "properties": {
    "api_key": {
      "type": "string",
      "description": "The API key for the Amplitude project."
    },
    "identification": {
      "type": "array",
      "description": "An array of identification objects containing user_id or device_id and user_properties.",
      "items": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "string",
            "description": "A readable ID specified by you. Required unless device_id is present."
          },
          "device_id": {
            "type": "string",
            "description": "A device-specific identifier. Required unless user_id is present."
          },
          "user_properties": {
            "$ref": "#/components/schemas/UserPropertyOperations"
          }
        }
      }
    }
  },
  "required": [
    "api_key",
    "identification"
  ]
}