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.
- Tools
- 60
- What they doRead · write · destructive
- 31 · 21 · 831 read21 write8 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the SendPulse connection
In AgentKit > Connections, create a SendPulse connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'sendpulse'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'sendpulse_balance_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "sendpulse"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="sendpulse_balance_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their SendPulse credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolsendpulse_balance_getGet the account balance and the plan limits and usage for email, SMTP and web push.Read-onlyGet Account Balance
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.
Inputs
This tool takes no inputs.
sendpulse_blacklist_listList the email addresses on the account blacklist.Read-onlyList Blacklist
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.
Inputs
This tool takes no inputs.
sendpulse_campaign_contact_getGet what happened to one recipient in a campaign (sent, delivered, opened, clicked, bounced).Read-onlyGet Campaign Result for Contact
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.
Inputs
campaign_idintegerrequired- Campaign ID, from sendpulse_campaigns_list. Example: 1234567
emailstringrequired- Recipient email address. Example: jane@example.com
sendpulse_campaign_getGet one campaign with its status and delivery statistics.Read-onlyGet Campaign
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.
Inputs
campaign_idintegerrequired- Campaign ID, from sendpulse_campaigns_list. Example: 1234567
sendpulse_campaign_referrals_getGet click counts for each link in a campaign.Read-onlyGet Campaign Link Clicks
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.
Inputs
campaign_idintegerrequired- Campaign ID, from sendpulse_campaigns_list. Example: 1234567
sendpulse_campaigns_listList email campaigns with their status.Read-onlyList Campaigns
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.
Inputs
limitinteger- Number of campaigns to return (up to 100). Example: 50
offsetinteger- Number of campaigns to skip. Example: 0
orderstring- Sort order by date. One of: asc, desc. Example: descone of
ascdesc planedboolean- If true, return only scheduled campaigns. Example: true
statusstring- Campaign status codes to include, comma-separated (for example 3 for sent). Example: 3
sendpulse_contact_campaign_stats_getGet campaign engagement statistics for one email address across campaigns.Read-onlyGet Contact Campaign Stats
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.
Inputs
emailstringrequired- Email address. Example: jane@example.com
sendpulse_contact_getFind every mailing list an email address is in, with its status and variables in each.Read-onlyGet Contact Lists
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.
Inputs
emailstringrequired- Email address. Example: jane@example.com
sendpulse_list_campaigns_listList the campaigns sent to a mailing list.Read-onlyList Campaigns for Mailing List
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.
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
limitinteger- Number of campaigns to return. Example: 50
offsetinteger- Number of campaigns to skip. Example: 0
sendpulse_list_contact_getGet one contact in a mailing list, with its status, phone and variables.Read-onlyGet Mailing List Contact
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.
Inputs
emailstringrequired- Contact email address. Example: jane@example.com
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
sendpulse_list_contacts_find_by_variableFind contacts in a mailing list whose variable equals a value.Read-onlyFind Contacts by Variable
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.
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
search_valuestringrequired- Value to match. Example: Jane
variable_namestringrequired- Variable name, as listed by sendpulse_list_variables_list. Example: Name
sendpulse_list_contacts_listList the contacts in a mailing list with their status and variables.Read-onlyList Mailing List Contacts
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.
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
activeboolean- If true, return only active contacts. Example: true
limitinteger- Number of contacts to return. Example: 100
not_activeboolean- If true, return only inactive contacts. Example: false
offsetinteger- Number of contacts to skip. Example: 0
orderstring- Sort order. One of: asc, desc. Example: descone of
ascdesc
sendpulse_list_contacts_total_getCount the contacts in a mailing list.Read-onlyCount Mailing List Contacts
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.
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
activeboolean- If true, count only active contacts. Example: true
sendpulse_list_getGet one mailing list with its total, active and inactive contact counts and status.Read-onlyGet Mailing List
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.
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
sendpulse_list_variables_listList the custom variables (fields such as Name or Phone) defined on a mailing list.Read-onlyList Mailing List Variables
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.
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
sendpulse_lists_listList the mailing lists (address books) in the account with their contact counts.Read-onlyList Mailing Lists
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.
Inputs
limitinteger- Number of records. Example: 50
offsetinteger- Offset (first record to be displayed) Example: 0
sendpulse_senders_listList the sender (From) addresses on the account for campaigns, with their status.Read-onlyList Senders
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.
Inputs
This tool takes no inputs.
sendpulse_smtp_bounces_listList hard and soft bounces for a 24-hour period, with SMTP answer codes.Read-onlyList SMTP Bounces
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.
Inputs
datestring- Day to report, Y-m-d (default today). Example: 2026-11-15
limitinteger- Number of bounces to return. Example: 100
offsetinteger- Number of bounces to skip. Example: 0
sendpulse_smtp_email_getGet delivery and tracking details for one sent transactional email, including the SMTP answer and open and click events.Read-onlyGet Sent Email
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.
Inputs
email_idstringrequired- Email ID returned by sendpulse_smtp_email_send or sendpulse_smtp_emails_list. Example: a5b3c1d2e4f6
sendpulse_smtp_emails_listList transactional emails sent over SMTP, filtered by date range, sender, recipient or country.Read-onlyList Sent Emails
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.
Inputs
countrystring- Set to true to include the recipient country. Example: true
fromstring- Start date, Y-m-d. Example: 2026-11-01
limitinteger- Number of emails to return (up to 500). Example: 100
offsetinteger- Number of emails to skip. Example: 0
recipientstring- Recipient email address. Example: jane@example.com
senderstring- Sender email address. Example: orders@example.com
tostring- End date, Y-m-d. Example: 2026-11-15
sendpulse_smtp_senders_listList the sender addresses authorized for SMTP sending.Read-onlyList SMTP Senders
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.
Inputs
This tool takes no inputs.
sendpulse_smtp_unsubscribe_checkCheck whether an email address is on the SMTP suppression list.Read-onlyCheck SMTP Unsubscribe
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.
Inputs
emailstringrequired- Email address to check. Example: jane@example.com
sendpulse_smtp_unsubscribes_listList addresses on the SMTP suppression list and why they are there (link, user, spam complaint).Read-onlyList SMTP Unsubscribes
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.
Inputs
datestring- Only unsubscribes on this day, Y-m-d. Example: 2026-11-15
limitinteger- Number of records to return. Example: 100
offsetinteger- Number of records to skip. Example: 0
sendpulse_template_getGet one email template by ID, including its HTML.Read-onlyGet Template
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.
Inputs
template_idstringrequired- Template ID. Example: 775667
langstring- Template language code. Example: en
ownerstring- Template owner. One of: me, sendpulse. Example: meone of
mesendpulse
sendpulse_template_get_by_slugGet one email template by its name slug.Read-onlyGet Template by Slug
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.
Inputs
name_slugstringrequired- Template name slug. Example: welcome-email
langstring- Template language code. Example: en
ownerstring- Template owner. One of: me, sendpulse. Example: meone of
mesendpulse
sendpulse_templates_listList email templates, either your own or SendPulse system templates.Read-onlyList Templates
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.
Inputs
limitinteger- Number of records. Example: 50
offsetinteger- Offset (first record to be displayed) Example: 0
only_activeboolean- If true, list only active templates. Example: true
ownerstring- Whose templates to list. One of: me, sendpulse. Example: meone of
mesendpulse
sendpulse_verifier_email_result_getGet the verification result for one email address.Read-onlyGet Email Verification Result
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.
Inputs
emailstringrequired- Email address that was verified. Example: jane@example.com
sendpulse_verifier_list_results_getGet the verification status of each address in a verified mailing list.Read-onlyGet List Verification Results
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.
Inputs
list_idintegerrequired- Mailing list ID. Example: 756589
countinteger- Number of addresses to return. Example: 100
startinteger- Number of addresses to skip. Example: 0
sendpulse_verifier_lists_listList the mailing lists that have been verified, with a summary of each.Read-onlyList Verified Mailing Lists
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.
Inputs
countinteger- Number of lists to return. Example: 50
startinteger- Number of lists to skip. Example: 0
sendpulse_verifier_progress_getGet the progress of a running mailing list verification.Read-onlyGet List Verification Progress
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.
Inputs
list_idintegerrequired- Mailing list ID being verified. Example: 756589
sendpulse_blacklist_addAdd email addresses to the blacklist so campaigns are never sent to them.WriteAdd to Blacklist
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.
- Idempotent
Inputs
emailsarrayrequired- Email addresses to blacklist; they are joined and base64-encoded for you. Example: ["spam@example.com"]
commentstring- Reason for blacklisting. Example: Requested removal
sendpulse_campaign_createCreate an email campaign to a mailing list or segment and send it now, at a scheduled time, or save it as a draft.WriteCreate Campaign
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).
Inputs
sender_emailstringrequired- Sender's email address. Example: my_sender@test.com
sender_namestringrequired- Sender's name. Example: my_sender_name
subjectstringrequired- Email subject. Example: hello customer
bodystring- HTML of the email; it is base64-encoded for you. Required if template_id is not given. Example: <h1>Hello</h1><p>Our spring sale starts today.</p>
is_testboolean- If true, sends one test email to sender_email instead of the list. Example: false
list_idinteger- Mailing list ID to send to. Required if segment_id is not given. Example: 756589
namestring- Campaign name. Example: Spring sale
segment_idinteger- Segment ID created in your account. Example: 12345
send_datestring- 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_idinteger- ID of a template from sendpulse_templates_list. Required if body is not given. Example: 775667
typestring- Set to draft to save the campaign without sending. Example: draft One of: draft.one of
draft use_dynamic_listboolean- If true, contacts added to the list after creation but before sending also receive it. Example: false
sendpulse_campaign_updateChange the name or subject of a campaign that has not been sent yet.WriteUpdate Scheduled Campaign
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.
- Idempotent
Inputs
campaign_idintegerrequired- Campaign ID, from sendpulse_campaigns_list. Example: 1234567
namestring- New campaign name. Example: Spring sale v2
subjectstring- New email subject. Example: Our spring sale starts today
sendpulse_list_contact_variables_updateSet variable values for one contact in a mailing list.WriteUpdate Contact Variables
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.
- Idempotent
Inputs
emailstringrequired- Email address of the contact. Example: jane@example.com
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
variablesarrayrequired- Variables to set, each with a name and a value. Example: [{"name": "Name", "value": "Jane"}]
sendpulse_list_contacts_addAdd contacts to a mailing list without a confirmation email (single opt-in), optionally with variable values.WriteAdd Contacts to Mailing List
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.
Inputs
emailsarrayrequired- 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_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
sendpulse_list_contacts_unsubscribeMark contacts in a mailing list as unsubscribed, keeping them in the list.WriteUnsubscribe Mailing List Contacts
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.
Inputs
emailsarrayrequired- Email addresses to unsubscribe. Example: ["jane@example.com"]
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
sendpulse_list_createCreate a new, empty mailing list.WriteCreate Mailing List
Create a new, empty mailing list. Returns an object with id. Use sendpulse_list_create before adding contacts with sendpulse_list_contacts_add.
Inputs
book_namestringrequired- Name of the new mailing list. Example: Newsletter subscribers
sendpulse_list_updateRename a mailing list.WriteRename Mailing List
Rename a mailing list. Returns an object with result. Use sendpulse_list_update to change a list name.
- Idempotent
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
namestringrequired- New name for the mailing list. Example: Customers 2026
sendpulse_sender_activateActivate a sender address with the code SendPulse emailed to it.WriteActivate Sender
Activate a sender address with the code SendPulse emailed to it. Returns an object with result. Use sendpulse_sender_activate after sendpulse_sender_create.
Inputs
codestringrequired- Activation code from the email. Example: 8d1f3c
emailstringrequired- Sender email address. Example: news@example.com
sendpulse_sender_activation_code_requestSend the activation code email to a sender address again.WriteResend Sender Activation Code
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.
Inputs
emailstringrequired- Sender email address. Example: news@example.com
sendpulse_sender_createAdd a sender address.WriteAdd Sender
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.
Inputs
emailstringrequired- Sender email address. Example: news@example.com
namestringrequired- Sender name shown to recipients. Example: Acme News
sendpulse_smtp_email_sendSend one transactional email over SendPulse SMTP, with your own HTML or a saved template.WriteSend Transactional Email
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).
Inputs
from_emailstringrequired- Sender email address; must be an activated SMTP sender. Example: orders@example.com.
from_namestringrequired- Sender name. Example: Acme Store.
subjectstringrequired- Email subject. Example: Your order has shipped.
toarrayrequired- Recipients, each with an email and optional name. Example: [{"name": "Jane Doe", "email": "jane@example.com"}].
auto_plain_textboolean- If true, SendPulse builds the plain-text version from the HTML. Example: true.
bccarray- BCC recipients, each with an email and optional name. Example: [{"email": "archive@example.com"}].
ccarray- CC recipients, each with an email and optional name. Example: [{"email": "boss@example.com"}].
htmlstring- HTML body; it is base64-encoded for you. Give html or template_id. Example: Your order #1001 has shipped.
reply_toobject- Reply-to address with an email and optional name. Example: {"name": "Support", "email": "support@example.com"}.
template_idstring- ID of a saved template to use instead of html. Example: 775667.
template_variablesobject- Values for the template variables. Use with template_id. Example: {"order_id": "1001"}.
textstring- Plain-text body. Example: Your order #1001 has shipped.
sendpulse_smtp_unsubscribe_addAdd email addresses to the SMTP suppression list so transactional email is no longer delivered to them.WriteUnsubscribe from SMTP
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.
- Idempotent
Inputs
emailsarrayrequired- Addresses to suppress, each with an email and an optional comment. Example: [{"email": "jane@example.com", "comment": "Asked to stop"}].
sendpulse_tag_assignAdd one or more tags to an email address.WriteTag Contact
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.
- Idempotent
Inputs
emailstringrequired- Contact email address. Example: jane@example.com
tagsarrayrequired- Tag names to add. Example: ["vip"]
sendpulse_tag_createCreate a contact tag.WriteCreate Tag
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.
Inputs
colorstringrequired- Tag colour as a hex code. Example: #ff9900
namestringrequired- Tag name. Example: vip
sendpulse_tag_unassignRemove one or more tags from an email address.WriteUntag Contact
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.
- Idempotent
Inputs
emailstringrequired- Contact email address. Example: jane@example.com
tagsarrayrequired- Tag names to remove. Example: ["vip"]
sendpulse_tag_updateRename or recolour a tag.WriteUpdate Tag
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.
- Idempotent
Inputs
colorstringrequired- Tag colour as a hex code. Example: #ff9900
namestringrequired- Tag name. Example: vip
tag_idintegerrequired- Tag ID from sendpulse_tags_list. Example: 123
sendpulse_template_createCreate a reusable email template from HTML.WriteCreate Template
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.
Inputs
bodystringrequired- Template HTML; it is base64-encoded for you. Example: <h1>Welcome!</h1>
langstring- Template language code. Example: en One of: en, ru, ua, tr, es, pt.one of
enruuatrespt namestring- Template name. Example: Welcome email
sendpulse_template_updateReplace the HTML of an existing template.WriteUpdate Template
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.
- Idempotent
Inputs
bodystringrequired- New template HTML; it is base64-encoded for you. Example: <h1>Welcome back!</h1>
template_idintegerrequired- Template ID. Example: 775667
langstring- Template language code. Example: en One of: en, ru, ua, tr, es, pt.one of
enruuatrespt
sendpulse_verifier_email_verifyStart verification of one email address (paid from the verifier balance).WriteVerify Email Address
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.
Inputs
emailstringrequired- Email address to verify. Example: jane@example.com
sendpulse_verifier_list_verifyStart verification of every address in a mailing list (paid from the verifier balance).WriteVerify Mailing List
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.
Inputs
list_idintegerrequired- Mailing list ID to verify. Example: 756589
sendpulse_blacklist_removeRemove email addresses from the blacklist.DestructiveRemove from Blacklist
Remove email addresses from the blacklist. Returns an object with result. Use sendpulse_blacklist_remove to allow campaigns to an address again.
- Idempotent
Inputs
emailsarrayrequired- Email addresses to remove; they are joined and base64-encoded for you. Example: ["jane@example.com"]
sendpulse_campaign_cancelCancel a scheduled or sending campaign.DestructiveCancel Campaign
Cancel a scheduled or sending campaign. Returns an object with result. Use sendpulse_campaign_cancel to stop a campaign before it finishes.
- Idempotent
Inputs
campaign_idintegerrequired- Campaign ID, from sendpulse_campaigns_list. Example: 1234567
sendpulse_contact_deleteRemove an email address from every mailing list in the account.DestructiveDelete Contact Everywhere
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.
- Idempotent
Inputs
emailstringrequired- Email address to remove. Example: jane@example.com
sendpulse_list_contacts_deleteRemove email addresses from a mailing list.DestructiveRemove Contacts from Mailing List
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.
- Idempotent
Inputs
emailsarrayrequired- Email addresses to remove. Example: ["jane@example.com"]
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
sendpulse_list_deletePermanently delete a mailing list and its contacts.DestructiveDelete Mailing List
Permanently delete a mailing list and its contacts. Returns an object with result. Use sendpulse_list_delete only to remove a list for good.
- Idempotent
Inputs
list_idintegerrequired- Mailing list ID, from sendpulse_lists_list. Example: 756589
sendpulse_sender_deleteRemove a sender address.DestructiveDelete Sender
Remove a sender address. Returns an object with result. Use sendpulse_sender_delete to stop using a From address.
- Idempotent
Inputs
emailstringrequired- Sender email address to remove. Example: news@example.com
sendpulse_smtp_unsubscribe_removeRemove email addresses from the SMTP suppression list.DestructiveRemove SMTP Unsubscribe
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.
- Idempotent
Inputs
emailsarrayrequired- Email addresses to remove from the suppression list. Example: ["jane@example.com"].
sendpulse_tag_deleteDelete a tag.DestructiveDelete Tag
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.
- Idempotent
Inputs
tag_idintegerrequired- Tag ID from sendpulse_tags_list. Example: 123
No tools match.