Fetch upload status

GET

/optout-list/upload-status/{reference}

const url = 'https://api.optizmo.com/optout-list/upload-status/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {api_key: '<api_key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.optizmo.com/optout-list/upload-status/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'api_key: <api_key>'

Fetches the current status of an optout-list upload

Authorizations

api_key

Parameters

Path Parameters

reference

required

string format: uuid

Reference returned from the request to /optout-list/prepare-upload

Responses

200

Details on the progress of an optout-list upload

application/json

object

status

required

The current status of the upload

string

Allowed values: running success failed removed

message

(optional) Progress or error message output related to the upload. This will only be returned if the status is success or failed.

string

elapsedSeconds

(optional) The number of seconds that has elapsed since the uploaded list was ready for processing. This does not include the time taken to upload the file.

number

addedCount

(optional) The number of opt-outs that were successfully imported and added to the target list. This will only be returned if the status is success or failed.

number

malformedCount

(optional) The number of opt-outs that were discarded due to being formatted incorrectly. This will only be returned if the status is success or failed.

number

submittedCount

(optional) The number of opt-outs that were detected in the uploaded file. This will only be returned if the status is success or failed.

number

Example

{
  "status": "running"
}

400

Invalid request payload sent. Further details will be available in the response payload.

401

Authorization not sent or failed.

403

Attempted to access a resource not owned by the requesting user.