Project

Schema, including its fields, nested structure, and relationships

Definition

A Project is a simple container used to group campaigns. It does not affect campaign execution or hierarchy beyond the organization. Projects can help users categorize campaigns (for example, by department or project).

Payload Properties

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

• id (Integer, optional) – The project's unique ID. Include this only when updating an existing project.

• name (String, required) – Project display name.

Example Project Payload:

{
  "name": "Marketing Campaigns"
}

Response Fields

When a Project is retrieved, it will include:

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

• name (String) – The project name.

Example Project Response:

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

Error Codes

Potential errors for Project operations:

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

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

(Projects 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.)