- Category: phone & sms
- Auth: BASIC
- Composio-managed OAuth available? N/A
- Tools: 166
- Triggers: 0
- Slug:
CLICKSEND - Version: 20261101_00
Tools
Get Account Usage by Subaccount
Get Account Usage by Subaccount
CLICKSEND_ACCOUNT_USEAGE_BY_SUBACCOUNT_GETRetrieve detailed account usage statistics grouped by subaccount for a specific month and year. Returns usage data for all message types (SMS, MMS, voice, fax, email, post, postcards) broken down by individual subaccounts, along with totals and currency information. Use when you need to view usage breakdown across subaccounts for billing, cost allocation, or monitoring purposes.Input Parameters
Output
Send Account Activation Token
Send Account Activation Token
Verify New Account
Verify New Account
Calculate Post Letter Price
Calculate Post Letter Price
CLICKSEND_CALCULATE_POST_LETTERS_PRICECalculate the price for sending physical post letters via ClickSend without actually sending them. This tool estimates the cost of postal letters based on the file, recipients, and printing options (priority, color, duplex). It returns detailed pricing information including per-recipient costs, total price, and currency details. Use this when you need to: - Get a cost estimate before sending postal letters - Calculate bulk pricing for multiple recipients - Compare costs with different printing options (color vs B&W, single vs double-sided, standard vs priority) Note: You must have a valid return_address_id for each recipient. Use the “Get All Post Return Addresses” or “Create Post Return Address” actions to obtain return address IDs.Input Parameters
Output
Calculate SMS Campaign Price
Calculate SMS Campaign Price
CLICKSEND_CALCULATE_SMS_CAMPAIGNS_PRICETool 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.Input Parameters
Output
Create Email Delivery Receipt Automation
Create Email Delivery Receipt Automation
CLICKSEND_CREATE_AUTOMATIONS_EMAIL_RECEIPTSTool 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.Input Parameters
Output
Create Inbound Fax Automation
Create Inbound Fax Automation
CLICKSEND_CREATE_AUTOMATIONS_FAX_INBOUNDTool 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.Input Parameters
Output
Create Fax Delivery Receipt Automation
Create Fax Delivery Receipt Automation
CLICKSEND_CREATE_AUTOMATIONS_FAX_RECEIPTSCreates a fax delivery receipt automation rule in ClickSend. When faxes are delivered, this rule automatically triggers the specified action (e.g., sends receipt data to a webhook URL, forwards to an email, or sends an SMS). Use this to integrate fax delivery tracking into your systems or workflow.Input Parameters
Output
Create Inbound SMS Automation
Create Inbound SMS Automation
CLICKSEND_CREATE_AUTOMATIONS_SMS_INBOUNDTool 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
Output
Create SMS Delivery Receipt Automation
Create SMS Delivery Receipt Automation
CLICKSEND_CREATE_AUTOMATIONS_SMS_RECEIPTSTool 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.Input Parameters
Output
Create Voice Delivery Receipt Automation
Create Voice Delivery Receipt Automation
CLICKSEND_CREATE_AUTOMATIONS_VOICE_RECEIPTSTool 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.Input Parameters
Output
Create Delivery Issue
Create Delivery Issue
CLICKSEND_CREATE_DELIVERY_ISSUESTool 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.Input Parameters
Output
Create Allowed Email Address
Create Allowed Email Address
CLICKSEND_CREATE_EMAIL_ADDRESSES2Tool 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.Input Parameters
Output
Get Allowed Email Addresses
Get Allowed Email Addresses
Create Email Template from Master
Create Email Template from Master
CLICKSEND_CREATE_EMAIL_TEMPLATESTool 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.Input Parameters
Output
Add Fax Delivery Receipt Webhook
Add Fax Delivery Receipt Webhook
CLICKSEND_CREATE_FAX_RECEIPTSTool to add a test fax delivery receipt webhook URL in ClickSend. Use when you need to configure a webhook URL to receive fax delivery receipts or set it to ‘poll’ for manual retrieval. When successful, ClickSend sends a test receipt to verify the webhook configuration.Input Parameters
Output
Create Contact List
Create Contact List
CLICKSEND_CREATE_LISTSTool 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.Input Parameters
Output
Create Contact in List
Create Contact in List
CLICKSEND_CREATE_LISTS_CONTACTSTool 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.Input Parameters
Output
Send MMS Messages
Send MMS Messages
CLICKSEND_CREATE_MMS_SENDTool 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.Input Parameters
Output
Send Direct Mail Campaign
Send Direct Mail Campaign
CLICKSEND_CREATE_POST_DIRECT_MAIL_CAMPAIGNS_SENDTool 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.Input Parameters
Output
Detect Address from PDF or String
Detect Address from PDF or String
CLICKSEND_CREATE_POST_LETTERS_DETECT_ADDRESSTool 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.Input Parameters
Output
Send Post Letter
Send Post Letter
CLICKSEND_CREATE_POST_LETTERS_SENDTool 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.Input Parameters
Output
Create Post Return Address
Create Post Return Address
CLICKSEND_CREATE_POST_RETURN_ADDRESSESTool 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.Input Parameters
Output
Get All Post Return Addresses
Get All Post Return Addresses
Create and Send SMS Campaign
Create and Send SMS Campaign
CLICKSEND_CREATE_SMS_CAMPAIGNS_SENDTool 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.Input Parameters
Output
Create Email-to-SMS Allowed Address
Create Email-to-SMS Allowed Address
CLICKSEND_CREATE_SMS_EMAIL_SMS2Tool 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.Input Parameters
Output
Get SMS Email-to-SMS Allowed Address
Get SMS Email-to-SMS Allowed Address
CLICKSEND_CREATE_SMS_EMAIL_SMS3Tool 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.Input Parameters
Output
Update Email-to-SMS Allowed Address
Update Email-to-SMS Allowed Address
CLICKSEND_CREATE_SMS_EMAIL_SMS4Tool 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.Input Parameters
Output
Delete SMS Email-to-SMS Allowed Address
Delete SMS Email-to-SMS Allowed Address
CLICKSEND_CREATE_SMS_EMAIL_SMS5Tool 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.Input Parameters
Output
Create Email to SMS Stripped String Rule
Create Email to SMS Stripped String Rule
CLICKSEND_CREATE_SMS_EMAIL_SMS_STRIPPED_STRINGSTool 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.Input Parameters
Output
Create Test Inbound SMS
Create Test Inbound SMS
CLICKSEND_CREATE_SMS_INBOUNDCreates a test inbound SMS message to verify webhook configuration in ClickSend. This generates a simulated inbound SMS that will be sent to your configured webhook URL, allowing you to test that your webhook is correctly receiving and processing inbound SMS messages. Use this to validate your webhook setup before going live with real SMS traffic.Input Parameters
Output
Create Test SMS Delivery Receipt
Create Test SMS Delivery Receipt
CLICKSEND_CREATE_SMS_RECEIPTSTool to create a test SMS delivery receipt and configure the webhook URL in ClickSend. This sends a test delivery receipt to your webhook URL to verify webhook configuration is working correctly. Use when you need to test webhook integration for SMS delivery receipts or set to ‘poll’ for manual retrieval.Input Parameters
Output
Send SMS Messages
Send SMS Messages
CLICKSEND_CREATE_SMS_SENDTool 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.Input Parameters
to field must be in full international format with ’+’ and country code (e.g., ‘+12025551234’). Optional schedule field accepts a Unix timestamp (seconds) to delay sending; omit to send immediately. Long or Unicode-heavy body values may be split into multiple SMS segments, affecting billing.Output
Create SMS Template
Create SMS Template
CLICKSEND_CREATE_SMS_TEMPLATESTool to create a new SMS template for reuse in campaigns. Use when you need to save an SMS message as a reusable template.Input Parameters
Output
Create Subaccount
Create Subaccount
CLICKSEND_CREATE_SUBACCOUNTSTool 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.Input Parameters
Output
Delete Inbound SMS Automation
Delete Inbound SMS Automation
Delete Contact List
Delete Contact List
Delete Contact from List
Delete Contact from List
CLICKSEND_DELETE_LISTS_CONTACTSTool 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.Input Parameters
Output
Remove Opted Out Contacts from List
Remove Opted Out Contacts from List
CLICKSEND_DELETE_LISTS_REMOVE_OPTED_OUT_CONTACTSTool 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.Input Parameters
Output
Cancel Scheduled SMS
Cancel Scheduled SMS
Delete Subaccount
Delete Subaccount
Get Email Campaign
Get Email Campaign
Delete Email Delivery Receipt Automation
Delete Email Delivery Receipt Automation
Get Email Delivery Receipt Automation
Get Email Delivery Receipt Automation
CLICKSEND_EMAIL_DELIVERY_RECEIPT_AUTOMATION_GETRetrieves the configuration details of a specific email delivery receipt automation rule by its ID. Use this action when you need to: - View the current configuration of a specific automation rule - Check whether a rule is enabled or disabled - Verify the webhook URL or action settings for a rule - Get details before updating or deleting a rule To get the receipt_rule_id, you can first list all rules using the ‘Get All Email Delivery Receipt Automations’ action, or use the ID returned when creating a new rule.Input Parameters
Output
Delete Email Template
Delete Email Template
Get Email Template
Get Email Template
CLICKSEND_EMAIL_TEMPLATE_GETTool 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.Input Parameters
Output
Update Email Template
Update Email Template
CLICKSEND_EMAIL_TEMPLATE_PUTUpdate an existing ClickSend email template by ID, supplying its HTML body and optionally a new name.Input Parameters
Output
Export Post Letters History
Export Post Letters History
CLICKSEND_EXPORT_POST_LETTERS_HISTORY_EXPORTTool 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.Input Parameters
Output
Delete Fax Delivery Receipt Automation
Delete Fax Delivery Receipt Automation
Get Fax Delivery Receipt Automation
Get Fax Delivery Receipt Automation
Get Fax Receipt by Message ID
Get Fax Receipt by Message ID
Mark Fax Receipts as Read
Mark Fax Receipts as Read
CLICKSEND_FAX_RECEIPTS_READ_PUTTool 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.Input Parameters
Output
Get Account Information
Get Account Information
Get All Email Delivery Receipt Automations
Get All Email Delivery Receipt Automations
CLICKSEND_GET_AUTOMATIONS_EMAIL_RECEIPTSTool 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.Input Parameters
Output
Get All Inbound Fax Automations
Get All Inbound Fax Automations
CLICKSEND_GET_AUTOMATIONS_FAX_INBOUNDTool 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.Input Parameters
Output
Get All Fax Delivery Receipt Automations
Get All Fax Delivery Receipt Automations
Get All Inbound SMS Automations
Get All Inbound SMS Automations
Get All SMS Delivery Receipt Automations
Get All SMS Delivery Receipt Automations
Get All Voice Delivery Receipt Automations
Get All Voice Delivery Receipt Automations
Get Contact Suggestions
Get Contact Suggestions
CLICKSEND_GET_CONTACT_SUGGESTIONSRetrieves contact suggestions from your ClickSend account based on recent messaging activity. Returns contacts from your lists that you may want to message, with full contact details including phone, email, address, and custom fields. Useful for finding frequently contacted recipients or planning messaging campaigns. Supports pagination via page and limit parameters.Input Parameters
Output
Get All Countries
Get All Countries
Get All Delivery Issues
Get All Delivery Issues
Get All Master Email Templates
Get All Master Email Templates
Get All Master Email Template Categories
Get All Master Email Template Categories
Get All User Email Templates
Get All User Email Templates
Get Fax Delivery Receipts
Get Fax Delivery Receipts
Get All Contact Lists
Get All Contact Lists
Get Specific Contact List
Get Specific Contact List
CLICKSEND_GET_LISTS2Tool 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.Input Parameters
Output
Get All Contacts in List
Get All Contacts in List
CLICKSEND_GET_LISTS_CONTACTSTool 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.Input Parameters
Output
Get Specific Contact
Get Specific Contact
CLICKSEND_GET_LISTS_CONTACTS2Tool 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.Input Parameters
Output
Export Contacts List
Export Contacts List
CLICKSEND_GET_LISTS_EXPORTTool 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
Output
Import Contacts to List
Import Contacts to List
CLICKSEND_GET_LISTS_IMPORTTool 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.Input Parameters
Output
Preview CSV Import for Contact List
Preview CSV Import for Contact List
CLICKSEND_GET_LISTS_IMPORT_CSV_PREVIEWTool 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.Input Parameters
Output
Get List Import Fields
Get List Import Fields
CLICKSEND_GET_LISTS_IMPORT_FIELDSTool 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.Input Parameters
Output
Export MMS History
Export MMS History
CLICKSEND_GET_MMS_HISTORYTool to export MMS message history with filtering, ordering, and pagination. Use when you need to retrieve historical MMS messages with custom sorting options.Input Parameters
Output
Get MMS Delivery Receipts
Get MMS Delivery Receipts
Get Dedicated Numbers
Get Dedicated Numbers
Search Dedicated Numbers by Country
Search Dedicated Numbers by Country
CLICKSEND_GET_NUMBERS_SEARCHTool to search for available dedicated numbers by country code. Use when you need to find purchasable phone numbers for messaging services in a specific country.Input Parameters
Output
Search Direct Mail Locations
Search Direct Mail Locations
CLICKSEND_GET_POST_DIRECT_MAIL_LOCATIONS_SEARCHTool to search for direct mail locations in a specific country. Use when you need to find available locations or addresses for direct mail services.Input Parameters
Output
Get Post Letters History
Get Post Letters History
Get Country Pricing
Get Country Pricing
CLICKSEND_GET_PRICINGTool 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.Input Parameters
Output
Get Referral Accounts
Get Referral Accounts
Get Reseller Settings
Get Reseller Settings
CLICKSEND_GET_RESELLERTool 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.Output
Get Reseller Accounts
Get Reseller Accounts
CLICKSEND_GET_RESELLER_ACCOUNTSTool 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.Input Parameters
Output
Get SMS Campaign
Get SMS Campaign
Get SMS Campaigns List
Get SMS Campaigns List
CLICKSEND_GET_SMS_CAMPAIGNS3Retrieve a paginated list of SMS campaigns, with optional search filtering, for campaign management.Input Parameters
Output
Get Email to SMS Stripped String Rules List
Get Email to SMS Stripped String Rules List
Get SMS History
Get SMS History
CLICKSEND_GET_SMS_HISTORYTool 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
Output
Get Inbound SMS Messages
Get Inbound SMS Messages
CLICKSEND_GET_SMS_INBOUNDRetrieves inbound SMS messages received by your ClickSend account. Use this tool when you need to: - View messages sent TO your ClickSend numbers FROM customers/recipients - Search for specific messages by sender, recipient, or content - Monitor incoming SMS replies and interactions Important: To receive inbound messages via API polling, you must first configure an inbound rule in the ClickSend Dashboard with the Action set to ‘POLL’. By default, only unread messages are returned.Input Parameters
Output
Get SMS Delivery Receipts
Get SMS Delivery Receipts
CLICKSEND_GET_SMS_RECEIPTSTool 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
Output
Get All SMS Templates
Get All SMS Templates
CLICKSEND_GET_SMS_TEMPLATESTool 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.Input Parameters
Output
Get SMS Statistics
Get SMS Statistics
Get Voice Statistics
Get Voice Statistics
Get All Subaccounts
Get All Subaccounts
Get Specific Subaccount
Get Specific Subaccount
CLICKSEND_GET_SUBACCOUNTS2Tool 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.Input Parameters
Output
Get Supported Timezones
Get Supported Timezones
Get Voice Languages
Get Voice Languages
List Countries
List Countries
Copy Contact to Another List
Copy Contact to Another List
CLICKSEND_LISTS_COPY_CONTACT_PUTTool 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.Input Parameters
Output
Transfer Contact Between Lists
Transfer Contact Between Lists
CLICKSEND_LISTS_TRANSFER_CONTACT_PUTTool 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.Input Parameters
Output
Get Master Email Template Category
Get Master Email Template Category
Get Master Email Template
Get Master Email Template
CLICKSEND_MASTER_EMAIL_TEMPLATE_GETRetrieve a specific master email template by its ID. Returns template metadata including name, creation date, and thumbnail URLs. Use this to view details of pre-designed master email templates available in ClickSend. Template IDs can be obtained from the ‘Get All Master Email Templates’ action.Input Parameters
Output
Get Master Email Templates in Category
Get Master Email Templates in Category
CLICKSEND_MASTER_EMAIL_TEMPLATES_IN_CATEGORY_GETRetrieve master email templates within a specific category, with pagination. Use this to browse ClickSend’s pre-designed email template library by category.Input Parameters
Output
Update MMS Campaign
Update MMS Campaign
CLICKSEND_MMS_CAMPAIGNS_BY_MMS_CAMPAIGN_ID_PUTUpdate an existing MMS campaign’s contact list, name, sender, message body, subject and media file, with an optional scheduled send time. The campaign details must be supplied together.Input Parameters
Output
Cancel MMS Campaign
Cancel MMS Campaign
Get MMS Campaigns
Get MMS Campaigns
Calculate MMS Campaign Price
Calculate MMS Campaign Price
CLICKSEND_MMS_CAMPAIGNS_PRICE_POSTTool 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.Input Parameters
Output
Send MMS Campaign
Send MMS Campaign
CLICKSEND_MMS_CAMPAIGNS_SEND_POSTTool 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.Input Parameters
Output
Export MMS History
Export MMS History
CLICKSEND_MMS_HISTORY_EXPORT_GETTool to export MMS message history to a CSV file. Supports filtering by query string, date range, ordering, and limiting results. Use when you need to download historical MMS messages for analysis or archival purposes.Input Parameters
Output
Calculate MMS Price
Calculate MMS Price
Mark MMS Receipts as Read
Mark MMS Receipts as Read
CLICKSEND_MMS_RECEIPTS_READ_PUTTool 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.Input Parameters
Output
Buy Dedicated Number
Buy Dedicated Number
Delete Post Return Address
Delete Post Return Address
CLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_DELETETool to delete a specific post return address from the system. Use when you need to remove a return address from your postal mailings.Input Parameters
Output
Get Post Return Address
Get Post Return Address
CLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_GETTool 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.Input Parameters
Output
Update Post Return Address
Update Post Return Address
CLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_PUTTool 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.Input Parameters
Output
Upload File
Upload File
CLICKSEND_POST_UPLOADSTool 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.Input Parameters
Output
Forgot Password
Forgot Password
CLICKSEND_PUT_FORGOT_PASSWORDInitiates password recovery for a ClickSend account by sending a password reset link via email. Use this tool when a user has forgotten their password and needs to reset it. The API will send an email to the account’s registered email address with a link/token to reset the password. Note: Accounts configured for OAuth/Google authentication cannot use this endpoint and will return a 400 status with an explanatory message.Input Parameters
Output
Forgot Username
Forgot Username
CLICKSEND_PUT_FORGOT_USERNAMETool to retrieve forgotten username by providing registered email or phone number. Use when a user needs to recover their account username via notification.Input Parameters
Output
Get Recharge Packages
Get Recharge Packages
Purchase Recharge Package
Purchase Recharge Package
CLICKSEND_RECHARGE_PURCHASE_BY_PACKAGE_ID_PUTPurchase a recharge package by package ID to add credits to a ClickSend account. Before using this action, call ‘Get Recharge Packages’ to retrieve available package IDs and their pricing. This action requires a valid payment method configured on the account. In test/sandbox environments, this may return a payment gateway error if no payment method is configured. Common error responses: - 404 “Customer token not found”: No payment method configured - 404 “Package not found”: Invalid package ID - 401 “Authorization failed”: Authentication issueInput Parameters
Output
Get All Recharge Transactions
Get All Recharge Transactions
Get Recharge Transaction by ID
Get Recharge Transaction by ID
Search Contact Lists and Contacts
Search Contact Lists and Contacts
CLICKSEND_SEARCH_CONTACTS_LISTS_GETSearch for contact lists and individual contacts in your ClickSend account by name with pagination support. Returns both contact lists (type=‘list’) and individual contacts (type=‘contact’) that match the search query. Search is case-insensitive and matches partial names. Use when you need to find specific contact lists or contacts by name.Input Parameters
Output
Send Email Verification Token
Send Email Verification Token
CLICKSEND_SEND_VERIFICATION_TOKEN_GETTool 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.Input Parameters
Output
Cancel SMS Campaign
Cancel SMS Campaign
Cancel All Scheduled SMS
Cancel All Scheduled SMS
CLICKSEND_SMS_CANCEL_ALL_PUTTool to cancel all scheduled SMS messages in ClickSend. Use this when you need to cancel pending scheduled SMS messages in bulk. Only affects messages that are scheduled for future delivery and have not yet been sent. Key behaviors: - Without custom_string: Cancels ALL scheduled SMS messages in the account - With custom_string: Cancels only scheduled messages matching that specific custom_string identifier - Returns the count of messages that were successfully cancelled - Does not affect messages that have already been sent or are currently being sent - This operation is idempotent - calling it multiple times has the same effectInput Parameters
Output
Delete SMS Delivery Receipt Automation
Delete SMS Delivery Receipt Automation
Get SMS Delivery Receipt Automation
Get SMS Delivery Receipt Automation
Delete Email to SMS Stripped String Rule
Delete Email to SMS Stripped String Rule
CLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_DELETETool 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.Input Parameters
Output
Get Email to SMS Stripped String Rule
Get Email to SMS Stripped String Rule
CLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_GETTool 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.Input Parameters
Output
Update Email to SMS Stripped String Rule
Update Email to SMS Stripped String Rule
CLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_PUTTool 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.Input Parameters
Output
Export SMS History
Export SMS History
CLICKSEND_SMS_HISTORY_EXPORT_GETTool to export all SMS message history to a CSV file. Downloads a complete export of your SMS history. Use when you need to download all historical SMS messages for analysis, reporting, backup, or archival purposes. Note: This exports all SMS history without filtering - use ‘Get SMS History’ action first if you need to filter by date, status, or other criteria before deciding to export.Input Parameters
Output
Get Inbound SMS Automation
Get Inbound SMS Automation
Update Inbound SMS Automation
Update Inbound SMS Automation
CLICKSEND_SMS_INBOUND_AUTOMATION_PUTTool to update an existing inbound SMS automation rule in ClickSend. Use when you need to modify automated actions for inbound SMS messages.Input Parameters
Output
Mark Inbound SMS as Read by Message ID
Mark Inbound SMS as Read by Message ID
CLICKSEND_SMS_INBOUND_READ_BY_MESSAGE_ID_PUTMark a specific inbound SMS message as read by message ID. A 404 is returned as a normal response and may mean the message was not found or was already read.Input Parameters
Output
Mark Inbound SMS as Read
Mark Inbound SMS as Read
CLICKSEND_SMS_INBOUND_READ_PUTMark inbound SMS messages as read in ClickSend. Use this action to mark all inbound SMS messages as read, or only those received before a specific timestamp. This is commonly used after polling for new messages with GET /sms/inbound to prevent re-reading the same messages. Once marked as read, messages will no longer appear in the default View Inbound SMS (GET /sms/inbound) response, but remain accessible via the View Specific Inbound SMS by Message ID endpoint. The operation is idempotent - marking already-read messages has no negative effect.Input Parameters
Output
Calculate SMS Price
Calculate SMS Price
Get SMS Receipt by Message ID
Get SMS Receipt by Message ID
Mark SMS Delivery Receipts as Read
Mark SMS Delivery Receipts as Read
CLICKSEND_SMS_RECEIPTS_READ_PUTTool 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.Input Parameters
Output
Delete SMS Template
Delete SMS Template
Update SMS Template
Update SMS Template
CLICKSEND_SMS_TEMPLATES_BY_TEMPLATE_ID_PUTTool to update an existing SMS template in ClickSend. Use when you need to modify the name or body content of an SMS template.Input Parameters
Output
Delete Specific Allowed Email Address
Delete Specific Allowed Email Address
CLICKSEND_SPECIFIC_ALLOWED_EMAIL_ADDRESS_DELETETool 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.Input Parameters
Output
Get Specific Allowed Email Address
Get Specific Allowed Email Address
CLICKSEND_SPECIFIC_ALLOWED_EMAIL_ADDRESS_GETTool 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.Input Parameters
Output
Regenerate Subaccount API Key
Regenerate Subaccount API Key
CLICKSEND_SUBACCOUNTS_REGEN_API_KEY_BY_SUBACCOUNT_ID_PUTTool 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.Input Parameters
Output
Update Account Information
Update Account Information
Update Email Delivery Receipt Automation
Update Email Delivery Receipt Automation
CLICKSEND_UPDATE_AUTOMATIONS_EMAIL_RECEIPTSTool 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.Input Parameters
Output
Update Inbound Fax Automation
Update Inbound Fax Automation
CLICKSEND_UPDATE_AUTOMATIONS_FAX_INBOUNDTool 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.Input Parameters
Output
Update Fax Delivery Receipt Automation
Update Fax Delivery Receipt Automation
CLICKSEND_UPDATE_AUTOMATIONS_FAX_RECEIPTSTool 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.Input Parameters
Output
Update SMS Delivery Receipt Automation
Update SMS Delivery Receipt Automation
CLICKSEND_UPDATE_AUTOMATIONS_SMS_RECEIPTSTool 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.Input Parameters
Output
Update Contact List
Update Contact List
Update Contact in List
Update Contact in List
CLICKSEND_UPDATE_LISTS_CONTACTSTool 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
Output
Get Recharge Credit Card Info
Get Recharge Credit Card Info
Update Reseller Settings
Update Reseller Settings
CLICKSEND_UPDATE_RESELLERTool 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.Input Parameters
Output
Update SMS Campaign
Update SMS Campaign
CLICKSEND_UPDATE_SMS_CAMPAIGNSUpdate an existing SMS campaign. Modify campaign details including name, message content, contact list, sender ID, or schedule time. IMPORTANT: Only scheduled campaigns (with future send time) can be updated. Once a campaign is sent or queued for immediate sending, it cannot be modified. When updating, always include the ‘schedule’ parameter with a future timestamp to keep the campaign editable.Input Parameters
Output
Update Subaccount
Update Subaccount
CLICKSEND_UPDATE_SUBACCOUNTSUpdate a specific ClickSend subaccount’s credentials, contact information, and access permissions. Unless explicitly set to null, omitted access permissions are sent with defaults: users, billing, reporting and settings enabled, and contacts disabled.Input Parameters
Output
Agree to User Countries Rules
Agree to User Countries Rules
Get User Countries
Get User Countries
Select User Countries
Select User Countries
CLICKSEND_USER_COUNTRIES_POSTTool 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.Input Parameters
Output
Verify Allowed Email Address
Verify Allowed Email Address
CLICKSEND_VERIFY_ALLOWED_EMAIL_ADDRESS_GETVerify an email address using its activation token to enable it as a sender address for email campaigns. This action completes the email address verification process after: 1. Creating an allowed email address (via Create Allowed Email Address action) 2. Requesting a verification email (via Send Email Verification Token action) 3. Retrieving the activation token from the email inbox A verified email address is required before it can be used as a sender address for transactional emails and email campaigns through ClickSend.Input Parameters
Output
Verify Forgot Password
Verify Forgot Password
Cancel All Scheduled Voice Messages
Cancel All Scheduled Voice Messages
Delete Voice Receipt Automation
Delete Voice Receipt Automation
Get Voice Delivery Receipt Automation
Get Voice Delivery Receipt Automation
Update Voice Delivery Receipt Automation
Update Voice Delivery Receipt Automation
CLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_PUTTool 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. Important: This endpoint requires ALL fields (rule_name, match_type, action, action_address, enabled) to be provided in the update request. To update a rule, first retrieve its current values using the GET endpoint, then send the complete updated configuration.Input Parameters
Output
Export Voice History
Export Voice History
CLICKSEND_VOICE_HISTORY_EXPORT_GETTool to export all voice history to a CSV file. Use when you need to download a complete history of voice messages sent from your ClickSend account. Returns a downloadable file containing voice message records including timestamps, recipients, status, and other details. Note: This action requires existing voice message history; it will fail with a clear message if no voice messages have been sent.Input Parameters
Output
Mark Voice Delivery Receipts as Read
Mark Voice Delivery Receipts as Read
CLICKSEND_VOICE_RECEIPTS_READ_PUTTool 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.