ClickSend

Overview

ClickSend is a cloud-based communication platform that lets businesses send and receive SMS, MMS, email, fax, and physical letters through a single API. With the ClickSend integration in SquadOS, your agents can trigger transactional or marketing messages, manage contact lists, query send history, and monitor campaign performance programmatically.

• Official website: https://www.clicksend.com/
• Composio documentation: docs.composio.dev/toolkits/clicksend

Authentication

This tool uses Basic auth (username/password) (BASIC) to connect.

You will need the following fields:

Field	Required	Description
username	Yes	Your ClickSend account username (usually the registration email).
password	Yes	Your ClickSend account password or an API key generated from the dashboard.

How to get credentials

1. Go to dashboard.clicksend.com and log in.
2. Click the user menu in the top-right corner and open Account Settings.
3. Under the API Credentials tab, find your username and generate or view your API key (use the key instead of the password for better security).
4. Copy the username and API key — these are the values to enter in the username and password fields when connecting in SquadOS.

Tip

Use your API key instead of your account password. This lets you revoke access without changing your account password and provides an extra layer of security.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for ClickSend.
3. Click the card to open the details and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the credentials obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)

Available actions

Note

This integration exposes 166 actions in total. The most relevant ones are listed below; see the full list in the Composio documentation.

Send SMS Messages

CLICKSEND_CREATE_SMS_SEND

Tool to send one or more SMS messages via ClickSend. Supports up to 1,000 messages per API call. Each message must have to (number in full international format, e.g., +12025551234) and body at minimum. Use the schedule field (Unix timestamp) to delay sending.

Input parameters

Name	Type	Required	Description
messages	array	Yes	List of SMS message objects to send. Each object requires to and body. The to field must be in full international format with + and country code. The schedule field accepts a Unix timestamp for delayed sending; omit to send immediately.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Send MMS Messages

CLICKSEND_CREATE_MMS_SEND

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. Supports up to 1,000 messages per call. Maximum media file size: 250 kB.

Input parameters

Name	Type	Required	Description
messages	array	Yes	Array of MMS message objects to send. Minimum 1 message, maximum 1,000 per API call.
media_file	string	Yes	Publicly accessible URL to the media file/image to be sent with the MMS. Must be a valid URL. Maximum file size: 250 kB (some older devices limited to 30 kB).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Create and Send SMS Campaign

CLICKSEND_CREATE_SMS_CAMPAIGNS_SEND

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

Input parameters

Name	Type	Required	Description
body	string	Yes	The message content to send. Must include opt-out mechanism for marketing messages (e.g., ‘Reply STOP to opt-out’ or use the StopMsg.me/xxxxx placeholder).
from	string	No	The sender identification. Options: shared number, dedicated number (E.164 format like +61353787448), alpha tag (business name), or own number.
name	string	Yes	The name of the SMS campaign for identification and tracking.
list_id	integer	Yes	The ID of the contact list to send the campaign to.
schedule	integer	No	UNIX timestamp for scheduling the campaign. Defaults to 0 (send immediately).
url_to_shorten	string	No	URL to be shortened. Use http://smsg.io/xxxxx as placeholder in the message body where the shortened link should appear.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Calculate SMS Price

CLICKSEND_SMS_PRICE_POST

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.

Input parameters

Name	Type	Required	Description
messages	array	Yes	Array of SMS message objects to calculate price for. Minimum 1 message required.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Calculate SMS Campaign Price

CLICKSEND_CALCULATE_SMS_CAMPAIGNS_PRICE

Tool to calculate the price for an SMS campaign before sending. Pricing depends on the number of recipients, message length, and destination countries.

Input parameters

Name	Type	Required	Description
body	string	Yes	Your campaign message content. Use placeholders like (First Name) for personalization.
from	string	No	Sender identifier (phone number or alphanumeric sender ID).
name	string	Yes	Your campaign name for identification.
list_id	integer	Yes	Your contact list ID containing the campaign recipients.
schedule	integer	No	Unix timestamp for scheduling the campaign. Defaults to 0 for immediate sending.
url_to_shorten	string	No	URL to shorten in the campaign. When using this parameter, you MUST include the placeholder http://smsg.io/xxxxx in your message body.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Cancel SMS Campaign

CLICKSEND_SMS_CAMPAIGNS_CANCEL_BY_SMS_CAMPAIGN_ID_PUT

Tool to cancel a scheduled SMS campaign in ClickSend. Only scheduled campaigns can be cancelled.

Input parameters

Name	Type	Required	Description
sms_campaign_id	integer	Yes	The unique identifier of the SMS campaign to cancel.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Update SMS Campaign

CLICKSEND_UPDATE_SMS_CAMPAIGNS

Update an existing SMS campaign. Modify campaign details including name, message content, contact list, sender ID, or schedule time. Only scheduled campaigns (with a future send time) can be updated.

Input parameters

Name	Type	Required	Description
body	string	Yes	The message content for your campaign.
from	string	No	Your sender ID. The sender name or number that recipients will see.
name	string	Yes	The title assigned to your campaign.
list_id	integer	Yes	Identifier for the contact list the campaign should use.
schedule	integer	No	Unix timestamp for when to send the campaign. If omitted or set to 0, the campaign sends immediately and cannot be updated again. Maximum 4 months in advance.
url_to_shorten	string	No	A URL to compress and include in the message. Insert placeholder text in the body where the shortened URL should appear.
sms_campaign_id	integer	Yes	The unique identifier of the SMS campaign to update.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get SMS Campaigns List

CLICKSEND_GET_SMS_CAMPAIGNS3

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.

Input parameters

Name	Type	Required	Description
q	string	No	Search query in format field_name:value. Filter by fields such as name, status, list_id, etc.
page	integer	No	Page number for paginated results. Minimum: 1.
limit	integer	No	Number of items to return per page. Between 15 and 100.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get SMS History

CLICKSEND_GET_SMS_HISTORY

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.

Input parameters

Name	Type	Required	Description
q	string	No	Custom query string for filtering results. Format: field:value pairs separated by commas. Example: status:Sent or to:+12025551234.
page	integer	No	Page number for pagination.
limit	integer	No	Number of records to return per page.
date_to	integer	No	Filter messages sent up to this date. Unix timestamp format (seconds since epoch).
date_from	integer	No	Filter messages sent from this date onwards. Unix timestamp format.
order_by	string	No	Sort results by field. Format: field:asc or field:desc (e.g., date:desc).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get SMS Delivery Receipts

CLICKSEND_GET_SMS_RECEIPTS

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.

Input parameters

Name	Type	Required	Description
page	integer	No	Page number for pagination. Minimum: 1. Default: 1.
limit	integer	No	Number of records per page. Minimum: 1. Default: 15.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get SMS Receipt by Message ID

CLICKSEND_SMS_RECEIPTS_BY_MESSAGE_ID_GET

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.

Input parameters

Name	Type	Required	Description
message_id	string	Yes	Unique identifier for the SMS message (UUID format).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get SMS Statistics

CLICKSEND_GET_STATISTICS_SMS

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.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Contact List

CLICKSEND_CREATE_LISTS

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. The API allows up to 2,000 contact lists per account.

Input parameters

Name	Type	Required	Description
list_name	string	Yes	The name of the contact list to create. Maximum 50 characters (longer names will be truncated). Duplicate names are allowed; each list will have a unique list_id.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Contact in List

CLICKSEND_CREATE_LISTS_CONTACTS

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

Input parameters

Name	Type	Required	Description
list_id	integer	Yes	The unique identifier of the contact list where the contact will be created.
phone_number	string	No	Contact’s phone number in E.164 format (e.g., +61411111111). At least one of phone_number, email, or fax_number must be provided.
email	string	No	Contact’s email address. At least one of phone_number, email, or fax_number must be provided.
first_name	string	No	Contact’s first name.
last_name	string	No	Contact’s last name.
organization_name	string	No	Contact’s organization or company name.
address_line_1	string	No	First line of contact’s address.
address_city	string	No	City in contact’s address.
address_state	string	No	State or province in contact’s address.
address_postal_code	string	No	Postal or ZIP code in contact’s address.
address_country	string	No	Country code in ISO 3166-1 alpha-2 uppercase format (e.g., US, AU).
custom_1	string	No	Custom field 1 for additional contact information.
custom_2	string	No	Custom field 2 for additional contact information.
custom_3	string	No	Custom field 3 for additional contact information.
custom_4	string	No	Custom field 4 for additional contact information.
fax_number	string	No	Contact’s fax number. At least one of phone_number, email, or fax_number must be provided.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Contact Lists

CLICKSEND_GET_LISTS

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

Input parameters

Name	Type	Required	Description
page	integer	No	Page number for paginated results. Minimum: 1.
limit	integer	No	Number of records per page. Minimum: 1.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Contacts in List

CLICKSEND_GET_LISTS_CONTACTS

Tool to retrieve all contacts from a specific contact list in your ClickSend account with pagination and filtering support.

Input parameters

Name	Type	Required	Description
list_id	integer	Yes	The unique identifier of the contact list to retrieve contacts from.
page	integer	No	Page number for paginated results. Minimum: 1.
limit	integer	No	Number of records per page. Between 1 and 100.
updated_after	integer	No	Unix timestamp to filter contacts. Returns only contacts updated after this timestamp.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Contact in List

CLICKSEND_UPDATE_LISTS_CONTACTS

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.

Input parameters

Name	Type	Required	Description
list_id	integer	Yes	The unique identifier of the contact list containing the contact.
contact_id	integer	Yes	The unique identifier of the contact to update.
phone_number	string	No	Contact’s phone number in E.164 format (e.g., +14155552999).
email	string	No	Contact’s email address.
first_name	string	No	Contact’s first name.
last_name	string	No	Contact’s last name.
organization_name	string	No	Contact’s organization or company name.
address_line_1	string	No	First line of contact’s street address.
address_city	string	No	City in contact’s address.
address_state	string	No	State or province in contact’s address.
address_postal_code	string	No	Postal or ZIP code in contact’s address.
address_country	string	No	Country code in ISO 3166 format (2-letter) for contact’s address.
custom_1	string	No	Custom field 1 for additional contact information.
custom_2	string	No	Custom field 2 for additional contact information.
custom_3	string	No	Custom field 3 for additional contact information.
custom_4	string	No	Custom field 4 for additional contact information.
fax_number	string	No	Contact’s fax number.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Contact List

CLICKSEND_DELETE_LISTS

Tool to delete a specific contact list from your ClickSend account permanently.

Input parameters

Name	Type	Required	Description
list_id	integer	Yes	The unique identifier of the contact list to delete.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Contact from List

CLICKSEND_DELETE_LISTS_CONTACTS

Tool to delete a specific contact from a contact list in your ClickSend account permanently.

Input parameters

Name	Type	Required	Description
list_id	integer	Yes	The unique identifier of the contact list from which the contact will be deleted.
contact_id	integer	Yes	The unique identifier of the contact to delete from the list.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Import Contacts to List

CLICKSEND_GET_LISTS_IMPORT

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. The import process may be asynchronous.

Input parameters

Name	Type	Required	Description
list_id	integer	Yes	The unique identifier of the contact list to import contacts into.
file_url	string	Yes	URL of the file to process. Must be a publicly accessible URL pointing to a CSV or Excel file.
field_order	array	Yes	Order of fields in the file. Specifies how file columns map to contact fields. Valid field names: phone, phone_number, first_name, last_name, email, fax_number, address_line_1, address_line_2, address_city, address_state, address_postal_code, address_country, organization_name, custom_1, custom_2, custom_3, custom_4.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Export Contacts List

CLICKSEND_GET_LISTS_EXPORT

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.

Input parameters

Name	Type	Required	Description
list_id	integer	Yes	The ID of the contact list to export.
filename	string	Yes	Filename to download the contacts list as (e.g., contacts_export.csv). Must include .csv extension.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Account Information

CLICKSEND_GET_ACCOUNT

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.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Send Post Letter

CLICKSEND_CREATE_POST_LETTERS_SEND

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 the /uploads?convert=post endpoint.

Input parameters

Name	Type	Required	Description
file_url	string	Yes	URL of the PDF file to send. Supported formats: pdf, docx, doc, jpg, gif, png, bmp.
recipients	array	Yes	Array of recipient objects. Each recipient represents a person who will receive a copy of the letter.
colour	integer	No	Whether letter is printed in colour. 0 = black and white, 1 = colour. Default is 0.
duplex	integer	No	Whether letter is printed double-sided. 0 = single-sided, 1 = double-sided. Default is 0.
priority_post	integer	No	Whether the letter is priority post. 0 = standard post, 1 = priority post. Default is 0.
source	string	No	Source identifier for tracking purposes. Can be any string value.
template_used	integer	No	Whether using a ClickSend template. 0 = not using template, 1 = using template. Default is 0.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Inbound SMS Automation

CLICKSEND_CREATE_AUTOMATIONS_SMS_INBOUND

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.

Input parameters

Name	Type	Required	Description
action	string	Yes	Action to perform when rule matches. Valid values: AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL, CREATE_CONTACT_PLUS_NAME, SMPP, NONE.
enabled	integer	Yes	Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_name	string	Yes	Name of the automation rule to identify it.
action_address	string	Yes	Target destination for the specified action. For EMAIL_FIXED provide email address, for URL provide webhook URL, for contact lists provide list ID.
dedicated_number	string	Yes	The dedicated phone number to apply this rule to. Use * to apply the rule to all numbers.
message_search_type	integer	Yes	Message matching logic. 0 = Any message, 1 = starts with, 2 = contains, 3 = does not contain.
message_search_term	string	No	Text pattern to match against incoming messages. Can be null for message_search_type=0 (any message).
webhook_type	string	No	Webhook format type. Valid values: post, get, or json. Defaults to post.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Inbound SMS Messages

CLICKSEND_GET_SMS_INBOUND

Retrieves inbound SMS messages received by your ClickSend account. Use when you need to view messages sent TO your ClickSend numbers FROM customers or recipients, or monitor incoming SMS replies. To receive inbound messages via API polling, you must first configure an inbound rule in the ClickSend Dashboard with the Action set to POLL.

Input parameters

Name	Type	Required	Description
q	string	No	Search query to filter inbound SMS messages. Format: field_name:value (e.g., from:+61437085284). Available fields: from, to, message_id, body.
page	integer	No	Page number for pagination. Default: 1.
limit	integer	No	Number of records per page. Default: 15.
order_by	string	No	Sort order for results. Format: field_name:direction (e.g., date:desc for newest first).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.

Cancel All Scheduled SMS

CLICKSEND_SMS_CANCEL_ALL_PUT

Tool to cancel all scheduled SMS messages in ClickSend. Only affects messages scheduled for future delivery that have not yet been sent. Without custom_string, cancels ALL scheduled SMS messages; with custom_string, cancels only messages matching that specific identifier.

Input parameters

Name	Type	Required	Description
custom_string	string	No	Optional filter to cancel only scheduled messages with this specific custom_string value. If not provided, cancels all scheduled SMS messages.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during execution.
successful	boolean	Yes	Whether or not the action execution was successful.