> **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 SendPulse

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

**Authentication:** Bearer Token
**Categories:** Marketing, Communication
**Tools:** 60: 31 read, 21 write, 8 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=SENDPULSE)

## 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 SendPulse connection

   In **AgentKit > Connections**, create a SendPulse 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 = 'sendpulse'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize SendPulse:', 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: 'sendpulse_balance_get',
     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 = "sendpulse"
   identifier = "user_123"

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

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

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their SendPulse 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: 'sendpulse_balance_get',
  toolInput: {},
  connector: 'sendpulse',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="sendpulse_balance_get",
    tool_input={},
    connection_name="sendpulse",
    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.

### `sendpulse_balance_get`

Get Account Balance · Read-only

Get the account balance and the plan limits and usage for email, SMTP and web push.
Returns an object with balance, email, smtp, push.
Use sendpulse_balance_get to check credit before a large send.

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

Inputs: none.

Example input: `{}`

### `sendpulse_blacklist_list`

List Blacklist · Read-only

List the email addresses on the account blacklist.
Returns an array of objects.
Use sendpulse_blacklist_list to check suppressed addresses for campaigns. Use sendpulse_smtp_unsubscribes_list for SMTP.

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

Inputs: none.

Example input: `{}`

### `sendpulse_campaign_contact_get`

Get Campaign Result for Contact · Read-only

Get what happened to one recipient in a campaign (sent, delivered, opened, clicked, bounced).
Returns an object with sent_date, global_status, global_status_explain, detail_status, detail_status_explain.
Use sendpulse_campaign_contact_get to trace one recipient. Use sendpulse_contact_campaign_stats_get for all campaigns of an address.

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

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from sendpulse_campaigns_list. Example: 1234567
- `email` (`string`, required): Recipient email address. Example: jane@example.com

Example input: `{"campaign_id":1234567,"email":"<email>"}`

### `sendpulse_campaign_get`

Get Campaign · Read-only

Get one campaign with its status and delivery statistics.
Returns an object with id, name, status.
Use sendpulse_campaign_get to read results of a campaign. Use sendpulse_campaign_referrals_get for link clicks.

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

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from sendpulse_campaigns_list. Example: 1234567

Example input: `{"campaign_id":1234567}`

### `sendpulse_campaign_referrals_get`

Get Campaign Link Clicks · Read-only

Get click counts for each link in a campaign.
Returns an array of objects with link, count.
Use sendpulse_campaign_referrals_get for link performance. Use sendpulse_campaign_get for overall statistics.

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

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from sendpulse_campaigns_list. Example: 1234567

Example input: `{"campaign_id":1234567}`

### `sendpulse_campaigns_list`

List Campaigns · Read-only

List email campaigns with their status.
Returns an array of objects with id, name, status.
Use sendpulse_campaigns_list to find a campaign ID. Use sendpulse_campaign_get for its statistics.

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

Inputs:

- `limit` (`integer`, optional): Number of campaigns to return (up to 100). Example: 50
- `offset` (`integer`, optional): Number of campaigns to skip. Example: 0
- `order` (`string`, optional): Sort order by date. One of: asc, desc. Example: desc. One of: `asc`, `desc`.
- `planed` (`boolean`, optional): If true, return only scheduled campaigns. Example: true
- `status` (`string`, optional): Campaign status codes to include, comma-separated (for example 3 for sent). Example: 3

Example input: `{}`

### `sendpulse_contact_campaign_stats_get`

Get Contact Campaign Stats · Read-only

Get campaign engagement statistics for one email address across campaigns.
Returns an object with statistic.
Use sendpulse_contact_campaign_stats_get for a contact history. Use sendpulse_campaign_contact_get for one campaign.

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

Inputs:

- `email` (`string`, required): Email address. Example: jane@example.com

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

### `sendpulse_contact_get`

Get Contact Lists · Read-only

Find every mailing list an email address is in, with its status and variables in each.
Returns an array of objects with book_id, email.
Use sendpulse_contact_get across all lists. Use sendpulse_list_contact_get for one list.

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

Inputs:

- `email` (`string`, required): Email address. Example: jane@example.com

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

### `sendpulse_list_campaigns_list`

List Campaigns for Mailing List · Read-only

List the campaigns sent to a mailing list.
Returns an array of objects with task_id.
Use sendpulse_list_campaigns_list for one list. Use sendpulse_campaigns_list for all campaigns.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589
- `limit` (`integer`, optional): Number of campaigns to return. Example: 50
- `offset` (`integer`, optional): Number of campaigns to skip. Example: 0

Example input: `{"list_id":756589}`

### `sendpulse_list_contact_get`

Get Mailing List Contact · Read-only

Get one contact in a mailing list, with its status, phone and variables.
Returns an object with email, abook_id, phone, status, status_explain, variables.
Use sendpulse_list_contact_get for a contact in one list. Use sendpulse_contact_get to find every list an address is in.

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

Inputs:

- `email` (`string`, required): Contact email address. Example: jane@example.com
- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589

Example input: `{"email":"<email>","list_id":756589}`

### `sendpulse_list_contacts_find_by_variable`

Find Contacts by Variable · Read-only

Find contacts in a mailing list whose variable equals a value.
Returns an array of objects with email, status, status_explain.
Use sendpulse_list_contacts_find_by_variable to look contacts up by a field such as Phone or Name.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589
- `search_value` (`string`, required): Value to match. Example: Jane
- `variable_name` (`string`, required): Variable name, as listed by sendpulse_list_variables_list. Example: Name

Example input: `{"list_id":756589,"search_value":"<search_value>","variable_name":"<variable_name>"}`

### `sendpulse_list_contacts_list`

List Mailing List Contacts · Read-only

List the contacts in a mailing list with their status and variables.
Returns an array of objects with email, status, status_explain, variables.
Use sendpulse_list_contacts_list to page through a list. Use sendpulse_list_contact_get for one address.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589
- `active` (`boolean`, optional): If true, return only active contacts. Example: true
- `limit` (`integer`, optional): Number of contacts to return. Example: 100
- `not_active` (`boolean`, optional): If true, return only inactive contacts. Example: false
- `offset` (`integer`, optional): Number of contacts to skip. Example: 0
- `order` (`string`, optional): Sort order. One of: asc, desc. Example: desc. One of: `asc`, `desc`.

Example input: `{"list_id":756589}`

### `sendpulse_list_contacts_total_get`

Count Mailing List Contacts · Read-only

Count the contacts in a mailing list.
Returns an object with total.
Use sendpulse_list_contacts_total_get for a count only. Use sendpulse_list_contacts_list for the contacts.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589
- `active` (`boolean`, optional): If true, count only active contacts. Example: true

Example input: `{"list_id":756589}`

### `sendpulse_list_get`

Get Mailing List · Read-only

Get one mailing list with its total, active and inactive contact counts and status.
Returns an array of objects with id, name, all_email_qty, active_email_qty, inactive_email_qty, creationdate, status, status_explain.
Use sendpulse_list_get to check one list. Use sendpulse_lists_list to browse lists.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589

Example input: `{"list_id":756589}`

### `sendpulse_list_variables_list`

List Mailing List Variables · Read-only

List the custom variables (fields such as Name or Phone) defined on a mailing list.
Returns an array of objects with name, type.
Use sendpulse_list_variables_list before sendpulse_list_contact_variables_update or sendpulse_list_contacts_find_by_variable.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589

Example input: `{"list_id":756589}`

### `sendpulse_lists_list`

List Mailing Lists · Read-only

List the mailing lists (address books) in the account with their contact counts.
Returns an array of objects with id, name, all_email_qty, active_email_qty, inactive_email_qty, creationdate, status, status_explain.
Use sendpulse_lists_list to find a mailing list ID. Use sendpulse_list_get for one list.

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

Inputs:

- `limit` (`integer`, optional): Number of records. Example: 50
- `offset` (`integer`, optional): Offset (first record to be displayed) Example: 0

Example input: `{}`

### `sendpulse_senders_list`

List Senders · Read-only

List the sender (From) addresses on the account for campaigns, with their status.
Returns an array of objects with email, name.
Use sendpulse_senders_list to pick a sender_email for sendpulse_campaign_create. Use sendpulse_smtp_senders_list for SMTP senders.

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

Inputs: none.

Example input: `{}`

### `sendpulse_smtp_bounces_list`

List SMTP Bounces · Read-only

List hard and soft bounces for a 24-hour period, with SMTP answer codes.
Returns an object with total, emails, request_limit, found.
Use sendpulse_smtp_bounces_list to review failed deliveries.

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

Inputs:

- `date` (`string`, optional): Day to report, Y-m-d (default today). Example: 2026-11-15
- `limit` (`integer`, optional): Number of bounces to return. Example: 100
- `offset` (`integer`, optional): Number of bounces to skip. Example: 0

Example input: `{}`

### `sendpulse_smtp_email_get`

Get Sent Email · Read-only

Get delivery and tracking details for one sent transactional email, including the SMTP answer and open and click events.
Returns an object with id, sender, total_size, sender_ip, smtp_answer_code, smtp_answer_subcode, smtp_answer_data, used_ip, recipient, subject, and more.
Use sendpulse_smtp_email_get to debug one delivery.

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

Inputs:

- `email_id` (`string`, required): Email ID returned by sendpulse_smtp_email_send or sendpulse_smtp_emails_list. Example: a5b3c1d2e4f6

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

### `sendpulse_smtp_emails_list`

List Sent Emails · Read-only

List transactional emails sent over SMTP, filtered by date range, sender, recipient or country.
Returns an array of objects with id, sender, total_size, sender_ip, smtp_answer_code, smtp_answer_subcode, smtp_answer_data, used_ip.
Use sendpulse_smtp_emails_list to find sent messages. Use sendpulse_smtp_email_get for one message in full.

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

Inputs:

- `country` (`string`, optional): Set to true to include the recipient country. Example: true
- `from` (`string`, optional): Start date, Y-m-d. Example: 2026-11-01
- `limit` (`integer`, optional): Number of emails to return (up to 500). Example: 100
- `offset` (`integer`, optional): Number of emails to skip. Example: 0
- `recipient` (`string`, optional): Recipient email address. Example: jane@example.com
- `sender` (`string`, optional): Sender email address. Example: orders@example.com
- `to` (`string`, optional): End date, Y-m-d. Example: 2026-11-15

Example input: `{}`

### `sendpulse_smtp_senders_list`

List SMTP Senders · Read-only

List the sender addresses authorized for SMTP sending.
Returns an array of objects.
Use sendpulse_smtp_senders_list to pick from_email for sendpulse_smtp_email_send.

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

Inputs: none.

Example input: `{}`

### `sendpulse_smtp_unsubscribe_check`

Check SMTP Unsubscribe · Read-only

Check whether an email address is on the SMTP suppression list.
Returns an object with result.
Use sendpulse_smtp_unsubscribe_check before sending to an address.

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

Inputs:

- `email` (`string`, required): Email address to check. Example: jane@example.com

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

### `sendpulse_smtp_unsubscribes_list`

List SMTP Unsubscribes · Read-only

List addresses on the SMTP suppression list and why they are there (link, user, spam complaint).
Returns an array of objects with email, unsubscribe_by_link, unsubscribe_by_user, spam_complaint, date.
Use sendpulse_smtp_unsubscribes_list to sync opt-outs. Use sendpulse_smtp_unsubscribe_check for one address.

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

Inputs:

- `date` (`string`, optional): Only unsubscribes on this day, Y-m-d. Example: 2026-11-15
- `limit` (`integer`, optional): Number of records to return. Example: 100
- `offset` (`integer`, optional): Number of records to skip. Example: 0

Example input: `{}`

### `sendpulse_tags_list`

List Tags · Read-only

List the contact tags in the account.
Returns an object with tags, user_id, version.
Use sendpulse_tags_list to find a tag ID or name.

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

Inputs: none.

Example input: `{}`

### `sendpulse_template_get`

Get Template · Read-only

Get one email template by ID, including its HTML.
Returns an object with id, name.
Use sendpulse_template_get by ID. Use sendpulse_template_get_by_slug by name slug.

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

Inputs:

- `template_id` (`string`, required): Template ID. Example: 775667
- `lang` (`string`, optional): Template language code. Example: en
- `owner` (`string`, optional): Template owner. One of: me, sendpulse. Example: me. One of: `me`, `sendpulse`.

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

### `sendpulse_template_get_by_slug`

Get Template by Slug · Read-only

Get one email template by its name slug.
Returns an object with id, name.
Use sendpulse_template_get_by_slug when you know the slug. Use sendpulse_template_get by ID.

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

Inputs:

- `name_slug` (`string`, required): Template name slug. Example: welcome-email
- `lang` (`string`, optional): Template language code. Example: en
- `owner` (`string`, optional): Template owner. One of: me, sendpulse. Example: me. One of: `me`, `sendpulse`.

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

### `sendpulse_templates_list`

List Templates · Read-only

List email templates, either your own or SendPulse system templates.
Returns an array of objects with id, name.
Use sendpulse_templates_list to find a template ID for sendpulse_campaign_create.

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

Inputs:

- `limit` (`integer`, optional): Number of records. Example: 50
- `offset` (`integer`, optional): Offset (first record to be displayed) Example: 0
- `only_active` (`boolean`, optional): If true, list only active templates. Example: true
- `owner` (`string`, optional): Whose templates to list. One of: me, sendpulse. Example: me. One of: `me`, `sendpulse`.

Example input: `{}`

### `sendpulse_verifier_email_result_get`

Get Email Verification Result · Read-only

Get the verification result for one email address.
Returns an object with result, data.
Use sendpulse_verifier_email_result_get after sendpulse_verifier_email_verify.

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

Inputs:

- `email` (`string`, required): Email address that was verified. Example: jane@example.com

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

### `sendpulse_verifier_list_results_get`

Get List Verification Results · Read-only

Get the verification status of each address in a verified mailing list.
Returns an object with id, address_book_name, all_emails_quantity, status, check_date, data, is_updated, status_text, email_addresses, email_addresses_total.
Use sendpulse_verifier_list_results_get once verification is finished.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID. Example: 756589
- `count` (`integer`, optional): Number of addresses to return. Example: 100
- `start` (`integer`, optional): Number of addresses to skip. Example: 0

Example input: `{"list_id":756589}`

### `sendpulse_verifier_lists_list`

List Verified Mailing Lists · Read-only

List the mailing lists that have been verified, with a summary of each.
Returns list[] (each with id, address_book_name, all_emails_quantity, status, check_date, data, is_updated, status_text) plus total.
Use sendpulse_verifier_lists_list to see past verifications.

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

Inputs:

- `count` (`integer`, optional): Number of lists to return. Example: 50
- `start` (`integer`, optional): Number of lists to skip. Example: 0

Example input: `{}`

### `sendpulse_verifier_progress_get`

Get List Verification Progress · Read-only

Get the progress of a running mailing list verification.
Returns an object with result, data.
Use sendpulse_verifier_progress_get after sendpulse_verifier_list_verify.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID being verified. Example: 756589

Example input: `{"list_id":756589}`

### `sendpulse_blacklist_add`

Add to Blacklist · Write

Add email addresses to the blacklist so campaigns are never sent to them.
Returns an object with result.
Use sendpulse_blacklist_add to suppress addresses. Use sendpulse_blacklist_remove to undo.

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

Inputs:

- `emails` (`array`, required): Email addresses to blacklist; they are joined and base64-encoded for you. Example: ["spam@example.com"]
- `comment` (`string`, optional): Reason for blacklisting. Example: Requested removal

Example input: `{"emails":["spam@example.com"]}`

### `sendpulse_campaign_create`

Create Campaign · Write

Create an email campaign to a mailing list or segment and send it now, at a scheduled time, or save it as a draft.
Returns an object with id, status, count, tariff_email_qty, overdraft_price, ovedraft_currency.
Use sendpulse_campaign_create to send bulk email. Use sendpulse_smtp_email_send for a single transactional email.
Give either body or template_id, and either list_id or segment_id. The sender must be activated (see sendpulse_senders_list).

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

Inputs:

- `sender_email` (`string`, required): Sender's email address. Example: my_sender@test.com
- `sender_name` (`string`, required): Sender's name. Example: my_sender_name
- `subject` (`string`, required): Email subject. Example: hello customer
- `body` (`string`, optional): HTML of the email; it is base64-encoded for you. Required if template_id is not given. Example: <h1>Hello</h1>Our spring sale starts today.

- `is_test` (`boolean`, optional): If true, sends one test email to sender_email instead of the list. Example: false
- `list_id` (`integer`, optional): Mailing list ID to send to. Required if segment_id is not given. Example: 756589
- `name` (`string`, optional): Campaign name. Example: Spring sale
- `segment_id` (`integer`, optional): Segment ID created in your account. Example: 12345
- `send_date` (`string`, optional): When to send, as Y-m-d H:i:s; must not be in the past. Leave empty to send now. Example: 2026-12-01 09:00:00
- `template_id` (`integer`, optional): ID of a template from sendpulse_templates_list. Required if body is not given. Example: 775667
- `type` (`string`, optional): Set to draft to save the campaign without sending. Example: draft One of: draft. One of: `draft`.
- `use_dynamic_list` (`boolean`, optional): If true, contacts added to the list after creation but before sending also receive it. Example: false

Example input: `{"sender_email":"<sender_email>","sender_name":"<sender_name>","subject":"<subject>"}`

### `sendpulse_campaign_update`

Update Scheduled Campaign · Write

Change the name or subject of a campaign that has not been sent yet.
Returns an object with result, id.
Use sendpulse_campaign_update for a scheduled campaign. Use sendpulse_campaign_cancel to stop it.

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

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from sendpulse_campaigns_list. Example: 1234567
- `name` (`string`, optional): New campaign name. Example: Spring sale v2
- `subject` (`string`, optional): New email subject. Example: Our spring sale starts today

Example input: `{"campaign_id":1234567}`

### `sendpulse_list_contact_variables_update`

Update Contact Variables · Write

Set variable values for one contact in a mailing list.
Returns an object with result.
Use sendpulse_list_contact_variables_update to change a contact field such as Name.
Call sendpulse_list_variables_list to see the variable names on the list.

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

Inputs:

- `email` (`string`, required): Email address of the contact. Example: jane@example.com
- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589
- `variables` (`array`, required): Variables to set, each with a name and a value. Example: [{"name": "Name", "value": "Jane"}]

Example input: `{"email":"<email>","list_id":756589,"variables":[{"name":"Name","value":"Jane"}]}`

### `sendpulse_list_contacts_add`

Add Contacts to Mailing List · Write

Add contacts to a mailing list without a confirmation email (single opt-in), optionally with variable values.
Returns an object with result.
Use sendpulse_list_contacts_add to subscribe new contacts. Use sendpulse_list_contact_variables_update to change a contact already in the list.

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

Inputs:

- `emails` (`array`, required): Contacts to add. Each item has an email and an optional variables object of variable name to value. Example: [{"email": "jane@example.com", "variables": {"Name": "Jane", "Phone": "+15555550101"}}]
- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589

Example input: `{"emails":[{"email":"jane@example.com","variables":{"Name":"Jane","Phone":"+15555550101"}}],"list_id":756589}`

### `sendpulse_list_contacts_unsubscribe`

Unsubscribe Mailing List Contacts · Write

Mark contacts in a mailing list as unsubscribed, keeping them in the list.
Returns an object with result.
Use sendpulse_list_contacts_unsubscribe to honour an opt-out. Use sendpulse_list_contacts_delete to remove contacts.

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

Inputs:

- `emails` (`array`, required): Email addresses to unsubscribe. Example: ["jane@example.com"]
- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589

Example input: `{"emails":["jane@example.com"],"list_id":756589}`

### `sendpulse_list_create`

Create Mailing List · Write

Create a new, empty mailing list.
Returns an object with id.
Use sendpulse_list_create before adding contacts with sendpulse_list_contacts_add.

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

Inputs:

- `book_name` (`string`, required): Name of the new mailing list. Example: Newsletter subscribers

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

### `sendpulse_list_update`

Rename Mailing List · Write

Rename a mailing list.
Returns an object with result.
Use sendpulse_list_update to change a list name.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589
- `name` (`string`, required): New name for the mailing list. Example: Customers 2026

Example input: `{"list_id":756589,"name":"<name>"}`

### `sendpulse_sender_activate`

Activate Sender · Write

Activate a sender address with the code SendPulse emailed to it.
Returns an object with result.
Use sendpulse_sender_activate after sendpulse_sender_create.

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

Inputs:

- `code` (`string`, required): Activation code from the email. Example: 8d1f3c
- `email` (`string`, required): Sender email address. Example: news@example.com

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

### `sendpulse_sender_activation_code_request`

Resend Sender Activation Code · Write

Send the activation code email to a sender address again.
Returns an object with result.
Use sendpulse_sender_activation_code_request when the first activation email was lost.

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

Inputs:

- `email` (`string`, required): Sender email address. Example: news@example.com

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

### `sendpulse_sender_create`

Add Sender · Write

Add a sender address. SendPulse emails it an activation code.
Returns an object with result.
Use sendpulse_sender_create to add a new From address, then sendpulse_sender_activate with the code.

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

Inputs:

- `email` (`string`, required): Sender email address. Example: news@example.com
- `name` (`string`, required): Sender name shown to recipients. Example: Acme News

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

### `sendpulse_smtp_email_send`

Send Transactional Email · Write

Send one transactional email over SendPulse SMTP, with your own HTML or a saved template.
Returns an object with result, id.
Use sendpulse_smtp_email_send for a one-off message such as a receipt or password reset. Use sendpulse_campaign_create for bulk email.
Give html (or text) or template_id. from_email must be an activated SMTP sender (see sendpulse_smtp_senders_list).

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

Inputs:

- `from_email` (`string`, required): Sender email address; must be an activated SMTP sender. Example: orders@example.com.
- `from_name` (`string`, required): Sender name. Example: Acme Store.
- `subject` (`string`, required): Email subject. Example: Your order has shipped.
- `to` (`array`, required): Recipients, each with an email and optional name. Example: [{"name": "Jane Doe", "email": "jane@example.com"}].
- `auto_plain_text` (`boolean`, optional): If true, SendPulse builds the plain-text version from the HTML. Example: true.
- `bcc` (`array`, optional): BCC recipients, each with an email and optional name. Example: [{"email": "archive@example.com"}].
- `cc` (`array`, optional): CC recipients, each with an email and optional name. Example: [{"email": "boss@example.com"}].
- `html` (`string`, optional): HTML body; it is base64-encoded for you. Give html or template_id. Example: Your order #1001 has shipped.
- `reply_to` (`object`, optional): Reply-to address with an email and optional name. Example: {"name": "Support", "email": "support@example.com"}.
- `template_id` (`string`, optional): ID of a saved template to use instead of html. Example: 775667.
- `template_variables` (`object`, optional): Values for the template variables. Use with template_id. Example: {"order_id": "1001"}.
- `text` (`string`, optional): Plain-text body. Example: Your order #1001 has shipped.

Example input: `{"from_email":"<from_email>","from_name":"<from_name>","subject":"<subject>","to":[{"name":"Jane Doe","email":"jane@example.com"}]}`

### `sendpulse_smtp_unsubscribe_add`

Unsubscribe from SMTP · Write

Add email addresses to the SMTP suppression list so transactional email is no longer delivered to them.
Returns an object with result.
Use sendpulse_smtp_unsubscribe_add to honour an opt-out. Use sendpulse_smtp_unsubscribe_remove to undo.

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

Inputs:

- `emails` (`array`, required): Addresses to suppress, each with an email and an optional comment. Example: [{"email": "jane@example.com", "comment": "Asked to stop"}].

Example input: `{"emails":[{"email":"jane@example.com","comment":"Asked to stop"}]}`

### `sendpulse_tag_assign`

Tag Contact · Write

Add one or more tags to an email address.
Returns an object with code, description, failure, http_code, queue_id, success, user_id, version.
Use sendpulse_tag_assign to tag a contact. Use sendpulse_tag_unassign to remove tags.

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

Inputs:

- `email` (`string`, required): Contact email address. Example: jane@example.com
- `tags` (`array`, required): Tag names to add. Example: ["vip"]

Example input: `{"email":"<email>","tags":["vip"]}`

### `sendpulse_tag_create`

Create Tag · Write

Create a contact tag.
Returns an object with code, description, failure, http_code, queue_id, success, user_id, version.
Use sendpulse_tag_create before assigning a new tag with sendpulse_tag_assign.

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

Inputs:

- `color` (`string`, required): Tag colour as a hex code. Example: #ff9900
- `name` (`string`, required): Tag name. Example: vip

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

### `sendpulse_tag_unassign`

Untag Contact · Write

Remove one or more tags from an email address.
Returns an object with code, description, failure, http_code, queue_id, success, user_id, version.
Use sendpulse_tag_unassign to untag a contact. Use sendpulse_tag_assign to add tags.

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

Inputs:

- `email` (`string`, required): Contact email address. Example: jane@example.com
- `tags` (`array`, required): Tag names to remove. Example: ["vip"]

Example input: `{"email":"<email>","tags":["vip"]}`

### `sendpulse_tag_update`

Update Tag · Write

Rename or recolour a tag.
Returns an object with code, description, failure, http_code, queue_id, success, user_id, version.
Use sendpulse_tag_update to change a tag.

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

Inputs:

- `color` (`string`, required): Tag colour as a hex code. Example: #ff9900
- `name` (`string`, required): Tag name. Example: vip
- `tag_id` (`integer`, required): Tag ID from sendpulse_tags_list. Example: 123

Example input: `{"color":"<color>","name":"<name>","tag_id":123}`

### `sendpulse_template_create`

Create Template · Write

Create a reusable email template from HTML.
Returns an object with result, real_id.
Use sendpulse_template_create to save HTML for campaigns. Use sendpulse_template_update to change an existing template.

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

Inputs:

- `body` (`string`, required): Template HTML; it is base64-encoded for you. Example: <h1>Welcome!</h1>
- `lang` (`string`, optional): Template language code. Example: en One of: en, ru, ua, tr, es, pt. One of: `en`, `ru`, `ua`, `tr`, `es`, `pt`.
- `name` (`string`, optional): Template name. Example: Welcome email

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

### `sendpulse_template_update`

Update Template · Write

Replace the HTML of an existing template.
Returns an object with result.
Use sendpulse_template_update to change a template. Use sendpulse_template_create for a new one.

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

Inputs:

- `body` (`string`, required): New template HTML; it is base64-encoded for you. Example: <h1>Welcome back!</h1>
- `template_id` (`integer`, required): Template ID. Example: 775667
- `lang` (`string`, optional): Template language code. Example: en One of: en, ru, ua, tr, es, pt. One of: `en`, `ru`, `ua`, `tr`, `es`, `pt`.

Example input: `{"body":"<body>","template_id":775667}`

### `sendpulse_verifier_email_verify`

Verify Email Address · Write

Start verification of one email address (paid from the verifier balance).
Returns an object with result.
Use sendpulse_verifier_email_verify for one address, then sendpulse_verifier_email_result_get for the result.

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

Inputs:

- `email` (`string`, required): Email address to verify. Example: jane@example.com

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

### `sendpulse_verifier_list_verify`

Verify Mailing List · Write

Start verification of every address in a mailing list (paid from the verifier balance).
Returns an object with result.
Use sendpulse_verifier_list_verify to clean a list, then sendpulse_verifier_progress_get to follow it.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID to verify. Example: 756589

Example input: `{"list_id":756589}`

### `sendpulse_blacklist_remove`

Remove from Blacklist · Destructive

Remove email addresses from the blacklist.
Returns an object with result.
Use sendpulse_blacklist_remove to allow campaigns to an address again.

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

Inputs:

- `emails` (`array`, required): Email addresses to remove; they are joined and base64-encoded for you. Example: ["jane@example.com"]

Example input: `{"emails":["jane@example.com"]}`

### `sendpulse_campaign_cancel`

Cancel Campaign · Destructive

Cancel a scheduled or sending campaign.
Returns an object with result.
Use sendpulse_campaign_cancel to stop a campaign before it finishes.

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

Inputs:

- `campaign_id` (`integer`, required): Campaign ID, from sendpulse_campaigns_list. Example: 1234567

Example input: `{"campaign_id":1234567}`

### `sendpulse_contact_delete`

Delete Contact Everywhere · Destructive

Remove an email address from every mailing list in the account.
Returns an object with result.
Use sendpulse_contact_delete for a full removal, for example a data deletion request. Use sendpulse_list_contacts_delete for one list.

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

Inputs:

- `email` (`string`, required): Email address to remove. Example: jane@example.com

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

### `sendpulse_list_contacts_delete`

Remove Contacts from Mailing List · Destructive

Remove email addresses from a mailing list.
Returns an object with result.
Use sendpulse_list_contacts_delete to take contacts out of one list. Use sendpulse_contact_delete to remove an address from every list.

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

Inputs:

- `emails` (`array`, required): Email addresses to remove. Example: ["jane@example.com"]
- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589

Example input: `{"emails":["jane@example.com"],"list_id":756589}`

### `sendpulse_list_delete`

Delete Mailing List · Destructive

Permanently delete a mailing list and its contacts.
Returns an object with result.
Use sendpulse_list_delete only to remove a list for good.

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

Inputs:

- `list_id` (`integer`, required): Mailing list ID, from sendpulse_lists_list. Example: 756589

Example input: `{"list_id":756589}`

### `sendpulse_sender_delete`

Delete Sender · Destructive

Remove a sender address.
Returns an object with result.
Use sendpulse_sender_delete to stop using a From address.

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

Inputs:

- `email` (`string`, required): Sender email address to remove. Example: news@example.com

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

### `sendpulse_smtp_unsubscribe_remove`

Remove SMTP Unsubscribe · Destructive

Remove email addresses from the SMTP suppression list.
Returns an object with result.
Use sendpulse_smtp_unsubscribe_remove to deliver to an address again after it opted back in.

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

Inputs:

- `emails` (`array`, required): Email addresses to remove from the suppression list. Example: ["jane@example.com"].

Example input: `{"emails":["jane@example.com"]}`

### `sendpulse_tag_delete`

Delete Tag · Destructive

Delete a tag.
Returns an object with code, description, failure, http_code, queue_id, success, user_id, version.
Use sendpulse_tag_delete to remove a tag from the account.

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

Inputs:

- `tag_id` (`integer`, required): Tag ID from sendpulse_tags_list. Example: 123

Example input: `{"tag_id":123}`

## 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 |
