> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Aimtell

The Aimtell connector lets your AI agent act in each user's Aimtell account. Each user connects their own Aimtell API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Marketing, Communication
**Tools:** 60: 33 read, 20 write, 7 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=AIMTELL)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Aimtell connection

   In **AgentKit > Connections**, create an Aimtell connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'aimtell'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Aimtell:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'aimtell_sites_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "aimtell"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Aimtell:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="aimtell_sites_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Aimtell credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'aimtell_account_analytics_get',
  toolInput: {
    end_date: '<end_date>',
    start_date: '<start_date>',
    type: 'newsubscribers',
  },
  connector: 'aimtell',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="aimtell_account_analytics_get",
    tool_input={
        "end_date": "<end_date>",
        "start_date": "<start_date>",
        "type": "newsubscribers",
    },
    connection_name="aimtell",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `aimtell_account_analytics_get`

Get Account Analytics · Read-only

Get a metric over time across all websites in the account.
Returns daily values for the chosen type.
Dates are yyyy-mm-dd; use site_analytics_get for one site.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Format: yyyy-mm-dd (e.g. 2020-06-17). Example: 2026-01-31.
- `start_date` (`string`, required): Format: yyyy-mm-dd (e.g. 2020-06-01). Example: 2026-01-01.
- `type` (`string`, required): Type of analytics data to retrieve. Example: newsubscribers. One of: `newsubscribers`, `unsubscribes`, `notifications`, `notificationclicks`, `optin`, `inactive`, `revenue`.
- `breakdown` (`boolean`, optional): Enable per site breakdown. Defaults to false. Example: false.

Example input: `{"end_date":"<end_date>","start_date":"<start_date>","type":"newsubscribers"}`

### `aimtell_api_campaign_results_get`

Get API Campaign Results · Read-only

Get daily results for all API-sent pushes of a site over a date range.
Returns daily sends, clicks and conversions.
Dates are yyyy-mm-dd.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Date. Example: 2026-01-31.
- `site_id` (`integer`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `start_date` (`string`, required): Date. Example: 2026-01-01.

Example input: `{"end_date":"<end_date>","site_id":12345,"start_date":"<start_date>"}`

### `aimtell_api_campaigns_list`

List API Push Campaigns · Read-only

List the push notifications sent through push_send for a site, newest first.
Returns each campaign's id, title, body, link and send time.
Use api_campaign_results_get for daily totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `limit` (`integer`, optional): Maximum number of results to return per page. Example: 50.
- `skip` (`integer`, optional): Number of results to skip for pagination (offset). Example: 0.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_campaign_clicks_list`

List Manual Campaign Clicks · Read-only

List the clicks on a manual campaign, per subscriber.
Returns each click's subscriber id and timestamp.
Use campaign_results_get for daily totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`string`, required): ID of the campaign. Get it from campaigns_list. Example: 98765.

Example input: `{"campaign_id":"<campaign_id>"}`

### `aimtell_campaign_get`

Get Manual Campaign · Read-only

Get one manual push campaign.
Returns its name, title, body, link, status, schedule, segments, automation and A/B version.
Use campaigns_list to find campaign IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`string`, required): ID of the campaign. Get it from campaigns_list. Example: 98765.
- `load` (`string`, optional): Load Additional Information (i.e. Segments). Example: segments.

Example input: `{"campaign_id":"<campaign_id>"}`

### `aimtell_campaign_results_get`

Get Manual Campaign Results · Read-only

Get a manual campaign's results per day over a date range.
Returns daily sends, deliveries, clicks, conversions and revenue.
Dates are yyyy-mm-dd.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`string`, required): ID of the campaign. Get it from campaigns_list. Example: 98765.
- `end_date` (`string`, required): Date. Example: 2026-01-31.
- `start_date` (`string`, required): Date. Example: 2026-01-01.
- `include_shared` (`integer`, optional): Set to 1 to roll the results of every shared copy of this campaign into a single set of totals. Omit to return results for this campaign's site only. Defaults to 0. Example: 0.

Example input: `{"campaign_id":"<campaign_id>","end_date":"<end_date>","start_date":"<start_date>"}`

### `aimtell_campaigns_list`

List Manual Campaigns · Read-only

List a site's manual (one-time or scheduled) push campaigns.
Returns each campaign's id, name, title, body, link, status, schedule and segments.
Use campaign_get for one campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `limit` (`integer`, optional): Maximum number of results to return per page. Example: 50.
- `skip` (`integer`, optional): Number of results to skip for pagination (offset). Example: 0.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_event_campaign_get`

Get Event Triggered Campaign · Read-only

Get one event-triggered campaign.
Returns its name, trigger event (category, action, label), content, drip delays and status.
Use event_campaigns_list to find campaign IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `event_campaign_id` (`string`, required): ID of the event campaign. Get it from event_campaigns_list. Example: 98765.

Example input: `{"event_campaign_id":"<event_campaign_id>"}`

### `aimtell_event_campaign_results_get`

Get Event Campaign Results · Read-only

Get an event-triggered campaign's results per day over a date range.
Returns daily sends, clicks, conversions and revenue.
Dates are yyyy-mm-dd.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Date. Example: 2026-01-31.
- `event_campaign_id` (`string`, required): ID of the event campaign. Get it from event_campaigns_list. Example: 98765.
- `start_date` (`string`, required): Date. Example: 2026-01-01.
- `include_shared` (`integer`, optional): Set to 1 to roll the results of every shared copy of this campaign into a single set of totals. Omit to return results for this campaign's site only. Defaults to 0. Example: 0.

Example input: `{"end_date":"<end_date>","event_campaign_id":"<event_campaign_id>","start_date":"<start_date>"}`

### `aimtell_event_campaigns_list`

List Event Triggered Campaigns · Read-only

List a site's event-triggered push campaigns.
Returns each campaign's id, name, trigger event, content and status.
Use event_campaign_get for one campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `limit` (`string`, optional): Maximum number of results to return per page. Example: 50.
- `skip` (`string`, optional): Number of results to skip for pagination (offset). Example: 0.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_event_logs_list`

List Event Logs · Read-only

List recent custom events tracked for a website's subscribers.
Returns each event's subscriber, category, action, label, value and time.
Events trigger event campaigns.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `limit` (`integer`, optional): Maximum number of results to return per page. Example: 50.
- `skip` (`integer`, optional): Number of results to skip for pagination (offset). Example: 0.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_notification_logs_list`

List Notification Logs · Read-only

List recent notification delivery logs for a website, optionally for one subscriber.
Returns each log's subscriber, campaign, status and time.
This is a recent sample, not a full history.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `limit` (`integer`, optional): Maximum number of results to return per page. Example: 50.
- `skip` (`integer`, optional): Number of results to skip for pagination (offset). Paging past the retained notifications returns an empty result. Example: 0.
- `subscriber_uid` (`string`, optional): Optionally filter by a specific subscriber. This returns a short recent history for that subscriber, and some fields are not available on these results. Example: a1b2c3d4e5.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_pageview_logs_list`

List Pageview Logs · Read-only

List recent pageviews tracked for a website's subscribers.
Returns each pageview's subscriber, URL and time.
Use it to see subscriber browsing activity.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `limit` (`integer`, optional): Maximum number of results to return per page. Example: 50.
- `skip` (`integer`, optional): Number of results to skip for pagination (offset). Example: 0.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_pixels_list`

List Tracking Pixels · Read-only

List a website's cross-domain tracking pixels.
Returns each pixel's id, name, event and pixel URL.
Use pixel_create to add one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_prompt_get`

Get Opt-in Prompt · Read-only

Get one opt-in prompt.
Returns its name, type, texts and colors.
Use prompts_list to find prompt IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `prompt_id` (`string`, required): ID of the prompt. Get it from prompts_list. Example: 98765.

Example input: `{"prompt_id":"<prompt_id>"}`

### `aimtell_prompts_list`

List Opt-in Prompts · Read-only

List a website's opt-in prompts.
Returns each prompt's id, name, type, texts and colors.
Use prompt_get for one prompt.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_rss_campaign_get`

Get RSS Campaign · Read-only

Get one RSS campaign.
Returns its name, feed, content template, segments, frequency and status.
Use rss_campaigns_list to find campaign IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `rss_campaign_id` (`string`, required): ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.

Example input: `{"rss_campaign_id":"<rss_campaign_id>"}`

### `aimtell_rss_campaign_results_get`

Get RSS Campaign Results · Read-only

Get an RSS campaign's results per day over a date range.
Returns daily sends, clicks and conversions.
Dates are yyyy-mm-dd.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Date. Example: 2026-01-31.
- `rss_campaign_id` (`string`, required): ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.
- `start_date` (`string`, required): Date. Example: 2026-01-01.

Example input: `{"end_date":"<end_date>","rss_campaign_id":"<rss_campaign_id>","start_date":"<start_date>"}`

### `aimtell_rss_campaigns_list`

List RSS Campaigns · Read-only

List a site's RSS-driven push campaigns.
Returns each campaign's id, name, feed, content template and status.
Use rss_campaign_get for one campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `limit` (`string`, optional): Maximum number of results to return per page. Example: 50.
- `skip` (`string`, optional): Number of results to skip for pagination (offset). Example: 0.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_segment_counts_get`

Get Segment Counts Over Time · Read-only

Get how many subscribers matched a segment over a date range.
Returns daily subscriber counts.
Dates are yyyy-mm-dd.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Date as yyyy-mm-dd (i.e. 2019-12-14). Example: 2026-01-31.
- `segment_id` (`string`, required): ID of the segment. Get it from segments_list. Example: 98765.
- `start_date` (`string`, required): Date as yyyy-mm-dd (i.e. 2019-12-07). Example: 2026-01-01.

Example input: `{"end_date":"<end_date>","segment_id":"<segment_id>","start_date":"<start_date>"}`

### `aimtell_segment_get`

Get Segment · Read-only

Get one segment.
Returns its id, name, definition and site.
Use segments_list to find segment IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `segment_id` (`string`, required): ID of the segment. Get it from segments_list. Example: 98765.

Example input: `{"segment_id":"<segment_id>"}`

### `aimtell_segments_list`

List Segments · Read-only

List a website's subscriber segments.
Returns each segment's id, name and definition.
Use segment IDs to target campaigns and push_send.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_site_analytics_get`

Get Website Analytics · Read-only

Get a metric over time for one website, such as new subscribers or notification clicks.
Returns daily values for the chosen type.
Dates are yyyy-mm-dd; use account_analytics_get for all sites.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Format: yyyy-mm-dd (e.g. 2020-06-16). Example: 2026-01-31.
- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `start_date` (`string`, required): Format: yyyy-mm-dd (e.g. 2020-06-01). Example: 2026-01-01.
- `type` (`string`, required): Type of analytics data to retrieve. Example: newsubscribers. One of: `newsubscribers`, `unsubscribes`, `notifications`, `notificationclicks`, `optin`, `inactive`, `revenue`.

Example input: `{"end_date":"<end_date>","site_id":"<site_id>","start_date":"<start_date>","type":"newsubscribers"}`

### `aimtell_site_code_get`

Get Website Tracking Code · Read-only

Get the Aimtell push and tracking code to install on a website.
Returns the JavaScript snippet.
Use it after site_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_site_get`

Get Website · Read-only

Get one website.
Returns its id, name, URL, icon and settings summary.
Use sites_list to find site IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_site_permissions_list`

List Website Users · Read-only

List the users who have access to a website.
Returns each user's uid, name and email.
Use site_permission_grant to add a user.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_site_settings_get`

Get Website Settings · Read-only

Get a website's tracking settings.
Returns IP collection, attribute and event tracking flags, data retention days and daily frequency cap.
Use site_settings_update to change them.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_site_variables_list`

List Website Custom Variables · Read-only

List a website's custom variables, used as placeholders in notification content.
Returns each variable's name and value.
Use site_variable_upsert to add or change one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_sites_list`

List Websites · Read-only

List the active websites (sites) in the Aimtell account.
Returns each site's id, name, URL, icon and creation date.
Use the site id with every site-scoped tool.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`string`, optional): Maximum number of results to return per page. Example: 50.
- `load` (`string`, optional): Load Additional Information (i.e. subscriber_count). Example: segments.
- `skip` (`string`, optional): Number of results to skip for pagination (offset). Example: 0.

Example input: `{}`

### `aimtell_subscribers_list`

List Subscribers · Read-only

List a website's subscribers, optionally filtered by segment or one subscriber ID, with paging.
Returns each subscriber's uid, browser, device, location, subscription date and (with include) attributes and notifications.
Use subscriber_attributes_track to set attributes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `include` (`string`, optional): Accepts attributes, notifications, or both as a comma-separated list (e.g. attributes,notifications). Note: the read field on notifications does not indicate impressions or delivery. It is used within the Notification Center (coming soon). Example: attributes,notifications.
- `limit` (`integer`, optional): Maximum number of results to return per page. Example: 50.
- `segment_id` (`integer`, optional): The ID of the segment you wish to filter by. Example: 12346.
- `skip` (`integer`, optional): Number of results to skip for pagination (offset). Example: 0.
- `subscriber_id` (`string`, optional): The specific subscriber ID to pull data for. Example: a1b2c3d4e5.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_user_get`

Get Account User · Read-only

Get the Aimtell user that owns the API key.
Returns the user's id, name, email, timezone and account details.
Use it to confirm which account the connection uses.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `aimtell_welcome_campaign_get`

Get Welcome Campaign · Read-only

Get a site's welcome notification, sent to each new subscriber.
Returns its title, body, link, icon, image and status.
Use welcome_campaign_upsert to change it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_welcome_campaign_results_get`

Get Welcome Campaign Results · Read-only

Get a site's welcome notification results per day over a date range.
Returns daily sends, clicks and conversions.
Dates are yyyy-mm-dd.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): Date. Example: 2026-01-31.
- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `start_date` (`string`, required): Date. Example: 2026-01-01.

Example input: `{"end_date":"<end_date>","site_id":"<site_id>","start_date":"<start_date>"}`

### `aimtell_campaign_create`

Create Manual Campaign · Write

Create a manual push campaign for a site, as a draft (status 1) or scheduled (status 2) with schedule_date.
Returns the result and the new campaign id.
Target segments by ID; get them from segments_list.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Campaign Name. Example: Spring sale.
- `site_id` (`string`, required): Site ID. Example: 12345.
- `actions` (`object`, optional): action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
- `auto_hide` (`integer`, optional): Auto Hide (in seconds). Example: 1.
- `automation` (`string`, optional): Automation (d = daily, w = weekly, m = monthly, n = none). Example: n. One of: `d`, `w`, `m`, `n`.
- `body` (`string`, optional): Push Body. Example: Take 20% off everything until midnight.
- `collapse_key` (`string`, optional): replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
- `conversion_trigger` (`object`, optional): Conversion Trigger. Example: {"event_category": "purchase", "event_action": "checkout"}
- `custom_icon` (`string`, optional): url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
- `custom_image` (`string`, optional): url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.
- `link` (`string`, optional): Link. Example: https://shop.example.com/sale.
- `push_ttl` (`integer`, optional): expiration time (in seconds). Example: 86400.
- `schedule_date` (`string`, optional): DateTime (e.g. 2017-08-25 21:16:50). Example: 2026-03-01 09:00:00.
- `segments` (`string`, optional): Segments. Example: 12345,12346.
- `status` (`string`, optional): 1 = draft, 2 = scheduled. Defaults to 1. Example: 1. One of: `1`, `2`.
- `title` (`string`, optional): Push Title. Example: Flash sale ends tonight.
- `tz_delivery` (`integer`, optional): deliver based on user's timezone (set 0 for false, 1 for true). Example: 1.

Example input: `{"name":"<name>","site_id":"<site_id>"}`

### `aimtell_campaign_update`

Update Manual Campaign · Write

Update a manual push campaign's content, schedule, segments or status.
Returns the result.
For A/B campaigns also pass version_b with its status.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`string`, required): ID of the campaign. Get it from campaigns_list. Example: 98765.
- `actions` (`object`, optional): action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
- `auto_hide` (`integer`, optional): Auto Hide (in seconds). Example: 1.
- `automation` (`string`, optional): Automation (d = daily, w = weekly, m = monthly, n = none). Example: n. One of: `d`, `w`, `m`, `n`.
- `automation_end` (`string`, optional): Automation End Date (e.g. 2017-08-25 17:00:00). Example: 2026-06-01 00:00:00.
- `body` (`string`, optional): Push Body. Example: Take 20% off everything until midnight.
- `collapse_key` (`string`, optional): replace visible notifications on a subscribers device replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
- `conversion_trigger` (`object`, optional): Conversion Trigger. Example: {"event_category": "purchase", "event_action": "checkout"}
- `custom_icon` (`string`, optional): url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
- `custom_image` (`string`, optional): url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.
- `link` (`string`, optional): Push Link. Example: https://shop.example.com/sale.
- `name` (`string`, optional): Name of Campaign. Example: Spring sale.
- `push_ttl` (`integer`, optional): Expiration Time (in seconds). Example: 86400.
- `schedule_date` (`string`, optional): DateTime (i.e. 2017-08-25 21:16:50). Example: 2026-03-01 09:00:00.
- `segments` (`string`, optional): Segments. Example: 12345,12346.
- `status` (`integer`, optional): set 1 for draft, 2 for scheduled. Defaults to 1. Example: 1. One of: `1`, `2`.
- `title` (`string`, optional): Push Title. Example: Flash sale ends tonight.
- `tz_delivery` (`integer`, optional): deliver based on user's timezone (set 0 for false, 1 for true). Example: 1.
- `version_b` (`object`, optional): (optional) Version B for A/B test campaign. Example: {"title": "Last chance: 20% off", "body": "Sale ends at midnight.", "status": 1}

Example input: `{"campaign_id":"<campaign_id>"}`

### `aimtell_event_campaign_create`

Create Event Triggered Campaign · Write

Create an event-triggered campaign shell with a name.
Returns the result and the new campaign id.
Then set its trigger event, content and drip delays with event_campaign_update.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Campaign Name. Example: Spring sale.
- `site_id` (`string`, required): Site ID. Example: 12345.

Example input: `{"name":"<name>","site_id":"<site_id>"}`

### `aimtell_event_campaign_update`

Update Event Triggered Campaign · Write

Update an event-triggered campaign's trigger event, content, drip delays or target device.
Returns the result.
The campaign fires when a subscriber records the matching event.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `event_campaign_id` (`string`, required): ID of the event campaign. Get it from event_campaigns_list. Example: 98765.
- `actions` (`object`, optional): action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
- `body` (`string`, optional): Push Body Message. Example: Take 20% off everything until midnight.
- `collapse_key` (`string`, optional): replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
- `custom_icon` (`string`, optional): url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
- `custom_image` (`string`, optional): url of custom image to use (recommended size: 300x500)). Example: https://cdn.example.com/banner-300x500.png.
- `delay` (`integer`, optional): Time in seconds after event when push should be sent. Example: 3600.
- `drip` (`string`, optional): Comma separated integer values representing delays as seconds from event. Example: 60, 300, 3600.
- `event_action` (`string`, optional): Event Action. Example: checkout.
- `event_category` (`string`, optional): Event Category. Example: purchase.
- `event_label` (`string`, optional): Event Label. Example: cart-abandoned.
- `link` (`string`, optional): Push Notification Link. Example: https://shop.example.com/sale.
- `name` (`string`, optional): Name of Campaign. Example: Spring sale.
- `status` (`integer`, optional): set 1 for draft, 5 for active. Example: 1.
- `target_device` (`string`, optional): device type to target (optional). can be either: "any", "mobile" or "desktop". Example: any. One of: `any`, `mobile`, `desktop`.
- `title` (`string`, optional): Push Title. Example: Flash sale ends tonight.

Example input: `{"event_campaign_id":"<event_campaign_id>"}`

### `aimtell_pixel_create`

Create Tracking Pixel · Write

Create a cross-domain tracking pixel that records an event when loaded, for example on a checkout page.
Returns the result and the pixel id.
Place the pixel on the other domain's page.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the pixel. Example: Spring sale.
- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"name":"<name>","site_id":"<site_id>"}`

### `aimtell_pixel_update`

Update Tracking Pixel · Write

Update a tracking pixel's name and the event it records.
Returns the result.
Pass both name and value.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the pixel. Example: Spring sale.
- `pixel_id` (`string`, required): ID of the pixel. Get it from pixels_list. Example: 98765.
- `value` (`object`, required): Value. Example: {"event_category": "purchase", "event_action": "checkout", "event_label": "pro-plan", "event_value": 49}

Example input: `{"name":"<name>","pixel_id":"<pixel_id>","value":{"event_category":"purchase","event_action":"checkout","event_label":"pro-plan","event_value":49}}`

### `aimtell_prompt_create`

Create Opt-in Prompt · Write

Create an opt-in prompt for a website (type 1 is a top-left drop-down, 3 a centered box).
Returns the result and the prompt id.
Customize its texts and colors with prompt_update.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `site_id` (`string`, required): Website ID. Example: 12345.
- `name` (`string`, optional): Prompt Name. Example: Spring sale.
- `type` (`integer`, optional): top left drop down prompt = 1 , middle rectangle prompt = 3. Example: 1. One of: `1`, `3`.

Example input: `{"site_id":"<site_id>"}`

### `aimtell_prompt_update`

Update Opt-in Prompt · Write

Update an opt-in prompt's header, body and button texts and colors.
Returns the result.
Colors are hex values like #4e99cf.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `prompt_id` (`string`, required): ID of the prompt. Get it from prompts_list. Example: 98765.
- `approve_button_color` (`string`, optional): Prompt Approve Button Color (hexadecimal color e.g. #4e99cf). Example: #4e99cf.
- `approve_button_text` (`string`, optional): Prompt Approve Button Text. Example: Allow.
- `approve_button_text_color` (`string`, optional): Prompt Approve Button Text Color (hexadecimal color e.g. #ffffff). Example: #ffffff.
- `body_text` (`string`, optional): Prompt Body Text. Example: We'll only send the good stuff.
- `body_text_color` (`string`, optional): Prompt Body Text Color (hexadecimal color e.g. #000000). Example: #333333.
- `cancel_button_color` (`string`, optional): Prompt Cancel Button Color (hexadecimal color e.g. #4e99cf). Example: #999999.
- `cancel_button_text` (`string`, optional): Prompt Cancel Button Text. Example: No thanks.
- `cancel_button_text_color` (`string`, optional): Prompt Cancel Button Text Color (hexadecimal color e.g. #ffffff). Example: #ffffff.
- `header_text` (`string`, optional): Prompt Header Text. Example: Get deal alerts.
- `header_text_color` (`string`, optional): Prompt Header Text Color (hexadecimal color e.g. #000000). Example: #000000.
- `icon_url` (`string`, optional): Prompt Icon URL. Example: https://www.example.com/logo.png.
- `name` (`string`, optional): Prompt Name. Example: Spring sale.

Example input: `{"prompt_id":"<prompt_id>"}`

### `aimtell_push_send`

Send Push Notification · Write

Send a one-off push notification right away to specific subscribers, a segment, or an alias (user==... or email==...).
Returns the result and the push campaign id.
Target with exactly one of subscriber_uids, segment_id or alias. Use campaign_create for scheduled or recurring sends.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): Notification Body. Example: Take 20% off everything until midnight.
- `link` (`string`, required): Notification Link. Example: https://shop.example.com/sale.
- `site_id` (`integer`, required): Site ID. Example: 12345.
- `title` (`string`, required): Notification Title. Example: Flash sale ends tonight.
- `actions` (`object`, optional): Action Buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
- `alias` (`string`, optional): A subscriber alias in the form type==value, where type is user or email (e.g. user==jack17 or email==jack@example.com). An email value can also be its MD5 hash. A value without == is not valid. Example: email==jane@example.com.
- `auto_hide` (`integer`, optional): Number of seconds (255 max) until the notification will hide automatically. Default is 0, which is persistent (requires interaction). Example: 1.
- `collapse_key` (`string`, optional): replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
- `custom_icon` (`string`, optional): url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
- `custom_image` (`string`, optional): url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.
- `push_ttl` (`integer`, optional): Time till a push should expire in seconds. Default is 1 week. Example: 86400.
- `segment_id` (`integer`, optional): Segment ID. Example: 12346.
- `subscriber_uids` (`array`, optional): Subscriber UIDS. Example: ["a1b2c3d4e5"]

Example input: `{"body":"<body>","link":"<link>","site_id":12345,"title":"<title>"}`

### `aimtell_rss_campaign_create`

Create RSS Campaign · Write

Create an RSS campaign shell with a name.
Returns the result and the new campaign id.
Then set its content, segments and frequency with rss_campaign_update.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Campaign Name. Example: Spring sale.
- `site_id` (`string`, required): Site ID. Example: 12345.

Example input: `{"name":"<name>","site_id":"<site_id>"}`

### `aimtell_rss_campaign_update`

Update RSS Campaign · Write

Update an RSS campaign's content, segments or sending frequency.
Returns the result.
Use max_type hourly or daily to cap sends.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `rss_campaign_id` (`string`, required): ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.
- `status` (`integer`, required): set 1 for draft, 2 for active. Example: 1.
- `actions` (`object`, optional): Actions. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
- `body` (`string`, optional): Push Body Message. Example: Take 20% off everything until midnight.
- `collapse_key` (`string`, optional): replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
- `custom_icon` (`string`, optional): url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
- `custom_image` (`string`, optional): url of custom image to use (recommended size: 300x500)). Example: https://cdn.example.com/banner-300x500.png.
- `feed_url` (`string`, optional): URL of RSS feed. Example: https://www.example.com/blog/feed.xml.
- `link` (`string`, optional): Push Notification Link. Example: https://shop.example.com/sale.
- `max_enabled` (`integer`, optional): enable maximum number of sends — set 0 for false, 1 for true. Example: 10.
- `max_type` (`string`, optional): hourly or daily. Example: daily. One of: `hourly`, `daily`.
- `max_value` (`integer`, optional): maximum number of sends e.g. 5 or 20. Example: 10.
- `name` (`string`, optional): Name of Campaign. Example: Spring sale.
- `segments` (`string`, optional): Segments — comma separated list with no spaces e.g. 12345,12346,12347. Example: 12345,12346.
- `title` (`string`, optional): Push Title. Example: Flash sale ends tonight.

Example input: `{"rss_campaign_id":"<rss_campaign_id>","status":1}`

### `aimtell_segment_create`

Create Segment · Write

Create a subscriber segment from a condition definition.
Returns the result and the new segment id.
Use segment_counts_get to see how many subscribers match.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `definition` (`string`, required): Segment rule as Aimtell's condition string, for example region==California. Read an existing segment with segment_get to see the format. Example: region==California.
- `name` (`string`, required): Name of Segment. Example: Spring sale.
- `site_id` (`string`, required): Site ID. Example: 12345.

Example input: `{"definition":"<definition>","name":"<name>","site_id":"<site_id>"}`

### `aimtell_segment_update`

Update Segment · Write

Update a segment's name or definition.
Returns the result.
Campaigns targeting it use the new definition from then on.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `segment_id` (`string`, required): ID of the segment. Get it from segments_list. Example: 98765.
- `definition` (`string`, optional): Segment rule as Aimtell's condition string, for example region==California. Read an existing segment with segment_get to see the format. Example: region==California.
- `name` (`string`, optional): Name of Segment. Example: Spring sale.

Example input: `{"segment_id":"<segment_id>"}`

### `aimtell_site_create`

Add Website · Write

Add a website to the Aimtell account.
Returns the result and the new site id.
Install the tracking code from site_code_get on the website afterwards.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of Website. Example: Spring sale.
- `url` (`string`, required): Website URL. Example: https://www.example.com.

Example input: `{"name":"<name>","url":"<url>"}`

### `aimtell_site_permission_grant`

Grant Website Access · Write

Give a registered Aimtell user access to a website by email.
Returns the result.
The person must already have an Aimtell account.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): email address of registered user. Example: jane@example.com.
- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"email":"<email>","site_id":"<site_id>"}`

### `aimtell_site_settings_update`

Update Website Settings · Write

Update a website's tracking settings. Aimtell requires every setting on each call.
Returns the result.
Read the current values with site_settings_get first.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `collect_ip` (`integer`, required): Allow collection of IP Address (0 = false, 1 = true). Defaults to 1. Example: 1.
- `collect_ip_as_attribute` (`integer`, required): Automatically track IP address as a custom attribute (0 = false, 1 = true). Defaults to 0. Example: 0.
- `collect_suburl` (`integer`, required): Automatically track subscription URL as custom attribute (0 = false, 1 = true). Defaults to 0. Example: 0.
- `collect_ua_as_attribute` (`integer`, required): Automatically track User Agent as custom attribute (0 = false, 1 = true). Defaults to 1. Example: 1.
- `frequency_cap` (`integer`, required): Max number of notifications a subscriber can receive per day. Defaults to 15. Example: 15.
- `retention_length` (`integer`, required): Number of days to keep data for deleted subscribers. Defaults to 30. Example: 30.
- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `track_clicks_as_events` (`integer`, required): Automatically track notification clicks as custom events. (0 = false, 1 = true). Defaults to 0. Example: 0.
- `track_subscribe_as_event` (`integer`, required): Automatically track subscriptions as custom events. (0 = false, 1 = true). Defaults to 0. Example: 0.

Example input: `{"collect_ip":1,"collect_ip_as_attribute":0,"collect_suburl":0,"collect_ua_as_attribute":1,"frequency_cap":15,"retention_length":30,"site_id":"<site_id>","track_clicks_as_events":0,"track_subscribe_as_event":0}`

### `aimtell_site_update`

Update Website · Write

Update a website's name or icon.
Returns the result.
The website URL cannot be changed.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): Website Name. Example: Spring sale.
- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `icon` (`string`, optional): URL of Website Icon. Example: https://www.example.com/favicon.png.

Example input: `{"name":"<name>","site_id":"<site_id>"}`

### `aimtell_site_variable_upsert`

Upsert Website Custom Variable · Write

Create or update a website custom variable by name.
Returns the result.
Variables can be used in notification content.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of Custom Variable. Example: coupon_code.
- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.
- `value` (`string`, required): Value of Custom Variable. Example: SPRING20.

Example input: `{"name":"<name>","site_id":"<site_id>","value":"<value>"}`

### `aimtell_subscriber_attributes_track`

Track Subscriber Attributes · Write

Set custom attributes on a subscriber, identified by subscriber_uid, user alias or email alias.
Returns the result.
Attributes can then be used in segment definitions.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `attributes` (`string`, required): JSON. Example: {"plan": "pro", "city": "Austin"}
- `site_id` (`string`, required): Website ID. Example: 12345.
- `email` (`string`, optional): Subscriber "Email" Alias. Example: jane@example.com.
- `subscriber_uid` (`string`, optional): Aimtell Subscriber ID. Example: a1b2c3d4e5.
- `user` (`string`, optional): Subscriber "User" Alias. Example: jack17.

Example input: `{"attributes":"<attributes>","site_id":"<site_id>"}`

### `aimtell_welcome_campaign_upsert`

Update Welcome Campaign · Write

Create or update a site's welcome notification.
Returns the result.
Set status 1 to activate it, 0 to keep it as a draft.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): Push Body. Example: Take 20% off everything until midnight.
- `link` (`string`, required): Link. Example: https://shop.example.com/sale.
- `site_id` (`string`, required): Site ID. Example: 12345.
- `status` (`string`, required): 0 = draft, 1 = active. Defaults to 0. Example: 1. One of: `0`, `1`.
- `title` (`string`, required): Push Title. Example: Flash sale ends tonight.
- `actions` (`object`, optional): action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
- `conversion_trigger` (`object`, optional): Conversion Trigger. Example: {"event_category": "purchase", "event_action": "checkout"}
- `custom_icon` (`string`, optional): url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
- `custom_image` (`string`, optional): url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.

Example input: `{"body":"<body>","link":"<link>","site_id":"<site_id>","status":"0","title":"<title>"}`

### `aimtell_campaign_delete`

Delete Manual Campaign · Destructive

Delete a manual push campaign.
Returns the result.
Scheduled sends for it are cancelled.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `campaign_id` (`string`, required): ID of the campaign. Get it from campaigns_list. Example: 98765.

Example input: `{"campaign_id":"<campaign_id>"}`

### `aimtell_event_campaign_delete`

Delete Event Triggered Campaign · Destructive

Delete an event-triggered campaign.
Returns the result.
It stops firing immediately.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `event_campaign_id` (`string`, required): ID of the event campaign. Get it from event_campaigns_list. Example: 98765.

Example input: `{"event_campaign_id":"<event_campaign_id>"}`

### `aimtell_pixel_delete`

Delete Tracking Pixel · Destructive

Delete a tracking pixel.
Returns the result.
Pages that load it stop recording the event.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `pixel_id` (`string`, required): ID of the pixel. Get it from pixels_list. Example: 98765.

Example input: `{"pixel_id":"<pixel_id>"}`

### `aimtell_prompt_delete`

Delete Opt-in Prompt · Destructive

Delete an opt-in prompt.
Returns the result.
The prompt stops showing on the website.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `prompt_id` (`string`, required): ID of the prompt. Get it from prompts_list. Example: 98765.

Example input: `{"prompt_id":"<prompt_id>"}`

### `aimtell_rss_campaign_delete`

Delete RSS Campaign · Destructive

Delete an RSS campaign.
Returns the result.
It stops sending immediately.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `rss_campaign_id` (`string`, required): ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.

Example input: `{"rss_campaign_id":"<rss_campaign_id>"}`

### `aimtell_segment_delete`

Delete Segment · Destructive

Delete a segment.
Returns the result.
Campaigns that target it lose that audience.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `segment_id` (`string`, required): ID of the segment. Get it from segments_list. Example: 98765.

Example input: `{"segment_id":"<segment_id>"}`

### `aimtell_site_delete`

Delete Website · Destructive

Delete a website from the account, with its subscribers and campaigns.
Returns the result.
This cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `site_id` (`string`, required): Aimtell site (website) ID. Get it from sites_list. Example: 12345.

Example input: `{"site_id":"<site_id>"}`

## Related

Other Marketing connectors ([all 190](/agentkit/connectors/?category=marketing)):

- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twitter / X](/agentkit/connectors/twitteroauth/): Scalekit connector, OAuth, 92 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
