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

Individual Library Files

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.

Methods:

Click a method to view its documentation

GET PUT DELETE

Description TOP

Privileges required : contacts:lists:write

PUT: Update the name, status of the ContactList specified by the listId path parameter. Performing a PUT overwrites all existing properties for the contactlist resource; any properties left blank or not included in the call will delete those property values prior to the call.

Description TOP

Privileges required : mylibrary:folder:update

Use PUT to modify the following properties for a folder specified by folderId path parameter:

  • update the folder's name
  • change the folder's location in the directory structure by changing it's parent_id
    To move a folder to level 1 in the directory structure, set the parent_id to 0

Description TOP

Privileges required : mylibrary:file:update

Use a PUT call to update the following for a file (specified using the fileId path parameter):

  • Update the name
  • Update the description
  • Move a file to another folder, using folder_id to specify the destination folder.

Description TOP

Privileges required : campaign:write

Update an existing event by using the eventId path parameter.

Description TOP

Privileges required : campaign:write

Update an existing event item; specify the event and the item using the eventId and itemId path parameters.

Description TOP

Privileges required : campaign:write

Update an existing promocode for an event; specify the code and event using the eventId and promocodeId path parameters.

Description TOP

Privileges required : campaign:write

Update an existing fee (specify using feeId ) for an event specified by eventId .

Description TOP

Privileges required : campaign:write

Update an existing item attribute by specifying the eventId , itemId , and attributeId path parameters. Include the attribute name and description in the JSON request body.

NOTE: You cannot change an attribute name once any have been sold to or claimed by event registrants.

Description TOP

Privileges required : campaign:activate

Update the schedule for an email campaign using the scheduleId and campaignId path parameters.

Description TOP

Privileges required : campaign:create

Update an existing email campaign message specified by the campaignId path parameter. For campaigns with a template_type = CUSTOM, all editable fields are available for updating. If template_type = STOCK, the following fields are not available for edit (read-only):

  • text_content
  • email_content
  • style_sheet

These fields can only be updated using the Constant Contact user interface.

NOTE: There are several campaign properties that are optional by default, but become REQUIRED once another property is used. See Structure table below for specific properties.

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

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

fileId

path

Specifies the MyLibrary file to update

include_payload

query

TRUE

Determines if updated file's JSON payload is returned :

  • TRUE (default) - successful update returns 200 - Ok and updated JSON payload
  • FALSE - successful update returns 204 - No Content, with the Location header set to the URL of the updated resource

Example JSON Request Body TOP 

{
	"folder_id":"-14",
	"description":"chocolates",
	"name":"IMG_0261.JPG"
}

Response Codes TOP

code

description

200

File(s) was successfully moved

400

Either JSON was malformed or there was a data validation error

401

Authentication failure

404

File with specified ID not found

406

Unsupported accept header value, must be application/json

415

Unsupported content-type in the header, must be application/json

500

Internal server error occurred

Structure TOP

property

type (max length)

description

Example Response TOP 

{
    "name": "IMG_0261.JPG",
    "id": "4",
    "description": "chocolates",
    "folder": "wildflowers",
    "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-09-24T13:55:35.000-04:00",
    "folder_id": "-14",
    "is_image": true,
    "file_type": "JPG"
}