Library File Upload Status

Use this endpoint to retrieve the status of one or more files uploaded to the Library using the Add File Multipart POST endpoint.

Methods:

Click a method to view its documentation

GET

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve the upload status for one or more MyLibrary files using the fileId path parameter; separate multiple fileId's with a comma. If the fileId provided does not match any files in the MyLibrary account, the call returns a null set.

GET: https://api.constantcontact.com/v2/library/files/uploadstatus/{fileId}

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

fileId

path

Specifies the files for which to retrieve upload status information

Response CodesTOP

code

description

200

Request was successful

401

Authentication failure

404

The supplied url was not found

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

description

string (100)

Detailed information about the file upload status

file_id

string

Unique ID for the file

status

string

Indicates the file status:

  • Active - file is available for use
  • Processing - file is in the process of being uploaded to account
  • Uploaded - file has been uploaded, but not yet available for use
  • VirusFound - virus scan during upload detected a virus, upload cancelled
  • Failed - file upload failed
  • Deleted - file was deleted from MyLibrary

Example ResponseTOP

[
    {
        "file_id": "9",
        "status": "Active",
        "description":"Active"
    },
    {
        "file_id": "8",
        "status": "Uploaded",
        "description":"Uploaded"
    },
    {
        "file_id": "18",
        "status": "Processing",
        "description":"Processing"
    }
]