Our v3 API is now available! Learn more by visiting the v3 developer portal. Creating new v2 API keys is no longer supported.

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.

DescriptionTOP

Privileges required: N/A

Retrieve MyLibrary product usage information for the authorized Constant Contact account. 

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve all files in the Trash folder. You can specify the type of files to retrieve using the type query parameter. You can sort the output using the sort_by query parameter. 

DescriptionTOP

Privileges required: mylibrary:folder:read

Retrieve a specific MyLibrary folder using the folderId path parameter. 

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve a list of MyLibrary folders and their properties for the authorized Constant Contact account. MyLibrary supports a folder hierarchy with 3 levels of nesting. Primary, child (2nd level) and grandchild (3rd level) folders all have the same properties associated with them. This endpoint returns an empty results array if there are no folders in the user's account.

DescriptionTOP

Privileges required: mylibrary:file:read

The following options  are available when retrieving Library files:

  • Retrieve all files in all folders in the account - do not use any query parameters (except for api_key)
  • Retrieve all files with a specific type - use the type query parameter (ALL, IMAGE, or Document)
  • Retrieve all files from a specific source - use the source query parameter
  • Retrieve a specific file type from a specific source - use both the type and source query parameters

There are many options available for sorting the JSON response using the sort_by query parameter.

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve a MyLibrary file using the fileId path parameter.

DescriptionTOP

Privileges required: mylibrary:file:read

Get a list of all files in a Library folder specified by the folderId path parameter.

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

Example ResponseTOP

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