Solved

Identify API Groups documentation is unclear

  • 18 November 2022
  • 3 replies
  • 181 views

Userlevel 1
Badge

In the Identify API docs it states

groups: String. 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.

Which type is groups: String or dictionary?

 

icon

Best answer by jmagg 30 November 2022, 20:30

View original

3 replies

Userlevel 5
Badge +6

Hi @michael.kuhl - great attention to detail & great question. I’ve tried every combo of strings & dictionaries with a colleagues to test, but I was unable to find the answer. I’ve reached out to our Engineering team for assistance. I’ll be sure to let you know as soon as I hear from them!

Userlevel 5
Badge +6

Hi @michael.kuhl -- appreciate your patience. Here’s what Engineering said:

groups should be a dictionary (map). And for each key-value pair inside this map, the value could be a string or an array of strings.

here are some examples we used in test code:
"groups":{"Department":["Engineering"]}
"groups":{"company_id":"1","company_name":["Test","Test 2"]}

I hope this helps!

Userlevel 1
Badge

Thanks @jmagg - This helps!

Reply