Audience

Manage user groups and user attributes for a company application.

UserAttribute

User attribute definition and assignment operations.

Operations

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions

# List attribute definitions

POST

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions

# Create attribute definition

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}

# Get attribute definition

PUT

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}

# Update attribute definition

DEL

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}

# Delete attribute definition

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}/value-suggestions

# Get attribute definition value suggestions

PATCH

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes

# Bulk update attributes

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes

# List user attributes

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes/{definition_id}

# Get user attribute by definition

PUT

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes/{definition_id}

# Create or update user attribute

DEL

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes/{definition_id}

# Delete user attribute

GET

List attribute definitions

FDK Method Name: getUserAttributeDefinitions

Requires application/customers/read access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

page_no

integer

page_size

integer

name

string

slug

string

Filter by slug.

type

string

customer_editable

boolean

encrypted

boolean

pinned

boolean

is_locked

boolean

Response

200

List of definitions

UserAttributeDefinitionListDetail

items

array of object (UserAttributeDefinition)

Array of UserAttributeDefinition

_id

string

name

string

slug

string

description

string

type

string

validations

array of object (UserAttributeValidation)

Array of UserAttributeValidation

type

string

Enum

value

string

oneOf Schema from below

default_value

string

Nullable

oneOf Schema from below

encrypted

boolean

value_suggestions_enabled

boolean

Suggestions are available only for `string` and `string_array` definitions. Encrypted definitions return no suggestions.

Default Value : false

pinned

boolean

pin_order

number

customer_editable

boolean

is_locked

boolean

created_at

string

| date-time

modified_at

string

| date-time

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

page

object (PageNumber)

PageNumber

type

string

current

integer

size

integer

item_total

integer

has_next

boolean

has_previous

boolean

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions

Response

POST

Create attribute definition

FDK Method Name: createUserAttributeDefinition

Requires application/customers/write access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

Request body

name

string

Required

slug

string

Required

description

string

Required

type

string

Required

Enum

value_suggestions_enabled

boolean

Suggestions are available only for `string` and `string_array` definitions.

Default Value : false

Response

201

400

Definition created

UserAttributeDefinition

_id

string

name

string

slug

string

description

string

type

string

validations

array of object (UserAttributeValidation)

Array of UserAttributeValidation

type

string

Enum

value

string

oneOf Schema from below

default_value

string

Nullable

oneOf Schema from below

encrypted

boolean

value_suggestions_enabled

boolean

Suggestions are available only for `string` and `string_array` definitions. Encrypted definitions return no suggestions.

Default Value : false

pinned

boolean

pin_order

number

customer_editable

boolean

is_locked

boolean

created_at

string

| date-time

modified_at

string

| date-time

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

body:

body

Was this section helpful?

POST

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions

Response

GET

Get attribute definition

FDK Method Name: getUserAttributeDefinitionById

Requires application/customers/read access scope.

Parameters

company_id

string

Required

application_id

string

Required

definition_id

string

Required

Attribute definition identifier.

Response

200

404

Definition

UserAttributeDefinition

_id

string

name

string

slug

string

description

string

type

string

validations

array of object (UserAttributeValidation)

Array of UserAttributeValidation

type

string

Enum

value

string

oneOf Schema from below

default_value

string

Nullable

oneOf Schema from below

encrypted

boolean

value_suggestions_enabled

boolean

Suggestions are available only for `string` and `string_array` definitions. Encrypted definitions return no suggestions.

Default Value : false

pinned

boolean

pin_order

number

customer_editable

boolean

is_locked

boolean

created_at

string

| date-time

modified_at

string

| date-time

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

definition_id:

"64f666666666666666666666"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}

Response

PUT

Update attribute definition

FDK Method Name: updateUserAttributeDefinition

Requires application/customers/write access scope.

Parameters

company_id

string

Required

application_id

string

Required

definition_id

string

Required

Request body

name

string

description

string

type

string

Enum

value_suggestions_enabled

boolean

Enable or disable suggestions. Allowed only for `string` and `string_array` definitions.

customer_editable

boolean

Response

200

400

404

Definition details

UserAttributeDefinition

_id

string

name

string

slug

string

description

string

type

string

validations

array of object (UserAttributeValidation)

Array of UserAttributeValidation

type

string

Enum

value

string

oneOf Schema from below

default_value

string

Nullable

oneOf Schema from below

encrypted

boolean

value_suggestions_enabled

boolean

Suggestions are available only for `string` and `string_array` definitions. Encrypted definitions return no suggestions.

Default Value : false

pinned

boolean

pin_order

number

customer_editable

boolean

is_locked

boolean

created_at

string

| date-time

modified_at

string

| date-time

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

definition_id:

"64f888888888888888888888"

body:

body

Was this section helpful?

PUT

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}

Response

DEL

Delete attribute definition

FDK Method Name: deleteUserAttributeDefinitionById

Requires application/customers/write access scope.

Parameters

company_id

string

Required

application_id

string

Required

definition_id

string

Required

Response

200

400

404

Deleted

DeleteDetail

message

string

success

boolean

oneOf Schema from below

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

definition_id:

"64f777777777777777777777"

Was this section helpful?

DEL

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}

Response

GET

Get attribute definition value suggestions

FDK Method Name: getUserAttributeDefinitionValueSuggestions

Returns stored value suggestions for definitions that have `value_suggestions_enabled` enabled. Suggestions are available only for `string` and `string_array` definitions, and encrypted definitions return no suggestions.

Requires application/customers/read access scope.

Parameters

company_id

string

Required

application_id

string

Required

definition_id

string

Required

string

Filter suggestions by a case-insensitive substring match; the term can appear anywhere in the stored value, not just at the start.

limit

integer

| value >= 1

| value <= 500

Maximum number of suggestions to return.

Default Value : 20

Response

200

404

Value suggestions

UserAttributeValueSuggestionsDetail

items

array of string

Suggested attribute values.

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

definition_id:

"64f666666666666666666666"

"go"

limit:

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes/definitions/{definition_id}/value-suggestions

Response

PATCH

Bulk update attributes

FDK Method Name: bulkUpdateUserAttributes

Requires application/customers/write access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

Request body

users

array of string

rr_ids

array of string

rr_ids resolved to user_ids; may be combined with `users` (MODE 3).

Minimum Items : 1

user_attributes

array of object (BulkUserAttributesUserDetail)

Array of BulkUserAttributesUserDetail

user_id

string

rr_id

string

Reliance Retail ID, resolved to a user_id. Used when `user_id` is absent.

attributes

array of object (UserAttributeKeyValue)

Array of UserAttributeKeyValue

key

string

value

string

Nullable

oneOf Schema from below

file_url

string

| uri

attributes

array of object (BulkUpdateAttributeItem)

Array of BulkUpdateAttributeItem

key

string

Required

value

string

Required

oneOf Schema from below

Response

202

400

Async update queued

BulkUserAttributesQueuedDetail

success

boolean

message

string

processing_type

string

Enum

job_id

string

status_code

integer

Enum

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

body:

body

Was this section helpful?

PATCH

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/attributes

Response

GET

List user attributes

FDK Method Name: getUserAttributesForUser

Requires application/customers/read access scope.

Parameters

id_type

string

How to interpret the `user_id` path segment. When `rr_id`, it is treated as a Reliance Retail ID and resolved to the user (unknown rr_id yields 404). Defaults to `user_id`.

Default Value : user_id

Enum

company_id

string

Required

application_id

string

Required

user_id

string

Required

type

string

name

string

page_no

integer

page_size

integer

Response

200

List of user attributes

UserAttributeListDetail

items

array of object (UserAttribute)

Array of UserAttribute

_id

string

application_id

string

user_id

string

user_attribute_definition_id

string

attribute

object (UserAttributeKeyValue)

UserAttributeKeyValue

key

string

value

string

Nullable

oneOf Schema from below

type

string

updated_by

string

customer_overridden

boolean

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

page

object (PageNumber)

PageNumber

type

string

current

integer

size

integer

item_total

integer

has_next

boolean

has_previous

boolean

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

user_id:

"64f222222222222222222222"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes

Response

GET

Get user attribute by definition

FDK Method Name: getUserAttributeById

Requires application/customers/read access scope.

Parameters

id_type

string

How to interpret the `user_id` path segment. When `rr_id`, it is treated as a Reliance Retail ID and resolved to the user (unknown rr_id yields 404). Defaults to `user_id`.

Default Value : user_id

Enum

company_id

string

Required

application_id

string

Required

user_id

string

Required

definition_id

string

Required

Response

200

404

User attribute details

UserAttribute

_id

string

application_id

string

user_id

string

user_attribute_definition_id

string

attribute

object (UserAttributeKeyValue)

UserAttributeKeyValue

key

string

value

string

Nullable

oneOf Schema from below

type

string

updated_by

string

customer_overridden

boolean

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

user_id:

"64f222222222222222222222"

definition_id:

"64f666666666666666666666"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes/{definition_id}

Response

PUT

Create or update user attribute

FDK Method Name: updateUserAttribute

Requires application/customers/write access scope.

Parameters

id_type

string

How to interpret the `user_id` path segment. When `rr_id`, it is treated as a Reliance Retail ID and resolved to the user (unknown rr_id yields 404). Defaults to `user_id`.

Default Value : user_id

Enum

company_id

string

Required

application_id

string

Required

user_id

string

Required

definition_id

string

Required

Request body

attribute

object (UserAttributeValue)

Required

UserAttributeValue

value

object

Required

The attribute value

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Response

201

400

404

Created attribute

UserAttribute

_id

string

application_id

string

user_id

string

user_attribute_definition_id

string

attribute

object (UserAttributeKeyValue)

UserAttributeKeyValue

key

string

value

string

Nullable

oneOf Schema from below

type

string

updated_by

string

customer_overridden

boolean

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

user_id:

"64f222222222222222222222"

definition_id:

"64f888888888888888888888"

body:

body

Was this section helpful?

PUT

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes/{definition_id}

Response

DEL

Delete user attribute

FDK Method Name: deleteUserAttribute

Requires application/customers/write access scope.

Parameters

id_type

string

How to interpret the `user_id` path segment. When `rr_id`, it is treated as a Reliance Retail ID and resolved to the user (unknown rr_id yields 404). Defaults to `user_id`.

Default Value : user_id

Enum

company_id

string

Required

Enum

application_id

string

Required

Enum

user_id

string

Required

definition_id

string

Required

Response

200

404

Deleted

DeleteDetail

message

string

success

boolean

oneOf Schema from below

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

user_id:

"64f222222222222222222222"

definition_id:

"64f999999999999999999999"

Was this section helpful?

DEL

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/users/{user_id}/attributes/{definition_id}

Response

UserGroup

User group management operations.

Operations

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/tags

# List group tags

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/categories

# List group categories

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/categorised

# List groups by category

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups

# List groups

POST

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups

# Create group

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

# Get group by id

PUT

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

# Update group (full replace)

PATCH

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

# Patch group

DEL

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

# Delete group

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}/users

# List users in group

POST

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}/total-users/refresh

# Refresh total users

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/external

# List external groups

GET

List group tags

FDK Method Name: getUserGroupTags

Get all tags available for user groups.

Requires application/customers/read access scope.

Parameters

company_id

string

Required

Company identifier.

Enum

application_id

string

Required

Application identifier.

Enum

Response

200

Tags list

UserGroupTagsDetail

items

array of string

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/tags

Response

GET

List group categories

FDK Method Name: getUserGroupCategories

Get available group categories.

Requires application/customers/read access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

category

string

Filter category by key.

Response

200

Categories list

UserGroupCategoriesDetail

items

array of object

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

category:

"l1"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/categories

Response

GET

List groups by category

FDK Method Name: getCategorisedUserGroups

Get user groups grouped by category.

Requires application/customers/read access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

Response

200

Categorised groups

UserGroupCategorisedDetail

user_groups

object

Map of category key to array of lightweight group objects.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/categorised

Response

GET

List groups

FDK Method Name: getUserGroups

Get paginated user groups for an application.

Requires application/customers/read access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

status

string

type

string

name

string

group_uid

integer

Filter by group UID(s). Repeat for multiple.

oneOf Schema from below

slug

string

Filter by group slug.

tags

string

category

string

page_no

integer

page_size

integer

Response

200

Paginated groups

UserGroupListDetail

items

array of object (UserGroup)

Array of UserGroup

_id

string

ObjectId of the group. External (PAL) groups carry the upstream cohort id here instead, which is a short numeric string, so no ObjectId pattern is enforced.

uid

number

Numeric UID. Returned only when UID_ENABLED is true.

slug

string

Unique kebab-case slug for this group within the application. Numeric and ObjectId-like values are not allowed. Immutable once created.

Minimum Length : 1

Maximum Length : 50

Pattern : ^[a-z0-9]+(?:-[a-z0-9]+)*$

name

string

description

string

file_url

string

application_id

string

type

string

status

string

category

string

tags

array of string

total_users

object

conditions

array of object (UserGroupCondition)

Conditions array. Returned for conditional groups.

Array of UserGroupCondition

user_attribute_definition_id

string

key

string

Attribute slug populated from the definition.

type

string

Enum

value

string

oneOf Schema from below

blacklisted_users

array of string

Blacklisted user ObjectIds. Returned for conditional groups.

created_at

string

| date-time

modified_at

string

| date-time

is_active

boolean

__v

integer

page

object (PageNumber)

PageNumber

type

string

current

integer

size

integer

item_total

integer

has_next

boolean

has_previous

boolean

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups

Response

POST

Create group

FDK Method Name: createUserGroup

Create a user group.

Requires application/customers/write access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

Request body

name

string

Required

description

string

Required

slug

string

Optional kebab-case slug. Numeric and ObjectId-like values are not allowed. If omitted, it is generated from `name`; numeric or ObjectId-like generated values get a random suffix. Immutable once created.

Minimum Length : 1

Maximum Length : 50

Pattern : ^[a-z0-9]+(?:-[a-z0-9]+)*$

category

string

Required

Enum

file_url

string

Required

Response

201

Group created

UserGroup

_id

string

ObjectId of the group. External (PAL) groups carry the upstream cohort id here instead, which is a short numeric string, so no ObjectId pattern is enforced.

uid

number

Numeric UID. Returned only when UID_ENABLED is true.

slug

string

Unique kebab-case slug for this group within the application. Numeric and ObjectId-like values are not allowed. Immutable once created.

Minimum Length : 1

Maximum Length : 50

Pattern : ^[a-z0-9]+(?:-[a-z0-9]+)*$

name

string

description

string

file_url

string

application_id

string

type

string

status

string

category

string

tags

array of string

total_users

object

conditions

array of object (UserGroupCondition)

Conditions array. Returned for conditional groups.

Array of UserGroupCondition

user_attribute_definition_id

string

key

string

Attribute slug populated from the definition.

type

string

Enum

value

string

oneOf Schema from below

blacklisted_users

array of string

Blacklisted user ObjectIds. Returned for conditional groups.

created_at

string

| date-time

modified_at

string

| date-time

is_active

boolean

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

body:

body

Was this section helpful?

POST

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups

Response

GET

Get group by id

FDK Method Name: getUserGroupById

Get a user group by Mongo `_id`, numeric UID, or slug.

Requires application/customers/read access scope.

Parameters

company_id

string

Required

application_id

string

Required

group_id

string

Required

User group Mongo `_id`, numeric UID, or slug.

Response

200

404

Group details

UserGroup

_id

string

ObjectId of the group. External (PAL) groups carry the upstream cohort id here instead, which is a short numeric string, so no ObjectId pattern is enforced.

uid

number

Numeric UID. Returned only when UID_ENABLED is true.

slug

string

Unique kebab-case slug for this group within the application. Numeric and ObjectId-like values are not allowed. Immutable once created.

Minimum Length : 1

Maximum Length : 50

Pattern : ^[a-z0-9]+(?:-[a-z0-9]+)*$

name

string

description

string

file_url

string

application_id

string

type

string

status

string

category

string

tags

array of string

total_users

object

conditions

array of object (UserGroupCondition)

Conditions array. Returned for conditional groups.

Array of UserGroupCondition

user_attribute_definition_id

string

key

string

Attribute slug populated from the definition.

type

string

Enum

value

string

oneOf Schema from below

blacklisted_users

array of string

Blacklisted user ObjectIds. Returned for conditional groups.

created_at

string

| date-time

modified_at

string

| date-time

is_active

boolean

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

group_id:

"64f111111111111111111111"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

Response

PUT

Update group (full replace)

FDK Method Name: updateUserGroup

Fully update a user group. For bulk groups, update `name`, `description`, or `file_url`. For conditional groups, update `name`, `description`, or replace `conditions[]`. The `external_uid` field cannot be changed once set.

Requires application/customers/write access scope.

Parameters

company_id

string

Required

application_id

string

Required

group_id

string

Required

Request body

name

string

Required

description

string

file_url

string

status

string

conditions

array of object (UserGroupCondition)

Array of UserGroupCondition

user_attribute_definition_id

string

Required

key

string

Attribute slug populated from the definition.

type

string

Required

Enum

value

string

Required

oneOf Schema from below

Response

200

400

404

Updated group

UserGroup

_id

string

ObjectId of the group. External (PAL) groups carry the upstream cohort id here instead, which is a short numeric string, so no ObjectId pattern is enforced.

uid

number

Numeric UID. Returned only when UID_ENABLED is true.

slug

string

Unique kebab-case slug for this group within the application. Numeric and ObjectId-like values are not allowed. Immutable once created.

Minimum Length : 1

Maximum Length : 50

Pattern : ^[a-z0-9]+(?:-[a-z0-9]+)*$

name

string

description

string

file_url

string

application_id

string

type

string

status

string

category

string

tags

array of string

total_users

object

conditions

array of object (UserGroupCondition)

Conditions array. Returned for conditional groups.

Array of UserGroupCondition

user_attribute_definition_id

string

key

string

Attribute slug populated from the definition.

type

string

Enum

value

string

oneOf Schema from below

blacklisted_users

array of string

Blacklisted user ObjectIds. Returned for conditional groups.

created_at

string

| date-time

modified_at

string

| date-time

is_active

boolean

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

group_id:

"64f111111111111111111111"

body:

body

Was this section helpful?

PUT

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

Response

PATCH

Patch group

FDK Method Name: patchUserGroup

Partially update a group. Behaviour depends on the `type` field: - `file_url` (default): update `name`, `description`, and/or `file_url`. - `json`: add or remove individual users by `user_id`, `email`, `phone_number`, or `rr_id` via `user_data[]`. - `black_list`: add user ObjectIds to the blacklist (conditional groups only). - `white_list`: remove user ObjectIds from the blacklist (conditional groups only).

Requires application/customers/write access scope.

Parameters

company_id

string

Required

application_id

string

Required

group_id

string

Required

Request body

type

string

Patch mode: - `file_url` (default): update name/description/file_url. - `json`: add/remove users individually via `user_data[]`. - `black_list`: append to blacklist (conditional groups). - `white_list`: remove from blacklist (conditional groups).

Default Value : file_url

Enum

name

string

Used when `type` is `file_url`.

description

string

Used when `type` is `file_url`.

file_url

string

Used when `type` is `file_url`.

user_data

array of object (UserGroupUserPatch)

Required when `type` is `json`. Max 1000 entries.

Minimum Items : 1

Maximum Items : 1000

Array of UserGroupUserPatch

action

string

Required

Enum

user_id

string

| email

phone_number

string

Phone number string (trimmed).

rr_id

string

Reliance Retail ID (trimmed). Exactly one identifier is used per entry; when multiple are present, precedence is `phone_number`, then `email`, then `user_id`, then `rr_id`.

blacklisted_users

array of string

User ObjectIds to add to blacklist. Used when `type` is `black_list`.

whitelisted_users

array of string

User ObjectIds to remove from blacklist. Used when `type` is `white_list`.

Response

200

400

404

Patched group

UserGroup

_id

string

ObjectId of the group. External (PAL) groups carry the upstream cohort id here instead, which is a short numeric string, so no ObjectId pattern is enforced.

uid

number

Numeric UID. Returned only when UID_ENABLED is true.

slug

string

Unique kebab-case slug for this group within the application. Numeric and ObjectId-like values are not allowed. Immutable once created.

Minimum Length : 1

Maximum Length : 50

Pattern : ^[a-z0-9]+(?:-[a-z0-9]+)*$

name

string

description

string

file_url

string

application_id

string

type

string

status

string

category

string

tags

array of string

total_users

object

conditions

array of object (UserGroupCondition)

Conditions array. Returned for conditional groups.

Array of UserGroupCondition

user_attribute_definition_id

string

key

string

Attribute slug populated from the definition.

type

string

Enum

value

string

oneOf Schema from below

blacklisted_users

array of string

Blacklisted user ObjectIds. Returned for conditional groups.

created_at

string

| date-time

modified_at

string

| date-time

is_active

boolean

__v

integer

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

group_id:

"64f111111111111111111111"

body:

body

Was this section helpful?

PATCH

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

Response

DEL

Delete group

FDK Method Name: deleteUserGroup

Requires application/customers/write access scope.

Parameters

company_id

string

Required

application_id

string

Required

group_id

string

Required

Response

200

404

Group deleted

DeleteDetail

message

string

success

boolean

oneOf Schema from below

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

group_id:

"64f555555555555555555555"

Was this section helpful?

DEL

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}

Response

GET

List users in group

FDK Method Name: getUsersByGroupId

Requires application/customers/read access scope.

Parameters

company_id

string

Required

application_id

string

Required

group_id

string

Required

string

cursor

string

Enum

direction

string

Enum

page_no

integer

page_size

integer

blacklisted_users

boolean

Response

200

404

Group users

UserGroupUsersDetail

items

array of object (UserSummary)

Array of UserSummary

user_id

string

emails

array of object (Email)

Array of Email

string

primary

boolean

verified

boolean

active

boolean

phone_numbers

array of object (PhoneNumber)

Array of PhoneNumber

phone

string

country_code

number

verified

boolean

primary

boolean

active

boolean

page

object (CursorPage)

CursorPage

type

string

current

integer

size

integer

has_next

boolean

has_prev

boolean

next_cursor

string

Nullable

prev_cursor

string

Nullable

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

group_id:

"64f111111111111111111111"

cursor:

"64f222222222222222222222"

direction:

"next"

page_no:

page_size:

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}/users

Response

POST

Refresh total users

FDK Method Name: refreshUserGroupTotalUsers

Requires application/customers/write access scope.

Parameters

company_id

string

Required

application_id

string

Required

group_id

string

Required

Response

202

404

Refresh started

RefreshDetail

message

string

slug

string

uid

number

Numeric UID. Returned only when UID_ENABLED is true.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

group_id:

"64f111111111111111111111"

Was this section helpful?

POST

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/{group_id}/total-users/refresh

Response

GET

List external groups

FDK Method Name: getExternalGroups

List groups sourced from the external PAL (Plane1) audience platform, projected into an external group response shape for group pickers.

Requires application/customers/read access scope.

Parameters

company_id

string

Required

Enum

application_id

string

Required

Enum

status

string

type

string

name

string

group_uid

integer

Filter by group UID(s). Repeat for multiple.

oneOf Schema from below

slug

string

Filter by group slug.

tags

string

category

string

page_no

integer

page_size

integer

Response

200

400

Paginated PAL cohorts

UserGroupListDetail

items

array of object (UserGroup)

Array of UserGroup

_id

string

ObjectId of the group. External (PAL) groups carry the upstream cohort id here instead, which is a short numeric string, so no ObjectId pattern is enforced.

uid

number

Numeric UID. Returned only when UID_ENABLED is true.

slug

string

Unique kebab-case slug for this group within the application. Numeric and ObjectId-like values are not allowed. Immutable once created.

Minimum Length : 1

Maximum Length : 50

Pattern : ^[a-z0-9]+(?:-[a-z0-9]+)*$

name

string

description

string

file_url

string

application_id

string

type

string

status

string

category

string

tags

array of string

total_users

object

conditions

array of object (UserGroupCondition)

Conditions array. Returned for conditional groups.

Array of UserGroupCondition

user_attribute_definition_id

string

key

string

Attribute slug populated from the definition.

type

string

Enum

value

string

oneOf Schema from below

blacklisted_users

array of string

Blacklisted user ObjectIds. Returned for conditional groups.

created_at

string

| date-time

modified_at

string

| date-time

is_active

boolean

__v

integer

page

object (PageNumber)

PageNumber

type

string

current

integer

size

integer

item_total

integer

has_next

boolean

has_previous

boolean

additionalProperties

Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.

Examples

Parameters

company_id:

"559"

application_id:

"64b000000000000000000001"

Was this section helpful?

GET

/service/platform/audience/v1.0/company/{company_id}/application/{application_id}/groups/external

Response

« Register Subscriber.

Get promotion and coupon type »