Experience Groups

The Experience Groups APIs manage static experience groups within the retail banking platform. Use these APIs to create and manage user cohorts, view participant counts, and bulk update group membership through CSV uploads.

End-user benefits

• Create, update, retrieve, and delete static experience groups
• Bulk add, remove, or replace group participants using CSV file uploads
• View participant counts for each group
• Navigate large group collections using paginated results

Integration capabilities

• Create, update, retrieve, list, and delete groups
• Upload participant lists with ADD, REMOVE, or REPLACE operations
• List groups using 0-based page and size parameters (default page size: 20), with next and previous links for navigation between result pages

Scopes

Scope	Description
groups:read	List and retrieve experience groups
groups:write	Create, update, and delete experience groups, and upload participant lists

Required headers

Header	Description
Authorization	Bearer {token} (OAuth V2)
transactionId	UUID used to trace and correlate requests across services for debugging and logging.

Error codes

Code	Message	HTTP Status Code
2000	Invalid groupId {groupId}	400
2000	groupId {groupId} not found or has been marked for deletion	400
2000	Content-Type must be multipart/form-data or multipart/mixed	400
2000	Invalid type value. Type value can only be ADD, REMOVE, or REPLACE.	400
2000	Type parameter is required.	400
2000	Uploaded file data is empty.	400
2000	File type: {contentType} not allowed.	400
2000	{field} is required	400
2000	{field} cannot exceed {max} characters	400
2001	There are import jobs in process, need to wait for them to finish.	400
2001	additional details may be available in server logs	500
2003	Invalid Authorization	401
2004	A group with name {groupName} already exists.	400

Endpoints

List Experience Groups

Retrieves a paginated list of active experience groups for the authenticated institution,

Create Experience Group

Creates a new experience group for segmenting retail banking users for targeted experiences,

Update Experience Group

Updates the name and description of an existing experience group identified by `groupId`.

Delete Experience Group

Permanently deletes an experience group identified by `groupId`, including all associated

Upload Experience Group Participants

Uploads a CSV file of retail banking member numbers to add, remove, or replace participants