Identify API call Example
POST https://api2.amplitude.com/identify
Keys for the Identification Argument
| Key | Type | Description |
|---|---|---|
| user_id | string | (required unless deviceid is present) A UUID (unique user ID) specified by you. *Note: If you send a request with a userid that is not in the Amplitude system yet, then the user tied to the user_id will not be marked new until their first event.* |
| device_id | string | (required unless user_id is present) A device specific identifier, such as the Identifier for Vendor (IDFV) on iOS. |
| user_properties | dictionary | A dictionary of key-value pairs that represent additional data tied to the user. Each distinct value will show up as a user segment on the Amplitude dashboard. Object depth may not exceed 40 layers. Note: You can store property values in an array and date values are transformed into string values.0 |
| groups | string | (Enterprise only) This feature is only available to Enterprise customers who have purchased the Accounts add-on. A dictionary of key-value pairs that represent groups of users. See this excerpt in our Javascript SDK for more information on groups. Setting groups will allow you to use our account-level reporting feature. Note: You can only track up to 5 unique group types and 10 total groups. Any groups past that threshold will not be tracked. |
| app_version | string | What version of the app the user is on. |
| platform1 | string | What platform is sending the data. |
| os_name1 | string | What mobile operating system or browser the user is on. |
| os_version1 | string | What version of the mobile operating system or browser the user is on. |
| device_brand1 | string | What device brand the user is on. |
| device_manufacturer1 | string | What device manufacturer the user is on. |
| device_model1 | string | What device model the user is on. |
| carrier1 | string | What carrier the user has. |
| country2 | string | What country the user is in. |
| region2 | string | What geographical region the user is in. |
| city2 | string | What city the user is in. |
| dma2 | string | The Designated Market Area of the user. |
| language | string | What language the user has set. |
| paying | string | Whether the user is paying or not. |
| start_version | string | What version of the app the user was first on. |
Request Body
[{"name"=>"api-key", "value"=>"{{api_key}}", "datatype"=>"string"}, {"name"=>"identification", "value"=>"[{\"user_id\":\"value\", \"user_properties\":{\"propertyNameToUpdate\":\"newValue\"}}]", "datatype"=>"string"}]
RESPONSES
status: OK
"success"