Fetch Campaigns Api
Campaigns
Fetch Campaigns
Retrieves a list of campaigns associated with a specified organisation. This includes campaigns’ names, subjects, statuses, creation dates, and email tracking settings.
Path Parameters
organisation_id(int): The ID of the organisation for which campaigns are being fetched.
Headers
X-API-Key: API key for user authentication. Ensures that the request is made by an authorised user.
Response
- Returns a list of
Campaignobjects, each encapsulating details about a specific email campaign, including its ID, name, subject, creation date, status (e.g., pending, active, completed), and whether email tracking is enabled.
Errors
403 Forbidden: If the authenticated user is not a member of the specified organisation.404 Not Found: The campaign does not belong to the specified organisation.
GET
Fetch Campaigns Api
Authorizations
Key used to authenticate user API requests.
Response
200 - application/json
Successful Response
Required string length:
1 - 63Manages the automation settings for a campaign's AI assistant.
Each setting determines whether the AI should handle a specific event
automatically (True) or flag it for manual human review (False). Think of
these as permissions for the AI to act on its own.
Example:
{
"cancel_meeting": false,
"create_meeting": false,
"do_not_contact": true,
"do_not_respond": false,
"move_meeting": false,
"put_on_hold": true,
"send_email": false,
"send_reconnect_email": false,
"send_referral_email": false,
"unsuccessful_delivery": true
}Available options:
off, one-click, text