Group Identify API

(Enterprise only) This feature is only available to Growth and Enterprise customers who have purchased the Accounts add-on.

Use the Group Identify API to set or update properties of particular groups. However, these updates will only affect events going forward. 

Endpoint

Request Format - GroupIdentify

Send a POST or GET request to https://api2.amplitude.com/groupidentify with two request parameters:

Required ArgumentDescription
api_keyAPI Key from your project's Settings page. 040062a5d38552315b98302ba4f2f
identificationEither a single JSON identification object (see below for fields) or an array of JSON objects, each of which represents one identification. See below for examples.

Keys for the Group Identification Argument

The following keys can be sent within the JSON identification object.

Example Request

KeyTypeDescriptionExample
group_typestringThe type of group being identified"plan"
group_valuestringThe name of the group being identified"enterprise"
group_propertiesdictionaryA dictionary of key-value pairs that represent data tied to the groups.1, 2{"company_size": "500-1000"}

1This field supports the following group property operations:

OperationDescription
$setset the value of a property
$setOnceset the value of a property, prevent overriding the property value
$addadd a numeric value to a numeric property
$append and $prependappend and prepend the value to a group property array
$unsetremove a property
curl --data 'api_key=040062a5d38552315b98302ba4f2f'\
  --data 'identification=[{ \
    "group_type":"account_name", "group_value":"Amplitunes", "group_properties": \
    {"company_size":"500-1000"}}]' https://api.amplitude.com/groupidentify
Add example request: 

curl --data 'api_key= Api key' --data 'identification=[{"group_type":"account_name", "group_value":"Amplitunes", "group_properties": {"company_size":"500-1000"}}]' https://api.amplitude.com/groupidentify

These should be keys in the dictionary where the values are the corresponding properties that you want to operate on.
Note: You should not mix group property operations with actual top-level user properties; instead, include them inside the "$set" operation.
{"$set": {"company_size": "500-1000"}, "$setOnce": {"startDate": "2015-10-01"}, "$unset": {"account_status": "-"}}

2You can store property values in an array and date values are transformed into string values.


Did this page help you?