The REST API provides access to create, retrieve, update and delete Email Folders.

 

Accessing Email Folders

  • GET :  /assets/email/folders?depth={depth}&count={count}&page={page}&search={search}&orderBy={orderBy}&lastUpdatedAt={lastUpdatedAt}

 

Response

The response for this call looks as follows :

 

{
  "elements": [
    {
      "type": "Folder",
      "id": "42",
      "createdAt": "1172514464",
      "depth": "complete",
      "description": "Root",
      "name": "Email Group Root",
      "updatedAt": "1378173465",
      "updatedBy": "116",
      "isSystem": "true"
    },
    {
      "type": "Folder",
      "id": "43",
      "createdAt": "1172514464",
      "depth": "complete",
      "folderId": "250",
      "name": "My Emails",
      "updatedAt": "1336754427",
      "updatedBy": "28",
      "isSystem": "false"
    },
    {
      "type": "Folder",
      "id": "44",
      "createdAt": "1172514464",
      "depth": "complete",
      "folderId": "250",
      "name": "Newsletter",
      "updatedAt": "1335871832",
      "updatedBy": "46",
      "isSystem": "false"
    },
  ],
  "page": 1,
  "pageSize": 10,
  "total": 301
}
 

 

Properties

 

Name

Type

Description

Notes

Validations

type

Folder

 

 

 

id

integer

The unique identifier of the Folder

ReadOnly

IdRequirement

isSystem

boolean

Identifies a system generated Folder

ReadOnly

 

name

string

The Folder’s name

 

 

 

Related Operations :

GET :  /assets/email/folder/{id}?depth={depth}

POST :  /assets/email/folder

PUT :  /assets/email/folder/{id}

DELETE :  /assets/email/folder/{id}

 

We hope this helps and please let us know if you have any questions.

 

Thanks,

Fred