Create Group

POST https://api2.amplitude.com/groupidentify?api_key={{api_key}}&identification={"group_properties":{ },"group_value":" ","group_type":" "}

Keys for the Identification Argument

KeyTypeDescriptionExample
group_typestringOne type of group (e.g. account or company).org name, org id
group_valuestringOne specific value of the group_type.
group_type:org id,group_value:12345678 or group_type:account name,group_value:Acme Corp
group_propertiesstringA dictionary of key-value pairs that represent additional data tied to the group. Each distinct value will show up as a group segment on the Amplitude dashboard.

Note: You can store property values in an array, and date values are transformed into string values. In addition, group property operations ($set, $setOnce, $add, $append, $unset) are supported in this Group Identify API.

{arr: 10000, cs: [Justin, Ben], renewal_date: “01/01/2018" }

group_properties supports these 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

Request Params

KeyDatatypeRequiredDescription
api_keystringYour API key.
identificationstringEither a single JSON identification object or an array of JSON objects, each of which represents one identification. See below for examples.

RESPONSES

status: OK

"success"