Skip to main content

Upload Experience Group Participants

Loading...
API endpoint path: /v3/groups/{groupId}/participants

Uploads a CSV file of retail banking member numbers to add, remove, or replace participants in an existing experience group. Participant updates are processed asynchronously as an import job.

Use this endpoint to:

  • Add participants to an experience group from a CSV file.
  • Remove participants from an experience group using a CSV file.
  • Replace all existing participants in an experience group with a new participant list.

Behavior and capabilities:

  • Requires multipart form data containing an upload type (ADD, REMOVE, or REPLACE) and a CSV file.
  • The CSV file must include a ParticipantId column. Each ParticipantId value represents a retail banking member number and must not exceed 32 characters.
  • Supported file content types are text/csv and application/vnd.ms-excel.
  • Only one import job can run for an experience group at a time. Upload requests are rejected while another import job is in progress.
  • On success, the API creates an import job and returns its jobId and initial jobStatus (CREATED). Use the Get Job by ID endpoint to monitor job status and results.

Request​

Responses​

Success