Folder
Overview
The Folder endpoint allows you to create a folder within your client account. Once created, you can save other assets and items within the folder.
Endpoint (North America): https://api.eccmp.com/services2/api/Folder
Endpoint (Europe): https://api.ccmp.eu/services2/api/Folder
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/Folder
For more details on how to set up a Folder API request, please see the Folder API Technical Guide.
POST Method
The Folder endpoint supports the POST method. This method allows you to create a new folder by providing the following basic information:
The new folder name
The Folder ID of the parent folder. If you don't provide this parameter, the platform defaults to creating the new folder within the top-level "root" folder in your account.
Click hereClick here to see a sample request message in JSON format.
{
folder_name: "Campaigns",
parent_folder_id: 36472
}
Click hereClick here to see a sample response message in JSON format.
{
"folder_id": 37661,
"folder_name": "Campaigns",
"parent_folder_id": 36472,
"child_folders": {}
}
GET Method
The Folder endpoint supports the GET method. This method allows you to retrieve the details of a folder by providing its Folder ID. If you don't provide a Folder ID, the platform defaults to retrieving information about the top-level "root" folder in your account.
Click hereClick here to see a sample response message in JSON format.
{
"folder_id": 37661,
"folder_name": "Campaigns",
"parent_folder_id": 36472,
"child_folders": {
37828: "2018 Campaigns",
37876: "2019 Campaigns",
37912: "2020 Campaigns"
}
}
PATCH Method
The Folder endpoint supports the PATCH method. This method allows you to change the name of an existing folder. Please note that you can't change a folder's parent folder. You must provide the Folder ID of the folder you want to modify, as well as the new name for the folder.
Click hereClick here to see a sample request message in JSON format.
{
folder_name: "Campaigns"
}
DELETE Method
The Folder endpoint supports a DELETE operation that will delete the specified folder. You must provide the Folder ID for the desired folder.
Note: When you delete a folder, the platform also deletes all of the assets stored within that folder.
Back to API Category - Data Management