Folder

Schema, including its fields, nested structure, and relationships

Definition

A Folder is a simple container used to group campaigns. It does not affect campaign execution or hierarchy beyond the organization. Folders can help users categorize campaigns (for example, by department or project). In the resource loader, folders are top-level entities (campaigns reference a folder by folder_id but the folder itself stands alone).

Parent Relationship

• Parent Resource Type: None

• Parent Identifier Field: None

• Rule: Folders are top-level and not nested under any other resource. (In practice, they belong to an account, but within this schema, no parent is specified.)

Payload Properties

For folder creation or update, the payload is very simple:

• id (Integer, optional) – The folder’s unique ID. Include this only when updating an existing folder. Example: 100000.

• name (String, required) – The name of the folder. This is typically a short label describing the group of campaigns, such as "Summer 2025 Campaigns" or "Homepage Tests". Example: "NewBanner" (as a folder name).

Because folders are straightforward, no other properties are needed – a folder is basically just an ID and a name.

Example Folder Payload:

{
  "name": "folder_name"
}

Response Fields

When a Folder is retrieved, it will include:

• id (Integer) – The unique ID of the folder.

• name (String) – The folder name.

Example Folder Response:

{
  "id": 100000,
  "name": "Marketing Campaigns"
}

Folders do not have timestamps or user info in this context, as they are a simple reference object. Campaigns store the association in a folder via the folder_id field, but folders themselves just hold a name and ID.

Error Codes

Potential errors for folder operations:

• InvalidPayload – Missing folder name when creating a folder, or other payload formatting issues.

• PermissionDenied – User not allowed to create folders (if such permission is restricted).

(Folders don’t involve parent relationships, so errors like ParentNotFound or InvalidDependency are generally not applicable, except as generic error responses. The above codes mirror the general ones.)