Overview
Skill Level: Intermediate
Step-by-step
-
Syntax of the request and response XML for GetFolderPath
Operation <GetFolderPath> Elements OBJECT_TYPE
The type of objects that are contained in the folder. Valid values are:
- Data
- Mailing
 FOLDER_ID Optional The ID of folder whose folder path is being requested. This is a Parent Folder Id that is returned by another API call.
Note: If TYPE is “Data”, the FOLDER_ID is an integer. If TYPE is “Mailing”, the FOLDER_ID is a GUID. OBJECT_ID Optional The ID of Mailing or Data object whose folder path is being requested. This is a List ID or Mailing Id that is returned by another API call. Example 1 Folder <Envelope> <Body> <GetFolderPath> <OBJECT_TYPE>Mailing</OBJECT_TYPE> <FOLDER_ID>12c734c-108b610e402-f528764d624db129b32c21fbca0cb8d6</FOLDER_ID> </GetFolderPath> </Body> </Envelope>
Example 1 Object <Envelope> <Body> <GetFolderPath> <OBJECT_TYPE>Data</OBJECT_TYPE> <OBJECT_ID>87456</OBJECT_ID> </GetFolderPath> </Body> </Envelope>
Response <RESULT>
Elements SUCCESS True if successful.
 FOLDER_PATH The folder path of the specified Folder or Object.
 OBJECT_SUB_TYPE Optional The subtype of an object that matches the provided Object ID. This element is only populated when OBJECT_ID is passed in the request.
If the OBJECT_TYPE is “Data”, valid values are:
- Database
- Contact List
- Query
- Test List
- Seed List
- Suppression List
- Relational Table
Â
If the OBJECT_TYPE is “Mailing”, valid values are:
- Template
- Sent
- Autoresponder
- Inactive Autoresponder
- Deleted
Example <Envelope> <Body> <RESULT> <SUCCESS>TRUE</SUCCESS> <FOLDER_PATH>Shared/Promotions/January</FOLDER_PATH> <OBJECT_SUB_TYPE>Template</OBJECT_SUB_TYPE> </RESULT> </Body> </Envelope>