Individual Folder | Constant Contact Developer

Individual MyLibrary Folder

Use this endpoint to retrieve (GET), update (PUT), or DELETE an existing MyLibrary folder.

Methods:

Click a method to view its documentation

GET PUT DELETE

DescriptionTOP

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

name	type	default	description
PUT: https://api.constantcontact.com/v2/library/folders/{folderId}
Test API
api_key	query		REQUIRED; The API key for the application
folderId	path		Specifies the folder to Update
include_payload	query	TRUE	Determines if updated folder'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 BodyTOP

{
    "name":"Documents2",
    "parent_id":"0"
}

Response CodesTOP

code	description
200	Folder was successfully updated
204	Folder was successfully updated, no data returned
400	Either JSON was malformed or there was a data validation error
401	Authentication failure
404	A folder with specified ID not found
406	Unsupported accept header value, must be application/json
409	A folder with that name at this level already exists
415	Unsupported content-type in the header, must be application/json
500	Internal server error occurred

StructureTOP

property

type(max length)

description

+ children

array

List of child or grandchild folders within the selected folder, MyLibrary support 3 levels of folder nesting (Read Only)

...

string

Children and grandchildren folders have the same properties as the top level folders

created_date

string

Date the folder was created, in ISO-8601 format (Read Only)

string

Unique ID of the library folder (Read Only)

item_count

integer

Number of files in the library folder (Read Only)

level

integer

Indicates which level the folder resides at:

1 - top level
2 - child or mid level
3 - grandchild or lowest level (Read Only)

modified_date

string

Date the folder was last updated, in ISO-8601 format (Read Only)

name

string (40)

REQUIRED. Name of the library folder, supports only ISO-8859-1 characters (no support for UTF-8 enoding)

parent_id

string

Unique ID of the current folder's parent folder; if the folder is at the top level (not nested), value is null

Example ResponseTOP

{
    "id":"-4",
    "name":"Documents2",
    "level":1,
        "children":[{
        "id":"-10",
        "name":"market_studies",
        "level":2,
        "children":[],
        "item_count":0,
        "parent_id":"-4",
        "modified_date":"2013-06-24T13:12:10.000-04:00",
        "created_date":"2013-06-05T09:31:55.000-04:00"
        }],
    "item_count":1,
    "parent_id":"0",
    "modified_date":"2013-06-24T13:12:10.000-04:00",
    "created_date":"2013-06-05T09:31:55.000-04:00"
}