Clicksend

Learn how to use Clicksend with Composio

Overview

SLUG: CLICKSEND

Description

Business Communications. Solved.

Authentication Details

username
stringRequired
password
stringRequired

Connecting to Clicksend

Create an auth config

Use the dashboard to create an auth config for the Clicksend toolkit. This allows you to connect multiple Clicksend accounts to Composio for agents to use.

1

Select App

Navigate to Clicksend.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Clicksend Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using Basic Auth

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5clicksend_auth_config_id = "ac_YOUR_CLICKSEND_CONFIG_ID"
6user_id = "user@example.com"
7username = "your_clicksend_username"
8password = "your_clicksend_password"
9
10composio = Composio()
11
12# Create a new connected account for Clicksend using Basic Auth
13connection_request = composio.connected_accounts.initiate(
14 user_id=user_id,
15 auth_config_id=clicksend_auth_config_id,
16 config=auth_scheme.basic_auth(
17 username=username,
18 password=password
19 )
20)
21
22# Basic authentication is immediate - no redirect needed
23print(f"Successfully connected Clicksend for user {user_id}")
24
25# You can verify the connection using:
26# connected_account = composio.connected_accounts.get(user_id=user_id, app_id="CLICKSEND")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Clicksend toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Get Account Usage by Subaccount

Description

Tool to retrieve account usage statistics by subaccount for a specific month and year. Use when you need to view usage breakdown across subaccounts for billing or monitoring purposes.

Action Parameters

month
integerRequired
year
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Send Account Activation Token

Description

Tool to send an account activation token for verification. Use when you need to verify a new user account via SMS or other verification method.

Action Parameters

country
string
type
string
user_phone
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Verify New Account

Description

Tool to verify a new ClickSend account using an activation token. Use when you need to activate a newly created account with the token received during registration.

Action Parameters

activation_token
integerRequired

Action Response

data
string
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Calculate Post Letter Price

Description

Tool to calculate the price for sending post letters without actually sending them. Use when you need to estimate the cost of postal letters before sending.

Action Parameters

colour
integer
duplex
integer
file_url
stringRequired
priority_post
integer
recipients
arrayRequired
source
string
template_used
integer

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Calculate SMS Campaign Price

Description

Tool to calculate the price for an SMS campaign before sending. Use when you need to estimate costs for an SMS campaign to a contact list. Pricing depends on the number of recipients, message length, and destination countries.

Action Parameters

body
stringRequired
from
string
list_id
integerRequired
name
stringRequired
schedule
integer
url_to_shorten
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Email Delivery Receipt Automation

Description

Tool to create an email delivery receipt automation rule in ClickSend. Use when you need to set up automated actions to trigger when email delivery receipts are received.

Action Parameters

action
string
action_address
string
enabled
integer
match_type
integer
rule_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Inbound Fax Automation

Description

Tool to create a new inbound fax automation rule in ClickSend. Use when you need to set up automated actions to trigger when inbound faxes are received.

Action Parameters

action
stringRequired
action_address
stringRequired
dedicated_number
stringRequired
enabled
integerRequired
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Fax Delivery Receipt Automation

Description

Tool to create a fax delivery receipt automation rule in ClickSend. Use when you need to set up automated actions to trigger when fax delivery receipts are received.

Action Parameters

action
stringRequired
action_address
stringRequired
enabled
integer
match_type
integer
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Inbound SMS Automation

Description

Tool to create a new inbound SMS automation rule in ClickSend. Use when you need to set up automated actions to trigger when inbound SMS messages are received.

Action Parameters

action
stringRequired
action_address
stringRequired
dedicated_number
stringRequired
enabled
integerRequired
message_search_term
string
message_search_type
integerRequired
rule_name
stringRequired
webhook_type
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create SMS Delivery Receipt Automation

Description

Tool to create an SMS delivery receipt automation rule in ClickSend. Use when you need to set up automated actions to trigger when SMS delivery receipts are received.

Action Parameters

action
string
action_address
string
enabled
integer
match_type
integer
rule_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Voice Delivery Receipt Automation

Description

Tool to create a voice delivery receipt automation rule in ClickSend. Use when you need to set up automated actions to forward voice delivery receipts to a specified URL or email when voice messages are delivered.

Action Parameters

action
stringRequired
action_address
stringRequired
enabled
integerRequired
match_type
integerRequired
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Delivery Issue

Description

Tool to create a delivery issue report in ClickSend. Use when you need to report problems with message delivery such as messages not being received or delivery failures.

Action Parameters

client_comments
string
description
stringRequired
email_address
stringRequired
message_id
string
type
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Allowed Email Address

Description

Tool to create an allowed email address for sending transactional emails. Use when you need to add a new sender email address to your ClickSend account. The address will need to be verified before it can be used for sending.

Action Parameters

email_address
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Allowed Email Addresses

Description

Tool to retrieve list of allowed email addresses for sending transactional emails. Use when you need to view verified sender addresses configured in your ClickSend account.

Action Parameters

limit
integerDefaults to 15
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Email Template from Master

Description

Tool to create a new email template from an existing master template. Use when you need to create a custom email template based on a predefined master template.

Action Parameters

template_id_master
integerRequired
template_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Add Fax Delivery Receipt Webhook

Description

Tool to add a webhook URL for fax delivery receipt notifications. Use when you need to configure an endpoint to receive real-time fax delivery status updates.

Action Parameters

url
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Contact List

Description

Tool to create a new contact list in your ClickSend account. Use when you need to organize contacts into separate lists for targeted messaging campaigns. Note: API allows up to 2,000 contact lists per account.

Action Parameters

list_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Contact in List

Description

Tool to create a new contact in a specific contact list in your ClickSend account. Use when you need to add a contact to a list. At least one of phone_number, email, or fax_number must be provided.

Action Parameters

address_city
string
address_country
string
address_line_1
string
address_line_2
string
address_postal_code
string
address_state
string
custom_1
string
custom_2
string
custom_3
string
custom_4
string
email
string
fax_number
string
first_name
string
last_name
string
list_id
integerRequired
organization_name
string
phone_number
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Send MMS Messages

Description

Tool to send MMS messages with media attachments to recipients. Use when you need to send multimedia messages with images or media files to one or more phone numbers.

Action Parameters

media_file
stringRequired
messages
arrayRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Send Direct Mail Campaign

Description

Tool to create and send a direct mail campaign to specified locations. Use when you need to send physical mail pieces to targeted geographic areas. The campaign calculates pricing based on size, quantity, and target locations.

Action Parameters

areas
arrayRequired
file_urls
arrayRequired
name
stringRequired
size
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Detect Address from PDF or String

Description

Tool to detect and convert addresses to standard format from PDF or address string. Use when you need to parse a PDF document or address string to extract structured address information. The PDF should have the recipient's name and address at the top.

Action Parameters

address
string
content
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Send Post Letter

Description

Tool to send physical letters through ClickSend's postal service. Use when you need to send a PDF document as a physical letter to one or more recipients. For docx/doc files, convert them first using /uploads?convert=post endpoint.

Action Parameters

colour
integer
duplex
integer
file_url
stringRequired
priority_post
integer
recipients
arrayRequired
source
string
template_used
integer

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Post Return Address

Description

Tool to create a new post return address for ClickSend postal services. Use when you need to add a return address for sending letters or postcards through ClickSend.

Action Parameters

address_city
stringRequired
address_country
stringRequired
address_line_1
stringRequired
address_line_2
string
address_name
stringRequired
address_postal_code
stringRequired
address_state
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Post Return Addresses

Description

Tool to retrieve a list of all post return addresses from ClickSend account with pagination. Use when you need to view all configured return addresses for postal mail services.

Action Parameters

limit
integerDefaults to 15
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create and Send SMS Campaign

Description

Tool to create and send an SMS campaign to a contact list. Use when you need to send bulk SMS messages to up to 20,000 recipients per call. Marketing messages must include opt-out mechanism.

Action Parameters

body
stringRequired
from
string
list_id
integerRequired
name
stringRequired
schedule
integer
url_to_shorten
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Email-to-SMS Allowed Address

Description

Tool to create an allowed email address for email-to-SMS conversion. Use when you need to authorize a specific email address to send SMS messages through ClickSend's email-to-SMS gateway.

Action Parameters

email_address
stringRequired
from
stringRequired
from_fax
string
subaccount_id
integer

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS Email-to-SMS Allowed Address

Description

Tool to retrieve a specific allowed email address for SMS email-to-SMS by its ID. Use when you need to view detailed information about a specific allowed email address configured for email-to-SMS functionality.

Action Parameters

email_address_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Email-to-SMS Allowed Address

Description

Tool to update a specific allowed email address for email-to-SMS. Use when you need to modify an existing email address configuration including sender number, voice settings, or language preferences.

Action Parameters

email_address
stringRequired
email_address_id
integerRequired
from
stringRequired
lang
string
voice
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete SMS Email-to-SMS Allowed Address

Description

Tool to delete a specific allowed email address from SMS email-to-SMS settings. Use when you need to remove an email address from your allowed email addresses list for email-to-SMS functionality.

Action Parameters

email_address_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Email to SMS Stripped String Rule

Description

Tool to create an email to SMS stripped string rule. Use when you need to automatically remove specific text (like email signatures) from email-to-SMS messages.

Action Parameters

strip_string
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Test Inbound SMS

Description

Tool to create a test inbound SMS webhook configuration in ClickSend. Use when you need to add a test inbound SMS message to verify webhook setup.

Action Parameters

method
string
url
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Add SMS Delivery Receipt Webhook

Description

Tool to add a test SMS delivery receipt webhook in ClickSend. Use when you need to configure a webhook URL to receive SMS delivery receipts or set it to 'poll' for manual retrieval.

Action Parameters

url
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Send SMS Messages

Description

Tool to send one or more SMS messages via ClickSend. Use when you need to send SMS messages to recipients. Supports up to 1000 messages per API call and provides detailed status for each message.

Action Parameters

messages
arrayRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create SMS Template

Description

Tool to create a new SMS template for reuse in campaigns. Use when you need to save an SMS message as a reusable template.

Action Parameters

body
stringRequired
template_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Create Subaccount

Description

Tool to create a new subaccount in ClickSend with access permissions and credentials. Use when you need to set up a new subaccount for segregating services or users.

Action Parameters

access_billing
integer
access_contacts
integer
access_reporting
integer
access_settings
integer
access_smpp
integer
access_users
integer
api_username
stringRequired
email
stringRequired
first_name
stringRequired
last_name
stringRequired
notes
string
password
stringRequired
phone_number
stringRequired
sms_deidentify_message
integer
user_id
integer

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Email Delivery Receipt Automation

Description

Tool to delete an email delivery receipt automation rule. Use when you need to remove an existing email receipt automation by its rule ID.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
boolean
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Inbound SMS Automation

Description

Tool to delete an inbound SMS automation rule. Use when you need to remove an existing inbound SMS automation by its rule ID.

Action Parameters

inbound_rule_id
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Contact List

Description

Tool to delete a specific contact list from your ClickSend account. Use when you need to remove a contact list permanently.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Contact from List

Description

Tool to delete a specific contact from a contact list in your ClickSend account. Use when you need to remove a contact from a specific list permanently.

Action Parameters

contact_id
integerRequired
list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Remove Opted Out Contacts from List

Description

Tool to remove all opted out contacts from a contact list using an opt out list reference. Use when you need to clean up a list by removing contacts that have opted out.

Action Parameters

list_id
integerRequired
opt_out_list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Cancel Scheduled SMS

Description

Tool to cancel a scheduled SMS message by updating its status to cancelled. Use when you need to prevent a scheduled SMS from being sent.

Action Parameters

message_id
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete SMS Template

Description

Tool to delete an SMS template by its template ID. Use when you need to remove a specific SMS template from your account.

Action Parameters

template_id
integerRequired

Action Response

data
null
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Subaccount

Description

Tool to delete a specific subaccount from the system. Use when you need to remove a subaccount from your account.

Action Parameters

subaccount_id
integerRequired

Action Response

data
boolean
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Email Campaign

Description

Tool to retrieve details of a specific email campaign by its ID. Use when you need to view campaign configuration, content, and delivery statistics including sends, opens, clicks, and bounces.

Action Parameters

email_campaign_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Email Delivery Receipt Automation

Description

Tool to delete an email delivery receipt automation rule. Use when you need to remove an existing email receipt automation by its rule ID.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
boolean
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Email Delivery Receipt Automation

Description

Tool to retrieve a specific email delivery receipt automation rule by its ID. Use when you need to view the configuration details of an email receipt automation rule.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Email Delivery Receipt Automation

Description

Tool to update an email delivery receipt automation rule in ClickSend. Use when you need to modify the configuration of an existing email receipt automation rule.

Action Parameters

action
string
action_address
string
enabled
integer
match_type
integer
receipt_rule_id
integerRequired
rule_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Email Template

Description

Tool to delete an email template by its template ID. Use when you need to remove an existing email template from your account.

Action Parameters

template_id
integerRequired

Action Response

data
null
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Email Template

Description

Tool to retrieve a specific user email template by its template ID. Use when you need to view details of a specific email template including its HTML content and metadata.

Action Parameters

template_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Email Template

Description

Tool to update an existing email template in ClickSend. Use when you need to modify the name or HTML body content of an email template.

Action Parameters

body
stringRequired
template_id
integerRequired
template_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Export Post Letters History

Description

Tool to export post letter history to a downloadable CSV file. Use when you need to download historical data of post letters for analysis or record-keeping.

Action Parameters

filename
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Fax Delivery Receipt Automation

Description

Tool to delete a fax delivery receipt automation rule. Use when you need to remove an existing fax delivery receipt automation by its rule ID.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Fax Delivery Receipt Automation

Description

Tool to retrieve a specific fax delivery receipt automation rule by its ID. Use when you need to view the configuration details of a fax receipt automation rule.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Fax Delivery Receipt Automation

Description

Tool to update fax delivery receipt automation. Use when you need to modify an existing fax delivery receipt automation rule by its rule ID.

Action Parameters

action
stringRequired
action_address
stringRequired
enabled
integerRequired
match_type
integerRequired
receipt_rule_id
integerRequired
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Inbound Fax Automation

Description

Tool to update an existing inbound fax automation rule in ClickSend. Use when you need to modify the settings of an inbound fax automation rule.

Action Parameters

action
stringRequired
action_address
stringRequired
dedicated_number
stringRequired
enabled
integerRequired
inbound_rule_id
integerRequired
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Fax Receipt by Message ID

Description

Tool to retrieve a single fax delivery receipt using the message identifier. Use when you need to check the status, delivery details, or cost of a specific fax transmission.

Action Parameters

message_id
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Mark Fax Receipts as Read

Description

Tool to mark fax delivery receipts as read in ClickSend. Use when you need to mark all receipts or receipts before a specific date as read. Optionally provide a Unix timestamp to mark only receipts created before that time.

Action Parameters

date_before
number

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Account Information

Description

Tool to retrieve authenticated user's account information. Use when you need to view account details such as balance, user information, settings, and billing details.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Email Delivery Receipt Automations

Description

Tool to retrieve all email delivery receipt automation rules configured in your ClickSend account. Use when you need to view or list all email receipt automation configurations. Supports pagination and filtering.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Inbound Fax Automations

Description

Tool to retrieve all inbound fax automation rules configured in your ClickSend account. Use when you need to view or list all inbound fax automation configurations. Supports pagination.

Action Parameters

limit
integerDefaults to 15
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Fax Delivery Receipt Automations

Description

Tool to retrieve all fax delivery receipt automation rules configured in your ClickSend account. Use when you need to view or list all fax receipt automation configurations. Supports pagination and filtering.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Inbound SMS Automations

Description

Tool to retrieve all inbound SMS automation rules configured in your ClickSend account. Use when you need to view or list all inbound SMS automation configurations. Supports pagination and filtering.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All SMS Delivery Receipt Automations

Description

Tool to retrieve all SMS delivery receipt automation rules configured in your ClickSend account. Use when you need to view or list all SMS receipt automation configurations. Supports pagination and filtering.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Voice Delivery Receipt Automations

Description

Tool to retrieve all voice delivery receipt automation rules configured in your ClickSend account. Use when you need to view or list all voice receipt automation configurations. Supports pagination and filtering.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Contact Suggestions

Description

Tool to retrieve contact suggestions from your ClickSend account. Use when you need to view or list suggested contacts. Supports pagination.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Countries

Description

Tool to retrieve all available country codes that ClickSend supports. Use when you need to get a list of countries for international messaging services.

Action Parameters

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Delivery Issues

Description

Tool to retrieve all delivery issues from your ClickSend account. Use when you need to view or investigate problems with message delivery. Supports pagination for handling large result sets.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Master Email Templates

Description

Tool to retrieve all master email templates. Use when you need to view pre-designed email templates that can be used for email communications. Supports pagination.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Master Email Template Categories

Description

Tool to retrieve all master email template categories. Use when you need to view available categories of pre-designed email templates. Supports pagination.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All User Email Templates

Description

Tool to retrieve all user email templates. Use when you need to view custom email templates created by the user. Supports pagination.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Fax Delivery Receipts

Description

Tool to retrieve fax delivery receipts from your ClickSend account. Use when you need to view fax transmission details including delivery status, pricing, and recipient information. Supports pagination.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Contact Lists

Description

Tool to retrieve all contact lists from ClickSend account with pagination support. Use when you need to view available contact lists for managing contacts and messaging campaigns.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Specific Contact List

Description

Tool to retrieve a specific contact list by its list ID. Use when you need to view details of a specific contact list including its name, email ID, and contact count.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Contacts in List

Description

Tool to retrieve all contacts from a specific contact list in your ClickSend account with pagination and filtering support. Use when you need to view or process contacts within a specific list.

Action Parameters

limit
integerDefaults to 10
list_id
integerRequired
page
integerDefaults to 1
updated_after
integer

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Specific Contact

Description

Tool to retrieve a specific contact from a contact list in your ClickSend account. Use when you need to view detailed information about a particular contact within a specific list.

Action Parameters

contact_id
integerRequired
list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Export Contacts List

Description

Tool to export contacts from a specific list to a CSV file. Use when you need to download all contacts from a list for backup, analysis, or migration purposes.

Action Parameters

filename
stringRequired
list_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Import Contacts to List

Description

Tool to import contacts to a contact list from a publicly accessible file URL. Use when you need to bulk import contacts from a CSV or Excel file into a specific list. Note that the import process may be asynchronous.

Action Parameters

field_order
arrayRequired
file_url
stringRequired
list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Preview CSV Import for Contact List

Description

Tool to preview the first row of a CSV import file for a contact list in ClickSend. Use when you need to verify CSV structure and field mapping before importing contacts to a list.

Action Parameters

file_url
stringRequired
list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get List Import Fields

Description

Tool to retrieve acceptable import fields for a contact list in ClickSend. Use when you need to view which fields are available for importing contacts into a specific list.

Action Parameters

list_id
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Export MMS History

Description

Tool to export MMS message history with filtering, ordering, and pagination. Use when you need to retrieve historical MMS messages with custom sorting options.

Action Parameters

date_from
integer
date_to
integer
limit
integerDefaults to 10
order_by
string
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get MMS Delivery Receipts

Description

Tool to retrieve all MMS delivery receipts from your ClickSend account. Use when you need to view MMS delivery status, pricing, and recipient information. Supports pagination.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Dedicated Numbers

Description

Tool to retrieve all available dedicated numbers associated with your ClickSend account. Use when you need to view dedicated numbers that can be used as sender IDs for messaging services.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Search Direct Mail Locations

Description

Tool to search for direct mail locations in a specific country. Use when you need to find available locations or addresses for direct mail services.

Action Parameters

country
stringRequired
q
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Post Letters History

Description

Tool to retrieve all post letters history with pagination. Use when you need to view historical post letters sent through ClickSend.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Country Pricing

Description

Tool to retrieve pricing information for a specific country. Use when you need to check rates for SMS, MMS, and voice services in a particular country and currency.

Action Parameters

country
stringRequired
currency
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Referral Accounts

Description

Tool to retrieve a list of referral accounts with pagination support. Use when you need to view referral accounts including user information, balance, and commission details.

Action Parameters

limit
integerDefaults to 15
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Reseller Settings

Description

Tool to retrieve reseller settings and account information. Use when you need to view the authenticated reseller's account details, settings, and configuration. Note: The reseller dashboard and API are only available to customers approved as resellers before January 1st, 2024.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Reseller Accounts

Description

Tool to retrieve a list of reseller accounts with pagination support. Use when you need to view reseller accounts including user information, balance, settings, and permissions. Note: The reseller dashboard and API are only available to customers approved as resellers before January 1st, 2024.

Action Parameters

limit
integerDefaults to 15
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS Campaign

Description

Tool to retrieve details of a specific SMS campaign by its ID. Use when you need to view campaign configuration, message content, scheduling details, and current status.

Action Parameters

sms_campaign_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS Campaigns List

Description

Tool to retrieve all SMS campaigns with pagination and statistics breakdown. Use when you need to view campaign statistics and performance data for management or reporting purposes.

Action Parameters

limit
integerDefaults to 15
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Email to SMS Stripped String Rules List

Description

Tool to retrieve the list of email to sms stripped string rules with pagination support. Use when you need to view all stripped string rules that automatically remove specific text from email-to-SMS messages.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS History

Description

Tool to retrieve sent SMS message history with filtering and pagination. Use when you need to view previously sent SMS messages or check delivery status.

Action Parameters

date_from
integer
date_to
integer
limit
integerDefaults to 10
operator
string
order_by
string
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Inbound SMS Messages

Description

Tool to retrieve inbound SMS messages sent to your account. Use when you need to view messages received from recipients. By default, only unread messages are returned. To view inbound messages, you must first configure an inbound rule with the Action set to POLL in the Dashboard.

Action Parameters

limit
integerDefaults to 15
operator
string
order_by
string
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS Delivery Receipts

Description

Tool to retrieve SMS delivery receipts from your ClickSend account. Use when you need to poll and view SMS delivery status including timestamps, status codes, and error details. Requires a delivery report rule with Action set to POLL in the Dashboard.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All SMS Templates

Description

Tool to retrieve all SMS templates from ClickSend account with pagination and filtering support. Use when you need to view available SMS templates for messaging campaigns.

Action Parameters

limit
integerDefaults to 15
operator
string
order_by
string
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS Statistics

Description

Tool to retrieve SMS messaging statistics for your ClickSend account. Use when you need to view usage metrics, pricing data, and date-based breakdowns of SMS message activity including outbound, inbound, and bounced messages.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Voice Statistics

Description

Tool to retrieve voice messaging statistics for your ClickSend account. Use when you need to view usage metrics, pricing data, and date-based breakdowns of voice message activity.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Subaccounts

Description

Tool to retrieve all subaccounts from ClickSend account with pagination support. Use when you need to view available subaccounts and their permissions.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Specific Subaccount

Description

Tool to retrieve detailed information about a specific subaccount by its ID. Use when you need to view credentials, permissions, and contact details for a particular subaccount.

Action Parameters

subaccount_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Supported Timezones

Description

Tool to retrieve supported list of timezones. Use when you need to get available timezones for scheduling or configuration purposes.

Action Parameters

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Voice Languages

Description

Tool to retrieve all available voice languages for text-to-speech. Use when you need to get supported languages and voice options for voice messaging.

Action Parameters

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: List Countries

Description

Tool to retrieve the list of countries with IDs for global sending. Use when you need to select countries for international messaging operations.

Action Parameters

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Copy Contact to Another List

Description

Tool to copy a contact from one list to another list. Use when you need to duplicate a contact from a source list to a destination list while keeping the original contact in the source list.

Action Parameters

contact_id
integerRequired
from_list_id
integerRequired
to_list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Transfer Contact Between Lists

Description

Tool to transfer a contact from one list to another in your ClickSend account. Use when you need to move a contact between lists without deleting and recreating it.

Action Parameters

contact_id
integerRequired
from_list_id
integerRequired
to_list_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Mark SMS Receipts as Read

Description

Tool to mark SMS delivery receipts as read in ClickSend. Use when you need to flag receipts as processed to clear them from the unread queue. Optionally specify a date threshold to mark only receipts received before a certain time.

Action Parameters

date_before
integer

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Mark Voice Receipts as Read

Description

Tool to mark voice delivery receipts as read in ClickSend. Use when you need to mark all voice message delivery receipts or receipts received before a specific date as read. Once marked as read, receipts won't appear in subsequent queries.

Action Parameters

date_before
number

Action Response

data
integer
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Master Email Template Category

Description

Tool to retrieve a specific master email template category by its ID. Use when you need to view details about a category of pre-designed email templates.

Action Parameters

category_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Master Email Template

Description

Tool to retrieve a specific master email template by its template ID. Use when you need to view details of a pre-designed master email template including its HTML content and thumbnails.

Action Parameters

template_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Master Email Templates in Category

Description

Tool to retrieve all master email templates within a specific category. Use when you need to browse pre-designed email templates from ClickSend's template library for a particular category.

Action Parameters

category_id
integerRequired
limit
integerDefaults to 15
page
integerDefaults to 1

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update MMS Campaign

Description

Tool to update an existing MMS campaign with new parameters. Use when you need to modify campaign details such as name, sender, message body, media file, subject, or reschedule send time.

Action Parameters

body
stringRequired
from
stringRequired
list_id
integerRequired
media_file
stringRequired
mms_campaign_id
integerRequired
name
stringRequired
schedule
integer
subject
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Cancel MMS Campaign

Description

Tool to cancel a scheduled MMS campaign in ClickSend. Use when you need to stop an MMS campaign from being sent. Only scheduled campaigns can be cancelled.

Action Parameters

mms_campaign_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get MMS Campaigns

Description

Tool to retrieve all MMS campaigns with pagination and filtering support. Use when you need to view existing MMS campaigns for management or reporting purposes.

Action Parameters

limit
integerDefaults to 15
operator
string
order_by
string
page
integerDefaults to 1
q
string

Action Response

current_page
integer
data
array
error
string
from
integer
last_page
integer
next_page_url
string
per_page
integer
prev_page_url
string
successful
booleanRequired
to
integer
total
integer

Tool Name: Calculate MMS Campaign Price

Description

Tool to calculate the price for an MMS campaign before sending. Use when you need to estimate costs for an MMS campaign to a contact list.

Action Parameters

body
stringRequired
from
stringRequired
list_id
integerRequired
media_file
stringRequired
name
stringRequired
subject
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Send MMS Campaign

Description

Tool to create and send an MMS campaign to a contact list with multimedia content. Use when you need to send MMS messages to multiple recipients with images or videos. The campaign sends immediately unless scheduled for future delivery.

Action Parameters

body
stringRequired
from
string
list_id
integerRequired
media_file
stringRequired
name
stringRequired
schedule
integer
subject
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Export MMS History

Description

Tool to export all MMS history to a file. Use when you need to download a complete history of MMS messages in CSV format.

Action Parameters

filename
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get MMS History

Description

Tool to retrieve all MMS message history with filtering and pagination. Use when you need to view historical MMS messages sent through ClickSend.

Action Parameters

date_from
integer
date_to
integer
limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Calculate MMS Price

Description

Tool to calculate the price for sending MMS messages without actually sending them. Use when you need to estimate the cost of MMS messages before sending.

Action Parameters

media_file
stringRequired
messages
arrayRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Mark MMS Receipts as Read

Description

Tool to mark MMS delivery receipts as read in ClickSend. Use when you need to mark all receipts or receipts before a specific date as read. Optionally provide a Unix timestamp to mark only receipts created before that time.

Action Parameters

date_before
number

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Buy Dedicated Number

Description

Tool to purchase a dedicated phone number from ClickSend. Use when you need to buy a specific number for SMS messaging and other communication services.

Action Parameters

country
string
dedicated_number
stringRequired
registration_data
object
type
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Post Return Address

Description

Tool to delete a specific post return address from the system. Use when you need to remove a return address from your postal mailings.

Action Parameters

return_address_id
integerRequired

Action Response

data
string
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Post Return Address

Description

Tool to retrieve a specific post return address by its unique identifier. Use when you need to view details of a return address for postal services.

Action Parameters

return_address_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Post Return Address

Description

Tool to update an existing post return address in ClickSend. Use when you need to modify the details of a return address for postal mail services.

Action Parameters

address_city
stringRequired
address_country
stringRequired
address_line_1
stringRequired
address_line_2
string
address_name
stringRequired
address_postal_code
stringRequired
address_state
string
return_address_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Upload File

Description

Tool to upload and optionally convert files for use with ClickSend messaging services. Use when you need to upload files for fax, MMS, postcards, or post services. All uploaded files expire 10 minutes after upload.

Action Parameters

content
stringRequired
convert
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Forgot Password

Description

Tool to initiate password recovery for a ClickSend account. Use when a user has forgotten their password and needs to receive a verification code via email to reset it.

Action Parameters

username
stringRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Forgot Username

Description

Tool to retrieve forgotten username by providing registered email or phone number. Use when a user needs to recover their account username via notification.

Action Parameters

email
string
phone_number
string

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Recharge Packages

Description

Tool to retrieve all available recharge packages from ClickSend. Use when you need to view pricing and quantity information for SMS, voice, fax, email, and postal mail services.

Action Parameters

country
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Purchase Recharge Package

Description

Tool to purchase a recharge package by package ID. Use when you need to add credits to a ClickSend account by purchasing a pre-defined package.

Action Parameters

package_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Recharge Transaction by ID

Description

Tool to retrieve details of a specific recharge transaction by transaction ID. Use when you need to view transaction information such as amount, currency, invoice number, and date.

Action Parameters

transaction_id
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get All Recharge Transactions

Description

Tool to retrieve all recharge transactions from ClickSend account with pagination support. Use when you need to view transaction history including amounts, currencies, and dates.

Action Parameters

limit
integerDefaults to 15
page
integerDefaults to 1

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Search Contact Lists

Description

Tool to search contact lists in ClickSend account with pagination support. Use when you need to find specific contact lists by name or other criteria.

Action Parameters

limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Send Email Verification Token

Description

Tool to send a verification email containing an activation token to a registered email address. Use when you need to verify an email address before it can be used to send email campaigns through ClickSend.

Action Parameters

email_address_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Cancel SMS Campaign

Description

Tool to cancel a scheduled SMS campaign in ClickSend. Use when you need to stop an SMS campaign from being sent. Only scheduled campaigns can be cancelled.

Action Parameters

sms_campaign_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Cancel All Scheduled SMS

Description

Tool to cancel all scheduled SMS messages in ClickSend. Use when you need to cancel all pending scheduled SMS messages at once. Only affects scheduled messages that have not yet been sent.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete SMS Delivery Receipt Automation

Description

Tool to delete an SMS delivery receipt automation rule. Use when you need to remove an existing delivery receipt automation by its rule ID.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS Delivery Receipt Automation

Description

Tool to retrieve a specific SMS delivery receipt automation rule by its ID. Use when you need to view the configuration details of an SMS receipt automation rule.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update SMS Delivery Receipt Automation

Description

Tool to update an SMS delivery receipt automation rule in ClickSend. Use when you need to modify the configuration of an existing SMS receipt automation rule.

Action Parameters

action
string
action_address
string
enabled
integer
match_type
integer
receipt_rule_id
integerRequired
rule_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Email to SMS Stripped String Rule

Description

Tool to delete an email to SMS stripped string rule from the account. Use when you need to remove an existing stripped string rule by its rule ID.

Action Parameters

rule_id
integerRequired

Action Response

data
boolean
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Email to SMS Stripped String Rule

Description

Tool to retrieve an email to SMS stripped string rule by its ID. Use when you need to view the details of a specific stripped string rule.

Action Parameters

rule_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Email to SMS Stripped String Rule

Description

Tool to update an email to SMS stripped string rule. Use when you need to modify the text pattern that is stripped from emails before converting to SMS.

Action Parameters

rule_id
integerRequired
strip_string
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Export SMS History

Description

Tool to export all SMS history to a file. Use when you need to download a complete history of SMS messages in CSV format.

Action Parameters

filename
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS History

Description

Tool to retrieve all SMS message history with filtering and pagination. Use when you need to view historical SMS messages sent through ClickSend.

Action Parameters

date_from
integer
date_to
integer
limit
integerDefaults to 10
page
integerDefaults to 1
q
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Inbound SMS Automation

Description

Tool to delete an inbound SMS automation rule. Use when you need to remove an existing inbound SMS automation by its rule ID.

Action Parameters

inbound_rule_id
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Inbound SMS Automation

Description

Tool to retrieve a specific inbound SMS automation rule by its ID. Use when you need to view the configuration details of an inbound SMS automation rule.

Action Parameters

inbound_rule_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Inbound SMS Automation

Description

Tool to update an existing inbound SMS automation rule in ClickSend. Use when you need to modify automated actions for inbound SMS messages.

Action Parameters

action
stringRequired
action_address
stringRequired
dedicated_number
stringRequired
enabled
integerRequired
inbound_rule_id
integerRequired
message_search_term
string
message_search_type
integerRequired
rule_name
stringRequired
webhook_type
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Mark Inbound SMS as Read by Message ID

Description

Tool to mark a specific inbound SMS message as read in ClickSend. Use when you need to mark an individual inbound SMS as processed. Once marked as read, the message won't appear in the View Inbound SMS endpoint but can still be viewed using the View Specific Inbound SMS endpoint.

Action Parameters

message_id
stringRequired

Action Response

data
null
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Mark Inbound SMS as Read

Description

Tool to mark inbound SMS messages as read in ClickSend. Use when you need to mark all inbound SMS or inbound SMS received before a specific date as read. Once marked as read, messages won't appear in the View Inbound SMS endpoint but can still be viewed using the View Specific Inbound SMS endpoint.

Action Parameters

date_before
number

Action Response

data
integer
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Calculate SMS Price

Description

Tool to calculate the price for sending SMS messages without actually sending them. Use when you need to estimate the cost of SMS messages before sending.

Action Parameters

messages
arrayRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get SMS Receipt by Message ID

Description

Tool to retrieve a single SMS delivery receipt using the message identifier. Use when you need to check the status, delivery details, or cost of a specific SMS transmission.

Action Parameters

message_id
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Mark SMS Delivery Receipts as Read

Description

Tool to mark SMS delivery receipts as read in ClickSend. Use when you need to mark receipts as processed so they no longer appear in the View SMS Receipts endpoint. Optionally specify a date threshold to mark only receipts received before a certain time.

Action Parameters

date_before
integer

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete SMS Template

Description

Tool to delete an SMS template by its template ID. Use when you need to remove an existing SMS template from your account.

Action Parameters

template_id
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update SMS Template

Description

Tool to update an existing SMS template in ClickSend. Use when you need to modify the name or body content of an SMS template.

Action Parameters

body
string
template_id
integerRequired
template_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Specific Allowed Email Address

Description

Tool to delete a specific allowed email address from the account. Use when you need to remove an email address from your allowed email addresses list.

Action Parameters

email_address_id
integerRequired

Action Response

data
null
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Specific Allowed Email Address

Description

Tool to retrieve a specific allowed email address by its ID. Use when you need to view detailed information about a specific email address in your account.

Action Parameters

email_address_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Regenerate Subaccount API Key

Description

Tool to regenerate API key for a specific subaccount. Use when you need to create a new API key for security purposes or when the current key has been compromised.

Action Parameters

subaccount_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Account Information

Description

Tool to update authenticated user's account information. Use when you need to modify account details such as first name, last name, phone number, or country.

Action Parameters

country
string
user_first_name
string
user_last_name
string
user_phone
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Email Delivery Receipt Automation

Description

Tool to update an email delivery receipt automation rule in ClickSend. Use when you need to modify an existing email receipt automation rule by its rule ID.

Action Parameters

action
stringRequired
action_address
string
enabled
integer
match_type
integer
receipt_rule_id
integerRequired
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Inbound Fax Automation

Description

Tool to update an inbound fax automation rule in ClickSend. Use when you need to modify an existing fax inbound automation rule by its rule ID.

Action Parameters

action
stringRequired
action_address
stringRequired
dedicated_number
stringRequired
enabled
integerRequired
inbound_rule_id
integerRequired
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Fax Delivery Receipt Automation

Description

Tool to update a fax delivery receipt automation rule in ClickSend. Use when you need to modify an existing fax receipt automation rule by its rule ID.

Action Parameters

action
stringRequired
action_address
stringRequired
enabled
integerRequired
match_type
integerRequired
receipt_rule_id
integerRequired
rule_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Inbound SMS Automation

Description

Tool to update an existing inbound SMS automation rule in ClickSend. Use when you need to modify the configuration of an inbound SMS automation rule by its ID.

Action Parameters

action
stringRequired
action_address
stringRequired
dedicated_number
stringRequired
enabled
integerRequired
inbound_rule_id
integerRequired
message_search_term
stringRequired
message_search_type
integerRequired
rule_name
stringRequired
webhook_type
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update SMS Delivery Receipt Automation

Description

Tool to update an SMS delivery receipt automation rule in ClickSend. Use when you need to modify an existing SMS receipt automation rule by its rule ID.

Action Parameters

action
string
action_address
string
enabled
integer
match_type
integer
receipt_rule_id
integerRequired
rule_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Voice Delivery Receipt Automation

Description

Tool to update a voice delivery receipt automation rule in ClickSend. Use when you need to modify an existing voice receipt automation rule by its rule ID.

Action Parameters

action
string
action_address
string
enabled
integer
match_type
integer
receipt_rule_id
integerRequired
rule_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Contact List

Description

Tool to update the name of a specific contact list in your ClickSend account. Use when you need to rename an existing contact list.

Action Parameters

list_id
integerRequired
list_name
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Contact in List

Description

Tool to update a specific contact in a contact list in your ClickSend account. Use when you need to modify contact details such as phone number, email, name, address, or custom fields.

Action Parameters

address_city
string
address_country
string
address_line_1
string
address_line_2
string
address_postal_code
string
address_state
string
contact_id
integerRequired
custom_1
string
custom_2
string
custom_3
string
custom_4
string
email
string
fax_number
string
first_name
string
last_name
string
list_id
integerRequired
organization_name
string
phone_number
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get Recharge Credit Card Info

Description

Tool to retrieve stored credit card payment information in tokenized form. Use when you need to view the masked credit card details, expiry date, and cardholder name for recharge operations.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Recharge Credit Card Info

Description

Tool to update credit card payment information for account recharge. Use when you need to modify the stored credit card details used for auto-recharge or manual recharge operations. ClickSend stores only a secure token, not the actual card number.

Action Parameters

bank_name
stringRequired
cvc
integerRequired
expiry_month
integerRequired
expiry_year
integerRequired
name
stringRequired
number
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Reseller Settings

Description

Tool to update reseller account settings and configuration. Use when you need to modify reseller details such as contact information, billing settings, timezone, or feature settings. Note: The reseller dashboard and API are only available to customers approved as resellers before January 1st, 2024.

Action Parameters

account_billing_email
string
account_billing_mobile
string
account_name
string
auto_recharge
integer
auto_recharge_amount
string
country
string
default_country_sms
string
low_credit_amount
string
setting_email_sms_subject
integer
setting_fix_sender_id
integer
setting_sms_message_char_limit
integer
setting_unicode_sms
integer
timezone
string
user_email
string
user_first_name
string
user_last_name
string
user_phone
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update SMS Campaign

Description

Tool to update an existing SMS campaign. Use when you need to modify campaign details such as name, message content, contact list, sender ID, or schedule.

Action Parameters

body
stringRequired
from
string
list_id
integerRequired
name
stringRequired
schedule
integer
sms_campaign_id
integerRequired
url_to_shorten
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Stripped String

Description

Tool to update an email to SMS stripped string rule. Use when you need to modify the text pattern that is stripped from emails before converting to SMS.

Action Parameters

rule_id
integerRequired
strip_string
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update SMS Template

Description

Tool to update an existing SMS template by its template ID. Use when you need to modify the name or body content of an SMS template.

Action Parameters

body
string
template_id
integerRequired
template_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Subaccount

Description

Tool to update a specific subaccount's details and permissions in ClickSend. Use when you need to modify subaccount credentials, contact information, or access permissions.

Action Parameters

access_billing
integerDefaults to 1
access_contacts
integer
access_reporting
integerDefaults to 1
access_settings
integerDefaults to 1
access_users
integerDefaults to 1
api_username
stringRequired
email
stringRequired
first_name
stringRequired
last_name
stringRequired
old_password
string
password
string
phone_number
stringRequired
subaccount_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Upload File

Description

Tool to upload files to ClickSend for use in messaging campaigns. Use when you need to upload media files that can be referenced in fax, MMS, postcards, or post services. Files expire 10 minutes after upload.

Action Parameters

content
stringRequired
filename
stringRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Agree to User Countries Rules

Description

Tool to agree on rules and regulations for selected countries in Global Sending. Use when you need to confirm acceptance of terms and conditions for countries selected for international messaging.

Action Parameters

Action Response

data
string
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Get User Countries

Description

Tool to retrieve the list of selected countries for Global Sending. Use when you need to view which countries are currently enabled for international messaging.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Select User Countries

Description

Tool to select countries for Global SMS/MMS sending. Use when you need to configure which countries are enabled for international messaging. To remove/unselect a country, exclude its ID from the array.

Action Parameters

country_list_ids
arrayRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Verify Allowed Email Address

Description

Tool to verify an email address using the activation token sent to it. Use when you need to complete the email address verification process after adding a new sender address.

Action Parameters

activation_token
stringRequired
email_address_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Verify Forgot Password

Description

Tool to verify forgot password request and reset user password. Use in the second step of password reset flow after receiving the activation token via email.

Action Parameters

activation_token
stringRequired
password
stringRequired
subaccount_id
integerRequired

Action Response

data
array
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Cancel All Scheduled Voice Messages

Description

Tool to cancel all scheduled voice messages in ClickSend. Use when you need to cancel all pending scheduled voice messages at once. Only affects scheduled messages that have not yet been sent.

Action Parameters

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Delete Voice Receipt Automation

Description

Tool to delete a voice delivery receipt automation rule. Use when you need to remove a specific voice receipt automation rule.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Voice Delivery Receipt Automation

Description

Tool to retrieve a specific voice delivery receipt automation rule by its ID. Use when you need to view the configuration details of a voice receipt automation rule.

Action Parameters

receipt_rule_id
integerRequired

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Update Voice Delivery Receipt Automation

Description

Tool to update a voice delivery receipt automation rule in ClickSend. Use when you need to modify the configuration of an existing voice receipt automation rule.

Action Parameters

action
string
action_address
string
enabled
integer
match_type
integer
receipt_rule_id
integerRequired
rule_name
string

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired

Tool Name: Export Voice History

Description

Tool to export all voice history to a file. Use when you need to download a complete history of voice messages in CSV format.

Action Parameters

filename
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Mark Voice Delivery Receipts as Read

Description

Tool to mark voice delivery receipts as read in ClickSend. Use when you need to mark all voice receipts or receipts before a specific date as read to prevent them from appearing in subsequent GET requests. Optionally provide a Unix timestamp to mark only receipts received before that time.

Action Parameters

date_before
number

Action Response

data
object
error
string
http_code
integer
response_code
string
response_msg
string
successful
booleanRequired