Promotions Suite
Promotions Suite API enables financial institutions to programmatically create and manage audience user lists for targeted marketing campaigns. It supports asynchronous submission of user list upload jobs and provides status tracking for job progress and completion, allowing institutions to integrate audience creation directly into automated campaign and data workflows.
Note: These endpoints require a V1 OAuth token. See Authentication API documentation for V1 token endpoint details.
End-user benefits
- Accelerates campaign readiness by enabling audience creation for targeted marketing campaigns
- Improves reliability and control with clear status tracking and completion visibility
- Streamlines operations by reducing manual effort and campaign setup errors
Integration capabilities
- User List Upload: Enqueue user lists for upload to Promotion Suite
- Status Tracking: Monitor the status of user list uploads
Required headers
| Header | Description |
|---|---|
Authorization | Bearer {token} |
di_tid | UUID tracing the request end-to-end |
Error codes
| HTTP Status Code | Message |
|---|---|
| 400 | Request does not meet specification; body includes userMessage |
| 401 | Authorization error |
| 429 | Too many concurrent user list jobs — retry later |
| 500 | Unexpected server error |
Endpoints
Create User List Upload Job
Enqueues a job for uploading a user list with the given name to Promotion Suite, returning a job ID. The job then completes later, at which point the user list is visible as a target audience in Promotion Suite. This is an alternative to uploading a user list in the Promotion Suite UI and waiting for the upload to complete before being able to do anything else in it.
Get User List Upload Status
Gets the status of a user list upload job, showing its current state and progress.