Use this endpoint to retrieve (GET) and update (PUT) information for a specific Library file, and to DELETE one or more files. To create (POST) a file, use the Library File Collection POST method.
Click a method to view its documentation
Retrieve a specific partner webhook topic by specifying the topicId
path parameter. See the available topic ID's here.
Privileges required: campaign:read
Retrieves the email campaign message specified by the campaignId
path parameter. The tracking_summary data
is current as of the last scheduled update, unless you set updateSummary
=true to return updated data.
NOTE: Details of a deleted campaign cannot be retrieved. If a call is made to GET a deleted campaign by its ID, the call will fail and return a 404 Not Found response. You can login to the account to restore the campaign and then retrieve its details.
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.
Privileges required: N/A
Retrieve MyLibrary product usage information for the authorized Constant Contact account.
Privileges required: contacts:lists:read
GET a specific contact list (specified using the listId
path parameter).
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.
Privileges required: mylibrary:folder:read
Retrieve a specific MyLibrary folder using the folderId
path parameter.
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.
Privileges required: mylibrary:file:read
The following options are available when retrieving Library files:
api_key
)type
query parameter (ALL, IMAGE, or Document)source
query parametertype
and source
query parametersThere are many options available for sorting the JSON response using the sort_by
query parameter.
Privileges required: mylibrary:file:read
Retrieve a MyLibrary file using the fileId
path parameter.
GET: https://api.constantcontact.com/v2/library/files/{fileId} |
|||
name |
type |
default |
description |
---|---|---|---|
api_key |
query |
REQUIRED; The API key for the application |
|
fileId |
path |
Specifies the MyLibrary file for which to retrieve information |
code |
description |
---|---|
200 |
Request was successful |
401 |
Authentication failure |
404 |
File with the supplied ID was not found |
406 |
Unsupported Accept Header value, must be application/json |
500 |
Internal server error occurred |
property |
type(max length) |
description |
---|
{ "name": "IMG_0261.JPG", "id": "4", "description": "chocolates", "folder": "Images", "height": 600, "width": 800, "size": 68825, "url": "https://origin.ih.l1.constantcontact.com/fs115/1100310339939/img/4.jpg", "source": "MyComputer", "status": "Active", "thumbnail": { "url": "https://origin.ih.l1.constantcontact.com/fs115/1100310339939/img/4.jpg", "height": 150, "width": 200 }, "created_date": "2013-06-19T11:36:43.000-04:00", "modified_date": "2013-08-23T12:54:17.000-04:00", "folder_id": null, "is_image": true, "file_type": "JPG" }