Audience
Application audience APIs for user groups and attributes.
Operations
GET
# Get user attributes
PATCH
# Update user attributes
FDK Method Name: getUserAttributes
Retrieve user attributes for the current user. Filter by one or more slugs using the `slug` query parameter.
Parameters
slug
string
Filter by attribute slug(s). Repeat the parameter for multiple slugs.
oneOf Schema from below
Response
200
User attributes
UserAttributesDetail
attributes
object
Map of attribute slug to value. Values may be string, number, boolean, or array.
Examples
Parameters
slug:
"attribute-1"
Was this section helpful?
GET
Response
Get user attributes
getUserAttributes
FDK Method Name: updateUserAttributes
Update one or more user attributes for the current user.
- Pass `null` as the value for a slug to delete that attribute.
- Only `customer_editable` attributes may be updated.
- Values are validated against the attribute definition's type and validations.
- For encrypted attributes the stored value is encrypted server-side; the response echoes submitted values.
Parameters
No Parameters
Request body
attributes
object
Required
Map of attribute slug to value. Set to `null` to delete the attribute.
Values are validated against the attribute definition's type and validations.
Response
200
400
Updated attributes (echoes submitted values; encrypted attributes may appear encrypted)
UserAttributesDetail
attributes
object
Map of attribute slug to value. Values may be string, number, boolean, or array.
Examples
Parameters
body:
body
Was this section helpful?
PATCH
Response
Update user attributes
updateUserAttributes
Operations
GET
# Get user groups
GET
# Get group categories
FDK Method Name: getUserGroupsForUser
Retrieve the groups and categories the current user belongs to.
Parameters
No Parameters
Response
200
User groups
UserGroupsDetail
user_groups
object (UserGroups)
UserGroups
l1
array of integer
l2
array of integer
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Get user groups
getUserGroupsForUser
FDK Method Name: getUserGroupCategories
Retrieve the available group categories for the current application.
Parameters
No Parameters
Response
200
Categories
UserGroupCategoriesDetail
categories
array of object (UserGroupCategory)
Array of UserGroupCategory
name
string
key
string
Enum
description
string
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response