Skip to main content

Create User List Metadata

Loading...
API endpoint path: /v1/userlists

Creates metadata for a user list file uploaded through SFTP. The metadata associates the uploaded file with a user list name, optional description, and the operation to perform when the file is processed.

Use this endpoint to:

  • Register metadata for a user list file that has already been uploaded through SFTP.
  • Specify whether users in the file should be used to create, replace, add to, or remove users from a user list.
  • Provide an optional description for the audience list used in customer campaigns.

Behavior and capabilities:

  • Upload the CSV file to SFTP before calling this endpoint. userlistFileName must match the uploaded file name.
  • userlistFileName is required and must follow FI<fiId>_<fileLabel>_<yyyyMMddHHmmss>.csv, where fiId is a 5-digit financial institution ID.
  • userlistName and userlistOperation are required. Supported operations: CREATE, REPLACE, ADD, REMOVE, CREATE_OR_REPLACE, and CREATE_OR_ADD.
  • userlistDescription is optional.
  • Only the first entry in userLists is processed.
  • Metadata can be submitted only once per userlistFileName.
  • On success, the metadata is stored and an empty response body is returned. File processing continues asynchronously.

Next Steps​

After creating metadata, use the Get User List File Details endpoint with viewName=fileStatus to monitor processing, or with viewName=fileErrorReport to review error report availability.

Request​

Responses​

Success. Returns an empty response body.