Enqueue a user list to be uploaded to Promotion Suite

Enqueues a job for uploading a user list with the given name to Promotion Suite, returning a job ID. The job will then complete later, at which point the user list will be 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.

ENDPOINTS

post

/pss/v1/fis/{fiId}/audiences/userListJobs

Header parameters

Collapse

Expand

Authorization

string

required

Standard OAuth 2.0 access tokenA string composed of `Bearer` + `(space)` + `{token}`; example `Bearer rvYKAItOGiMQy1yOHdUDAHWp2HG1`

Body parameters

Collapse

Expand

No items found.
No items found.

Query parameters

Collapse

Expand

No items found.

Path parameters

Collapse

Expand

No items found.
No items found.

CURL REQUEST

copy code snippetcode copiedexpand code snippetClose code snippet
curl -X 'POST' \ 
 'https://api.candescent.com/digitalbanking/pss/v1/fis/{fiId}/audiences/userListJobs' \ 
 -H 'authorization: SOME_STRING_VALUE' \ 
 -H 'di_tid: SOME_STRING_VALUE' \ 
 -H 'originating_ip: SOME_STRING_VALUE' \ 
 -H 'accept: application/json' \ 
 -H 'content-type: application/json' \ 
 -d '{
  "name": "My new user list",
  "users": [
    "some_member_id",
    "another_member_id"
  ]
}';
Get Response

RESPONSE

copy responseexpand responseclose response
No items found.
No items found.
close

Sign in now!

Please sign up or sign in to add to watchlist

Sign in
close

Added to watchlist!

Your interest has been noted. An NCR Voyix Rep
will contact you with further details soon.