Initiatives and campaign calendar tools
- list_initiatives: List the initiatives in a project.
- get_initiative: Get the full definition of an initiative.
- get_initiative_items: List the campaigns and analyses inside an initiative.
- get_campaign_calendar: Get scheduled email and SMS campaigns within a date window.
list_initiatives
Lists every initiative defined in a project. Initiatives are organizational containers (use-case folders) that group related campaigns and analyses. The response gives you the name, description, color, pinned flag, archived flag, and tags.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
Response parameters
The tool returns an InitiativesResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[InitiativeSummary] | The initiative summaries. |
error | str | null | Error message if the request failed. |
The InitiativeSummary object has the following fields:
| Field | Type | Description |
|---|---|---|
id | str | The initiative's unique ID. |
name | str | The initiative's display name. |
description | str | null | The initiative's description. |
color | str | null | The display color of the initiative card. |
pinned | bool | Whether the initiative is pinned to the top of the list. |
archived | bool | Whether the initiative has been archived. |
tags | list[str] | User-defined tags. |
created | any | null | Unix timestamp of when the initiative was created. |
created_by_display_name | str | null | Display name of the creator. |
edited | any | null | Unix timestamp of the last edit. |
edited_by_display_name | str | null | Display name of the last editor. |
get_initiative
Returns the full definition of a single initiative, including its description, color, and use-case template metadata (difficulty, goal, recommended channels, and required modules).
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
initiative_id | str | Yes | The initiative ID returned by list_initiatives. |
Response parameters
The tool returns an InitiativeResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | Initiative | null | The full initiative definition. |
error | str | null | Error message if the request failed. |
The Initiative object adds the following field on top of the summary record:
| Field | Type | Description |
|---|---|---|
use_case_metadata | any | null | The use-case template metadata: difficulty, goal, recommended channels, and required modules. |
get_initiative_items
Lists every item assigned to an initiative. Items include campaigns (email, SMS, scenarios, banners, and so on) and analyses (funnels, trends, reports). Each item carries its type, ID, name, and status.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
initiative_id | str | Yes | The initiative ID returned by list_initiatives. |
Response parameters
The tool returns an InitiativeItemsResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
data | list[any] | The items inside this initiative. Each item carries a type, ID, name, and status. |
error | str | null | Error message if the request failed. |
get_campaign_calendar
Returns the campaign calendar for a project: scheduled one-time email and SMS campaign entries within a date window. Each entry includes the campaign name, type, status, and scheduled send time.
The date window is set with Unix timestamps (in seconds). If you omit from_ts and to_ts, the window defaults to the current week.
Request parameters
| Name | Type | Required? | Description |
|---|---|---|---|
project_id | str | Yes | The project ID returned by list_projects. |
from_ts | int | null | No | Start of the window as a Unix timestamp in seconds. Defaults to the start of the current week. |
to_ts | int | null | No | End of the window as a Unix timestamp in seconds. Defaults to the end of the current week. |
Response parameters
The tool returns a CampaignCalendarResponse object with the following parameters:
| Parameter | Type | Description |
|---|---|---|
success | bool | Whether the request succeeded. |
campaigns | list[any] | Scheduled campaign entries in the requested window. Each entry includes campaign name, type, status, and send time. |
error | str | null | Error message if the request failed. |
Updated about 1 hour ago
