What can I do with folder?

Folders can be surprisingly powerful when it comes to managing your subscriber data.

  • A folder can be empty or contain one or more lists.
  • When managing users you can choose which folders a user has access to. Any lists within a restricted folder are hidden from that user. Subscriptions, forms and automation rules which reference a hidden list are all affected.
  • A list and its subscriptions can be moved from one folder to another.

There is no limit to the amount of lists a folder can contain.

GET /folder or /folder/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the folder.
list_count
intNoNoNumber of lists contained in this folder.
name
stringYesYesFolder name. Must be between 1 and 40 octets in length.
subscription_count
intNoNoSum of the subscription counts of all lists contained in the folder.
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNoLast modification timestamp.

A folder's name should never be made public.

HEAD /folder or /folder/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the folder.
name
stringOptionalFolder name. Must be between 1 and 40 octets in length.

POST /folder

AttributeTypePresenceDescription
name
stringRequiredFolder name. Must be between 1 and 40 octets in length.

PUT /folder or /folder/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the folder.
name
stringOptionalFolder name. Must be between 1 and 40 octets in length.

DELETE /folder or /folder/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the folder.

Folders containing lists which are non deletable cannot be deleted. The list may have been targeted by a recent task (within 72 hours) or is targeted by a scheduled task.

Deleting a folder will remove all lists which reference the folder id as if a DELETE had been issued on the lists themselves.

Error codes

CodeSubcodeMessageDescription
423
4
Folder $id or one of its lists is to be or has been targetedA campaign is scheduled to be sent to a list in this folder in the future, or has been sent to a list in this folder in the last 72 hours.
423
5
Folder contains List $id which is permanentThis folder contains a permanent list.

Please see error handling for more information on error codes.

Examples

JSON response

{
    "id":               412,
    "list_count":       10
    "name":             "Default Folder",
    "subscription_count": 5,
    "cdate":            1234966741,
    "mdate":            1234966741,
 }