Contents

role

A string that identifies a customer’s role for a product within a group.

Declaration

string role

Possible Values

NONE

The customer has a seat in the group but doesn’t administer it.

ADMIN

The customer administers the group for the product.

Mentioned in

Discussion

Each RoleEntry that the Get Customer Groups endpoint returns includes a role for a single productId. A customer can hold a different role for each of your products within the same group.

Roles apply only to a group with a groupType of ORGANIZATION. A group with a groupType of CONSUMER doesn’t report roles.

This value is informational. Determine access to content based on the customer’s transactions. Use role if you want to offer an administrator something the other members don’t get, such as naming the team or configuring an experience for the whole group.

See Also

Group membership