Skip to main content
ClickSend logo
  • Category: phone & sms
  • Auth: BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 166
  • Triggers: 0
  • Slug: CLICKSEND
  • Version: 20261101_00

Tools

Slug: 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

integer
required
Year to filter usage by in four-digit format (yyyy)
integer
required
Month to filter usage by in numeric format (1-12)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_ACCOUNT_VERIFY_SEND_PUTTool to send an account activation token for verification. Use when you need to verify a new user account via SMS or other verification method.

Input Parameters

string
Verification method type. Required for successful verification.
string
Country designation (e.g., ‘US’). Required for successful verification.
string
Your phone number in E.164 format (e.g., ‘+13523944199’). Required for successful verification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_ACCOUNT_VERIFY_VERIFY_BY_ACTIVATION_TOKEN_PUTTool 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.

Input Parameters

integer
required
Activation token for account verification (integer format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Whether letter is printed in colour. 0 = black and white, 1 = colour. Default is 0.
integer
Whether letter is printed double-sided. 0 = single-sided, 1 = double-sided. Default is 0.
string
Source identifier for tracking purposes. Can be any string value.
string
required
URL of the PDF file to calculate price for. For docx/doc files, convert them first using the /uploads?convert=post endpoint. Supported formats: pdf, docx, doc, jpg, gif, png, bmp.
array
required
Array of recipient objects. Each recipient represents a person who will receive a copy of the letter.
integer
Whether the letter is priority post. 0 = standard post, 1 = priority post. Default is 0.
integer
Whether using a ClickSend template. 0 = not using template, 1 = using template. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your campaign message content. Use placeholders like (First Name) for personalization. Required field.
string
Sender identifier (phone number or alphanumeric sender ID). See ClickSend docs for supported formats. Optional field.
string
required
Your campaign name for identification. Required field.
integer
required
Your contact list ID containing the campaign recipients. Required field.
integer
Unix timestamp for scheduling the campaign. Defaults to 0 for immediate sending. Optional field.
string
URL to shorten in the campaign. IMPORTANT: When using this parameter, you MUST include the placeholder ‘http://smsg.io/xxxxx’ in your message body where the shortened link should appear. The API will reject requests with url_to_shorten if the placeholder is missing from the body. Optional field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Determines the response type when rule matches. Currently only ‘URL’ is supported for email delivery receipt automations. When using ‘URL’, specify a valid HTTP/HTTPS endpoint in action_address.
integer
required
Controls activation status of the rule. Use 1 to enable the rule immediately, or 0 to create it in a disabled state.
string
required
Name to identify the automation rule. Helps organize and manage multiple rules.
integer
required
Specifies match criteria for the delivery receipt. Use 0 to match all email delivery reports.
string
required
The URL endpoint where delivery receipt data should be posted. Must be a valid HTTP or HTTPS URL. Required when action is ‘URL’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The action to perform when a fax is received. Supported actions: EMAIL_FIXED (send to fixed email), URL (send to webhook), POLL (retrieve via API polling), EMAIL_USER (send to user’s email), SMS (send SMS notification), AUTO_REPLY, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL, CREATE_CONTACT_PLUS_NAME, SMPP, NONE.
integer
required
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
required
Name of the automation rule to identify it. Helps organize and manage multiple rules.
string
required
The destination address for the action. For EMAIL_FIXED/EMAIL_USER, provide an email address. For URL/POLL, provide a webhook URL. For SMS, provide a phone number.
string
required
The dedicated fax number to apply this rule to. Use ’*’ to apply the rule to all fax numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Action to perform when a fax delivery receipt is received. Common values: ‘URL’ (webhook), ‘EMAIL_FIXED’ (send to specific email), ‘EMAIL_USER’ (send to account email), ‘SMS’, ‘POLL’. Other options: AUTO_REPLY, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, CREATE_CONTACT_PLUS_EMAIL, CREATE_CONTACT_PLUS_NAME_EMAIL, CREATE_CONTACT_PLUS_NAME, SMPP, NONE.
integer
Rule activation status. 1 = rule is active and will trigger, 0 = rule is disabled. Default: 1
string
required
Descriptive name for the automation rule. Used to identify and organize rules in your account.
integer
Match criteria type for fax receipts. Currently only 0 (match all fax delivery receipts) is supported. Default: 0
string
required
Destination for the action. For ‘URL’: webhook endpoint URL. For ‘EMAIL_FIXED’/‘EMAIL_USER’: email address. For ‘SMS’: phone number. Must match the action type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
integer
required
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
required
Name of the automation rule to identify it. Helps organize and manage multiple rules.
string
Webhook format type. Valid values: ‘post’, ‘get’, or ‘json’. Defaults to ‘post’ if not specified.
string
required
Target destination for the specified action. For EMAIL_FIXED provide email address, for URL provide webhook URL, for contact lists provide list ID.
string
required
The dedicated phone number to apply this rule to. Use ’*’ to apply the rule to all numbers.
string
Text pattern to match against incoming messages. Can be null for message_search_type=0 (any message).
integer
required
Message matching logic. 0 = Any message, 1 = starts with, 2 = contains, 3 = does not contain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Determines the response type 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, or NONE.
integer
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
Name to identify the automation rule. Helps organize and manage multiple rules.
integer
required
Specifies match criteria for the delivery receipt. Valid values: 0 (match all reports), 1, or 2. Values must be between 0 and 2.
string
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL for URL action).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Response action to perform when rule matches (e.g., ‘URL’ for webhook, ‘EMAIL_FIXED’ for email notification).
integer
required
Binary flag to activate/deactivate the rule. 1 = enabled, 0 = disabled.
string
required
Name identifying the automation rule. Helps organize and manage multiple rules.
integer
required
Determines which delivery statuses trigger the rule. Valid values: 0 = All delivery reports, 1 = Specific status filter, 2 = Specific status filter. Must be between 0 and 2.
string
required
Target destination for the action - URL endpoint or email address where delivery receipts will be sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The type of message. Required. Must be one of: SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST.
string
required
The message ID of the message. Required field to reference the specific message that has delivery issues. This should be the UUID returned when the message was sent.
string
required
The description of the delivery issue. Required field explaining what went wrong with the message delivery.
string
required
The user’s email address for contact regarding this delivery issue. Required field.
string
Optional comments from the user providing additional context about the delivery issue.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email address to be allowed for sending transactional emails. This address will need to be verified before use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_CREATE_EMAIL_ADDRESSES6Tool 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.

Input Parameters

integer
Page number for pagination. Default: 1. Minimum value is 1.
integer
Number of records per page. Default: 15. Minimum value is 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The intended name for the new email template. This is a user-defined name that will identify your custom template.
integer
required
The ID of the master template you want to base your new template on. This references an existing master template that will serve as the foundation for the new template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your webhook URL where fax delivery receipt notifications will be sent. ClickSend will POST delivery status updates to this endpoint when faxes are delivered. Can also be set to ‘poll’ to retrieve receipts manually via the Get Fax Receipts endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the contact list to create. Maximum 50 characters (longer names will be truncated). Note: Duplicate names are allowed; each list will have a unique list_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Contact’s email address. At least one of phone_number, email, or fax_number must be provided.
integer
required
The unique identifier of the contact list where the contact will be created. Must be a valid list ID from your account.
string
Custom field 1 for additional contact information
string
Custom field 2 for additional contact information
string
Custom field 3 for additional contact information
string
Custom field 4 for additional contact information
string
Contact’s last name
string
Contact’s fax number. At least one of phone_number, email, or fax_number must be provided.
string
Contact’s first name
string
City in contact’s address
string
Contact’s phone number in E.164 format (e.g., +61411111111). At least one of phone_number, email, or fax_number must be provided.
string
State or province in contact’s address
string
First line of contact’s address
string
Second line of contact’s address
string
Country code in contact’s address. Must be a valid ISO 3166-1 alpha-2 code (2-letter country code in uppercase).
string
Contact’s organization or company name
string
Postal or ZIP code in contact’s address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of MMS message objects to send. Required - at least one message, maximum 1000 messages per API call.
string
required
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). Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Campaign name for identification and tracking purposes.
string
required
Size of the direct mail piece. Valid values depend on the target country. Common options include ‘A5’ (148x210mm) and ‘DL’ (99x210mm envelope size). Note: Some sizes like ‘A4’ may not be valid for certain locations.
array
required
List of target areas with their respective quantities. Each area requires a location_id (obtained from the location search API) and quantity (typically 5000+ pieces per location). You can target multiple locations in a single campaign.
array
required
List of publicly accessible URLs pointing to PDF files for the direct mail content. Must be valid URLs to PDF files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Address string to be converted to standard format. Either ‘content’ or ‘address’ must be provided, but not both. Use newline characters to separate address lines.
string
Base64-encoded PDF file content. The PDF should be in standard address format with recipient’s name and address at the top. Either ‘content’ or ‘address’ must be provided, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Whether letter is printed in colour. 0 = black and white, 1 = colour. Default is 0.
integer
Whether letter is printed double-sided. 0 = single-sided, 1 = double-sided. Default is 0.
string
Source identifier for tracking purposes. Can be any string value.
string
required
URL of the PDF file to send. For docx/doc files, convert them first using the /uploads?convert=post endpoint. Supported formats: pdf, docx, doc, jpg, gif, png, bmp.
array
required
Array of recipient objects. Each recipient represents a person who will receive a copy of the letter.
integer
Whether the letter is priority post. 0 = standard post, 1 = priority post. Default is 0.
integer
Whether using a ClickSend template. 0 = not using template, 1 = using template. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
City name for the return address. This is a required field.
string
required
Name or label for the return address. This will be used to identify the address in your account.
string
State, province, or region for the return address. This is an optional field but recommended.
string
required
First line of the street address. This is a required field for the return address.
string
Second line of the street address (apartment, suite, building, etc.). This is an optional field.
string
required
Country code for the return address (e.g., ‘US’, ‘AU’, ‘GB’). This is a required field. Use ISO country codes.
string
required
Postal code or ZIP code for the return address. This is a required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_CREATE_POST_RETURN_ADDRESSES3Tool 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.

Input Parameters

integer
Page number for pagination. Specifies which page of results to retrieve. Must be at least 1.
integer
Number of records to return per page. Must be between 15 and 100. Default is 15.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The SMS sender number or identifier that will be used when messages are sent from this email address.
string
Fax number associated with the sender (optional).
string
required
The email address to be added as an allowed address for email-to-SMS conversion. Must be a valid email address.
integer
required
The subaccount ID to assign this email-to-SMS usage to for reporting purposes. Required by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the allowed email address to retrieve. Must be a valid email address ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The SMS sender number or identifier that will be used when messages are sent from this email address.
string
Language code for text-to-speech conversion (if applicable). Common values include ‘en-us’, ‘en-gb’, etc.
string
Voice type for text-to-speech conversion (if applicable). Common values include ‘female’, ‘male’.
string
required
The email address to update. Must be a valid email address.
integer
required
The unique identifier of the allowed email address to update. Must be a valid email address ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the email address to delete from allowed email addresses. Must be a valid email address ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The string to be stripped from email-to-SMS messages. When this string is encountered, everything after it (including the string itself) will be removed from the SMS message. Useful for removing email signatures.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The webhook URL where the test inbound SMS will be sent. Must be a valid HTTP/HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The webhook URL where SMS delivery receipts will be sent. Set to ‘poll’ to use ClickSend’s system for later retrieval via the View SMS Receipt endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of SMS messages to send. You can post up to 1000 messages with each API call. Each message must have ‘to’ and ‘body’ fields at minimum. The 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The content/message text of the SMS template. This is the actual SMS message content that will be sent when using this template.
string
required
The name of the SMS template. This is a user-defined name that will identify your custom template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Email address for the subaccount. This is required for account notifications and communications.
string
Optional notes about the subaccount for reference purposes. Maximum 50 characters.
integer
User ID to associate with the subaccount. Optional field for linking to existing user.
string
required
Password for the new subaccount. Must be a strong password for security.
string
required
Last name of the subaccount user. Required field.
string
required
First name of the subaccount user. Required field.
integer
Access to SMPP protocol. Use 0 for no access, 1 for access granted.
integer
Access to users management. Use 0 for no access, 1 for access granted.
string
required
Username for the new subaccount. Must be the same as the email address. This will be used for API authentication.
string
required
Phone number in international format (e.g., ‘+61411111111’). Required contact number for the subaccount.
integer
Access to billing features. Use 0 for no access, 1 for access granted.
integer
Access to contacts management. Use 0 for no access, 1 for access granted.
integer
Access to settings. Use 0 for no access, 1 for access granted.
integer
Access to reporting features. Use 0 for no access, 1 for access granted.
integer
SMS de-identify message setting. Use 0 for disabled, 1 for enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_DELETE_AUTOMATIONS_SMS_INBOUNDTool to delete an inbound SMS automation rule. Use when you need to remove an existing inbound SMS automation by its rule ID.

Input Parameters

integer
required
Unique identifier of the inbound SMS automation rule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_DELETE_LISTSTool to delete a specific contact list from your ClickSend account. Use when you need to remove a contact list permanently.

Input Parameters

integer
required
The unique identifier of the contact list to delete. Must be a valid list ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact list from which the contact will be deleted. Must be a valid list ID from your account.
integer
required
The unique identifier of the contact to delete from the list. Must be a valid contact ID within the specified list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact list from which opted out contacts will be removed. Must be a valid list ID from your account.
integer
required
The unique identifier of the opt out list used as reference to remove opted out contacts. Must be a valid opt out list ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_DELETE_SMS_CANCELTool to cancel a scheduled SMS message by updating its status to cancelled. Use when you need to prevent a scheduled SMS from being sent.

Input Parameters

string
required
Unique identifier for the scheduled SMS message to cancel (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_DELETE_SUBACCOUNTSTool to delete a specific subaccount from the system. Use when you need to remove a subaccount from your account.

Input Parameters

integer
required
The unique identifier of the subaccount to delete. Must be a valid subaccount ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_EMAIL_CAMPAIGN_GETTool 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.

Input Parameters

integer
required
Unique identifier of the email campaign to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_EMAIL_DELIVERY_RECEIPT_AUTOMATION_DELETETool to delete an email delivery receipt automation rule. Use when you need to remove an existing email receipt automation by its rule ID.

Input Parameters

integer
required
Unique identifier of the email delivery receipt automation rule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique identifier of the email delivery receipt automation rule to retrieve. This ID is returned when creating a rule or can be obtained by listing all rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_EMAIL_TEMPLATE_DELETETool to delete an email template by its template ID. Use when you need to remove an existing email template from your account.

Input Parameters

integer
required
Unique identifier of the email template to delete. Must be a valid template ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Unique identifier of the email template to retrieve. Must be a valid template ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_EMAIL_TEMPLATE_PUTUpdate an existing ClickSend email template by ID, supplying its HTML body and optionally a new name.

Input Parameters

string
required
The HTML content of the email template. This is the body content that will be used when sending emails using this template.
integer
required
Unique identifier of the email template to update. Must be a valid template ID from your account.
string
The new name for the template. If not provided, the existing name will be retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Filename to download post letters history as (e.g., ‘letters_history.csv’). Should include .csv extension for proper file type detection.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_FAX_DELIVERY_RECEIPT_AUTOMATION_DELETETool to delete a fax delivery receipt automation rule. Use when you need to remove an existing fax delivery receipt automation by its rule ID.

Input Parameters

integer
required
Unique identifier of the fax delivery receipt automation rule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_FAX_DELIVERY_RECEIPT_AUTOMATION_GETTool 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.

Input Parameters

integer
required
Unique identifier of the fax delivery receipt automation rule to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_FAX_RECEIPTS_BY_MESSAGE_ID_GETTool 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.

Input Parameters

string
required
Unique identifier for the fax message (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Optional Unix timestamp. Mark all receipts as read that were created before this timestamp. If not provided, all receipts will be marked as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_ACCOUNTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional search query or keyword for filtering results by rule name or action address
integer
Page number for pagination (1-based). Default: 1
integer
Number of records to retrieve per page. Default: 10. Note: API may use its own default page size

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page number to retrieve. Default: 1
integer
Number of items per page (1-100). Note: ClickSend API enforces a minimum of 15 items per page. Values below 15 will be automatically adjusted to 15 by the API. Default: 15

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_AUTOMATIONS_FAX_RECEIPTSTool 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.

Input Parameters

string
Search query or keyword for filtering results
integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_AUTOMATIONS_SMS_INBOUNDTool 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.

Input Parameters

string
Search keyword or query filter to search automation rules
integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_AUTOMATIONS_SMS_RECEIPTSTool 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.

Input Parameters

string
Search query to filter automation rules by rule name, action type, or action address
integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_AUTOMATIONS_VOICE_RECEIPTSTool 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.

Input Parameters

string
Search query or keyword for filtering results
integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_COUNTRIESTool to retrieve all available country codes that ClickSend supports. Use when you need to get a list of countries for international messaging services.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_DELIVERY_ISSUESTool 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.

Input Parameters

integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_EMAIL_MASTER_TEMPLATESTool 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.

Input Parameters

integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_EMAIL_MASTER_TEMPLATES_CATEGORIESTool to retrieve all master email template categories. Use when you need to view available categories of pre-designed email templates. Supports pagination.

Input Parameters

integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_EMAIL_TEMPLATESTool to retrieve all user email templates. Use when you need to view custom email templates created by the user. Supports pagination.

Input Parameters

integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_FAX_RECEIPTSTool 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.

Input Parameters

integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_LISTSTool 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.

Input Parameters

integer
Page number for paginated results. Must be at least 1.
integer
Number of records per page. Must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact list to retrieve. Must be a valid list ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for paginated results. Must be at least 1.
integer
Number of records per page. Must be between 1 and 100.
integer
required
The unique identifier of the contact list to retrieve contacts from. Must be a valid list ID from your account.
integer
Unix timestamp to filter contacts. Returns only contacts updated after this timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact list containing the contact. Must be a valid list ID from your account.
integer
required
The unique identifier of the contact to retrieve. Must be a valid contact ID within the specified list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the contact list to export
string
required
Filename to download the contacts list as (e.g., ‘contacts_export.csv’). Must include .csv extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact list to import contacts into. Must be a valid list ID from your account.
string
required
URL of the file to process. This should be a publicly accessible URL pointing to a CSV or Excel file containing the contacts to import.
array
required
Order of fields in the file. This array specifies how the columns in your file map to contact fields. List the field names in the order they appear in your file columns. Valid field names include: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact list to preview CSV import for. Must be a valid list ID from your account.
string
required
The URL of the CSV file to preview. Must be a publicly accessible URL pointing to a CSV file containing contact data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact list to retrieve import fields for. Must be a valid list ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom query string for filtering results. Format: field:value pairs separated by commas (e.g., ‘from:+61411111111,status_code:201’)
integer
Page number for pagination
integer
Number of records per page
integer
End date for filtering history as Unix timestamp (seconds since epoch)
string
Field to order results by. Format: ‘field:order’ where order is ‘asc’ or ‘desc’ (e.g., ‘date_added:desc’, ‘date:asc’)
integer
Start date for filtering history as Unix timestamp (seconds since epoch)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_MMS_RECEIPTSTool 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.

Input Parameters

integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 10

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_NUMBERSTool 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.

Input Parameters

integer
Page number for pagination. Must be at least 1.
integer
Number of records per page. Must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Must be at least 1.
integer
Number of records per page. Must be at least 1.
Search pattern or query to match against available phone numbers
string
required
Two-letter country code to search for available dedicated numbers (e.g., ‘US’, ‘AU’, ‘GB’)
integer ("0" | "1" | "2")
Search strategy: 0 = starts with, 1 = anywhere, 2 = ends with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Search query string to find matching locations. Can be city name, state, postal code, or address fragment.
integer
Page number for paginated results (starts at 1). If not provided, defaults to page 1.
string
required
Country code or country name to search locations within (e.g., ‘US’, ‘AU’, ‘United States’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_POST_LETTERS_HISTORYRetrieve paginated post letter history from ClickSend, including status, recipient details, pricing, message IDs, file URLs, and return address information when available.

Input Parameters

integer
Page number for pagination
integer
Number of records per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Two-letter ISO country code for which to retrieve pricing (e.g., ‘US’, ‘AU’, ‘GB’)
string
Three-letter ISO currency code to display pricing in (e.g., ‘USD’, ‘AUD’, ‘EUR’). If not specified, defaults to the country’s default currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_REFERRAL_ACCOUNTSTool 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.

Input Parameters

integer
Page number for paginated results. Must be at least 1.
integer
Number of records per page. Must be at least 1. Default is 15.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search query for filtering results. Not case-sensitive. Format: field_name:value
integer
Page number for paginated results. Must be at least 1.
integer
Number of records per page. Must be at least 1. Default is 15.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_SMS_CAMPAIGNSTool 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.

Input Parameters

integer
required
Unique identifier of the SMS campaign to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_SMS_CAMPAIGNS3Retrieve a paginated list of SMS campaigns, with optional search filtering, for campaign management.

Input Parameters

string
Search query in format field_name:value. Searches are not case-sensitive. Filter by fields including: sms_campaign_id, name, user_id, subaccount_id, list_id, from, body, schedule, status, date_added, custom_string, url_to_shorten, unsubscribe_link, or source.
integer
Page number for paginated results. Must be at least 1.
integer
Number of items to return per page. Must be between 15 and 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_SMS_EMAIL_SMS_STRIPPED_STRINGSTool 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.

Input Parameters

integer
Page number for pagination. Must be at least 1.
integer
Number of records per page. Must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom query string for filtering results. Format: field:value pairs separated by commas. Example: ‘from:+61411111111,status_code:201’ or ‘status:Sent’. Searchable fields: status (Queued, Completed, Scheduled, WaitApproval, Failed, Cancelled, CancelledAfterReview, Received, Sent), to (recipient phone number). Searches are case-insensitive.
integer
Page number for pagination. Used to navigate through result pages.
integer
Number of records to return per page.
integer
Filter messages sent up to this date. Unix timestamp format (seconds since epoch).
string ("AND" | "OR")
Logical operator for multiple search filters. Use ‘AND’ to match all filters or ‘OR’ to match any filter.
string
Sort results by field. Format: field:asc or field:desc (e.g., ‘date:desc’, ‘status:asc’).
integer
Filter messages sent from this date onwards. Unix timestamp format (seconds since epoch).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search query to filter inbound SMS messages. Format: field_name:value (e.g., from:+61437085284). Searches are case-insensitive. Available searchable fields: from (sender number), to (recipient number), message_id, body (message text). Multiple criteria can be combined using the operator parameter Malformed queries silently return zero results instead of errors.
integer
Page number for pagination. Default: 1 Increment iteratively with consistent limit to retrieve all records.
integer
Number of records per page. Default: 15
string
Search operator to combine multiple search criteria in the q parameter. Use ‘AND’ to match all criteria (default) or ‘OR’ to match any criteria. Only relevant when multiple field:value pairs are provided in the q parameter
string
Sort order for results. Format: field_name:direction where direction is ‘asc’ (ascending) or ‘desc’ (descending). Default is ‘date:asc’ (oldest first). Use ‘date:desc’ to get newest messages first

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Minimum: 1. Default: 1
integer
Number of records per page. Minimum: 1. Default: 15

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Query parameter for filtering/searching templates. Format: field_name:value. Searches are not case-sensitive.
integer
Page number for pagination. Default: 1
integer
Number of records per page. Default: 15
string
Search operator for query parameter (AND/OR). Default: AND
string
Field name to sort results by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_STATISTICS_SMSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_STATISTICS_VOICETool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_SUBACCOUNTSTool to retrieve all subaccounts from ClickSend account with pagination support. Use when you need to view available subaccounts and their permissions.

Input Parameters

integer
Page number for paginated results. Must be at least 1.
integer
Number of records per page. Must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the subaccount to retrieve. Must be a valid subaccount ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_TIMEZONESTool to retrieve supported list of timezones. Use when you need to get available timezones for scheduling or configuration purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_GET_VOICE_LANGTool to retrieve all available voice languages for text-to-speech. Use when you need to get supported languages and voice options for voice messaging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_LIST_COUNTRIES_GETTool to retrieve the list of countries with IDs for global sending. Use when you need to select countries for international messaging operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Contact ID of the contact to be copied. Must be a valid contact ID within the source list.
integer
required
List ID for list you want to copy the contact to. This is the destination list ID where the contact will be duplicated.
integer
required
List ID for list that contains the contact. This is the source list ID from which the contact will be copied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the contact to transfer. Must be a valid contact ID within the source list.
integer
required
The unique identifier of the destination list where the contact will be transferred. Must be a valid list ID from your account.
integer
required
The unique identifier of the list that currently contains the contact. Must be a valid list ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_MASTER_EMAIL_TEMPLATE_CATEGORY_GETTool 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.

Input Parameters

integer
required
The unique identifier of the master email template category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the master email template to retrieve. Use ‘Get All Master Email Templates’ to get available template IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Default: 1
integer
Number of records to return per page. Default: 15
integer
required
The unique identifier of the template category. Examples: 2 (Alerts/Notifications), 3 (Art), 4 (Birthday), 23 (Blank Template)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The text message content that will be sent in the MMS campaign.
string
required
The sender phone number in international format. This number will appear as the sender of the MMS.
string
required
The name of the campaign for identification and tracking purposes.
integer
required
The ID of the contact list to send the campaign to. This must be an existing list in your ClickSend account.
string
required
The MMS subject line that will be displayed to recipients.
integer
Unix timestamp for scheduling the campaign to be sent at a future date/time. If omitted, the campaign will not be rescheduled.
string
required
URL to the media file to attach (image/video). Must be a publicly accessible URL.
integer
required
The unique identifier of the MMS campaign to update. This is required to specify which campaign to modify.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_MMS_CAMPAIGNS_CANCEL_BY_MMS_CAMPAIGN_ID_PUTTool 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.

Input Parameters

integer
required
The unique identifier of the MMS campaign to cancel. Required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_MMS_CAMPAIGNS_GETTool to retrieve all MMS campaigns with pagination and filtering support. Use when you need to view existing MMS campaigns for management or reporting purposes.

Input Parameters

string
Search query string to filter campaigns by name or other fields
integer
Page number for paginated results. Must be at least 1.
integer
Number of items to return per page. Must be between 15 and 100.
string
Search operator to combine query terms. Use ‘AND’ or ‘OR’.
string
Field name to sort results by (e.g., ‘date_added’, ‘name’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The text content of the MMS message that will be sent to contacts.
string
required
The sender phone number in E.164 international format (must start with + followed by country code and number, e.g., +61411111111).
string
required
The name you want to give this MMS campaign for identification purposes.
integer
required
The ID of the contact list to calculate the price for. Must be a valid list ID from your account that contains at least one contact.
string
required
The subject line for the MMS message.
string
required
Publicly accessible URL of the media file (image/video) to include in the MMS. The API will validate that this URL is reachable before calculating the price.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The text message content that will be sent in the MMS campaign.
string
Your sender ID or phone number. If omitted, uses account default. Refer to ClickSend documentation for valid sender IDs.
string
required
Campaign name for identification and tracking purposes.
integer
required
The ID of the contact list to send the campaign to. This must be an existing list in your ClickSend account.
string
required
Subject line of the MMS campaign.
integer
Unix timestamp for scheduling the campaign to be sent at a future date/time. If omitted, the campaign sends immediately.
string
required
URL pointing to the media file (image/video) to include in the MMS. Must be a publicly accessible URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Custom query string for filtering results. Format: field:value pairs separated by commas (e.g., ‘from:+61411111111,status_code:201’)
integer
Maximum number of records to export. Use to limit the export size
integer
End date for filtering history as Unix timestamp (seconds since epoch)
string
required
Filename to download MMS history as (e.g., ‘mms_history_export.csv’)
string
Field to order results by. Format: ‘field:order’ where order is ‘asc’ or ‘desc’ (e.g., ‘date_added:desc’, ‘date:asc’)
integer
Start date for filtering history as Unix timestamp (seconds since epoch)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_MMS_PRICE_POSTTool 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.

Input Parameters

array
required
Array of message objects to calculate price for. Required - at least one message.
string
required
URL of the media file to send with the MMS (e.g., image URL). Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Optional Unix timestamp. Mark all receipts as read that were created before this timestamp. If not provided, all receipts will be marked as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_POST_NUMBERS_BUYTool to purchase a dedicated phone number from ClickSend. Use when you need to buy a specific number for SMS messaging and other communication services.

Input Parameters

string
required
The type of service for the number (e.g., ‘sms’)
string
Two-character ISO country code (e.g., ‘US’, ‘AU’)
string
required
The phone number to purchase, including country code (e.g., ‘+14155551234’)
object
Registration information for compliance purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the post return address to delete. Must be a valid return address ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the post return address to retrieve. Must be a valid return address ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your city. This is a required field for the city name.
string
required
Your address name. This is a required field that identifies the return address.
string
Your state. This is an optional field for the state, province, or region.
string
required
Your address line 1. This is a required field for the primary street address.
string
Your address line 2. This is an optional field for additional address details like apartment, suite, or floor number.
string
required
Your country. This is a required field for the country code (e.g., ‘AU’ for Australia).
integer
required
The unique identifier of the post return address to update. Must be a valid return address ID from your account.
string
required
Your postal code. This is a required field for the postal or ZIP code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Your base64 encoded file string. The file content should be encoded in base64 format before uploading.
string
Conversion type for the uploaded file. Valid values: ‘fax’, ‘mms’, ‘postcard’, ‘post’, ‘csv’. Converts the file to the appropriate format for the specified service. If not specified, the file is uploaded without conversion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The username or email address of the ClickSend account that needs password recovery. This can be either an email format (e.g., ‘user@example.com’) or a simple alphanumeric username (e.g., ‘myusername’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Email address registered to the account. Either email or phone_number must be provided.
string
Phone number registered to the account in E.164 format or local format. Either email or phone_number must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_RECHARGE_PACKAGES_GETRetrieve available ClickSend recharge packages, optionally filtered by country, including package pricing and SMS and MMS pricing and quantities.

Input Parameters

string
Country code to filter packages by specific country (e.g., ‘US’, ‘AU’, ‘GB’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 issue

Input Parameters

integer
required
ID of the recharge package to purchase. Must be a positive integer. Use the ‘Get Recharge Packages’ action first to retrieve available package IDs and their pricing details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_RECHARGE_TRANSACTIONS_GETTool to retrieve all recharge transactions from ClickSend account with pagination support. Use when you need to view transaction history including amounts, currencies, and dates.

Input Parameters

integer
Page number for pagination. Must be at least 1.
integer
Number of records per page. Must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_RECHARGE_TXNS_BY_TXN_ID_GETTool 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.

Input Parameters

string
required
The unique identifier of the recharge transaction to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Search query string to filter contact lists and contacts by name. Search is case-insensitive and matches partial names.
integer
Page number for paginated results. Must be at least 1.
integer
Number of records per page. Must be at least 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the email address to send verification to. This ID is returned when creating an email address via the ClickSend API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_SMS_CAMPAIGNS_CANCEL_BY_SMS_CAMPAIGN_ID_PUTTool 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.

Input Parameters

integer
required
The unique identifier of the SMS campaign to cancel. Required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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 effect

Input Parameters

string
Optional filter to cancel only scheduled messages with this specific custom_string value. If not provided, cancels all scheduled SMS messages. Use this when you want to cancel a specific batch of scheduled messages that were sent with the same custom_string identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_SMS_DELIVERY_RECEIPT_AUTOMATION_DELETETool to delete an SMS delivery receipt automation rule. Use when you need to remove an existing delivery receipt automation by its rule ID.

Input Parameters

integer
required
Unique identifier of the SMS delivery receipt automation rule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_SMS_DELIVERY_RECEIPT_AUTOMATION_GETTool 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.

Input Parameters

integer
required
Unique identifier of the SMS delivery receipt automation rule to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the stripped string rule to delete. Must be a valid rule ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the stripped string rule to retrieve. Must be a valid rule ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the stripped string rule to update. Must be a valid rule ID from your account.
string
required
The new text string/pattern to be stripped from emails before SMS conversion. This will replace the existing stripped string for this rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Filename to download SMS history as (e.g., ‘sms_history_export.csv’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_SMS_INBOUND_AUTOMATION_GETTool 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.

Input Parameters

integer
required
Unique identifier of the inbound SMS automation rule to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
integer
required
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
required
Name of the automation rule to identify it. Helps organize and manage multiple rules.
string
Webhook format type. Valid values: ‘post’, ‘get’, or ‘json’. Defaults to ‘post’ if not specified.
string
required
Target destination for the specified action. For EMAIL_FIXED provide email address, for URL provide webhook URL, for contact lists provide list ID.
integer
required
Unique identifier of the inbound SMS automation rule to update
string
required
The dedicated phone number to apply this rule to. Use ’*’ to apply the rule to all numbers.
string
Text pattern to match against incoming messages. Can be null for message_search_type=0 (any message).
integer
required
Message matching logic. 0 = Any message, 1 = starts with, 2 = contains, 3 = does not contain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The identifier for the inbound SMS to mark as read. This is the message_id of the inbound message sent by the recipient (not the original_message_id of the outbound message).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Unix timestamp (in seconds since epoch). If provided, only inbound SMS received before this timestamp will be marked as read. If omitted, ALL unread inbound messages will be marked as read. For incremental polling, use the ‘timestamp’ value from the last message in your previous GET /sms/inbound response to avoid marking future messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_SMS_PRICE_POSTTool 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

array
required
Array of SMS message objects to calculate price for. Required - at least one message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_SMS_RECEIPTS_BY_MESSAGE_ID_GETTool 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

string
required
Unique identifier for the SMS message (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Unix timestamp. Receipts received before this time will be marked as read. If not provided, all receipts will be marked as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_SMS_TEMPLATES_BY_TEMPLATE_ID_DELETETool to delete an SMS template by its template ID. Use when you need to remove an existing SMS template from your account.

Input Parameters

integer
required
Unique identifier of the SMS template to delete. Must be a valid template ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The text content of the SMS template. This is the body content that will be used when sending SMS messages using this template. If not provided, the existing body will be retained.
integer
required
Unique identifier of the SMS template to update. Must be a valid template ID from your account.
string
The new name for the template. If not provided, the existing name will be retained.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the email address to delete. Must be a valid email address ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the allowed email address to retrieve. Use the ‘Get Allowed Email Addresses’ action to list available email addresses and obtain their IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the subaccount to regenerate API key for. Must be a valid subaccount ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_UPDATE_ACCOUNTTool 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.

Input Parameters

string
User’s country code (ISO 3166-1 alpha-2 format, e.g., ‘US’, ‘AU’, ‘GB’)
string
User’s phone number in E.164 format (e.g., ‘+16068249028’)
string
User’s last name to update
string
User’s first name to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Determines the response type when rule matches. Supported options: AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT. Optional - only specify if you want to update the action type.
integer
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
Name to identify the automation rule. Helps organize and manage multiple rules. Optional - only specify if you want to update the rule name.
integer
Specifies match criteria for the delivery receipt. 0 = match all reports. Nullable integer value for matching criteria. Optional - only specify if you want to update the match type.
string
Designates the target destination or endpoint for the triggered action (e.g., URL endpoint or email address).
integer
required
The unique identifier of the receipt rule to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The action to perform when a fax is received. Supported actions: 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.
integer
required
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
required
Name of the automation rule to identify it. Helps organize and manage multiple rules.
string
required
The destination address for the action. For EMAIL_FIXED action, provide an email address. For URL action, provide a webhook URL. For SMS, provide phone number.
integer
required
The unique identifier of the inbound rule to update
string
required
The dedicated fax number to apply this rule to. Use ’*’ to apply the rule to all fax numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Determines the response type when rule matches. Supported options: 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.
integer
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
Name to identify the automation rule. Helps organize and manage multiple rules.
integer
Specifies match criteria for the delivery receipt. 0 = match all reports.
string
Designates the target destination or endpoint for the triggered action (e.g., URL endpoint or email address).
integer
required
The unique identifier of the receipt rule to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Determines the response type 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, or NONE.
integer
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
Name to identify the automation rule. Helps organize and manage multiple rules.
integer
Specifies match criteria for the delivery receipt. Valid values: 0 (match all reports), 1, or 2 (specific match types).
string
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL for URL action).
integer
required
The unique identifier of the receipt rule to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_UPDATE_LISTSTool to update the name of a specific contact list in your ClickSend account. Use when you need to rename an existing contact list.

Input Parameters

integer
required
The unique identifier of the contact list to update. Must be a valid list ID from your account.
string
required
The new name for the contact list. This will replace the existing list name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Contact’s email address. At least one contact method (phone_number, email, or fax_number) must be provided.
integer
required
The unique identifier of the contact list containing the contact. Must be a valid list ID from your account.
string
Custom field 1 for additional contact information
string
Custom field 2 for additional contact information
string
Custom field 3 for additional contact information
string
Custom field 4 for additional contact information
string
Contact’s last name
integer
required
The unique identifier of the contact to update. Must be a valid contact ID within the specified list.
string
Contact’s fax number. At least one contact method (phone_number, email, or fax_number) must be provided.
string
Contact’s first name
string
City in contact’s address
string
Contact’s phone number in E.164 format (e.g., ‘+14155552999’). At least one contact method (phone_number, email, or fax_number) must be provided.
string
State or province in contact’s address
string
First line of contact’s street address
string
Second line of contact’s address (apartment, suite, etc.)
string
Country code in ISO 3166 format (2-letter country code) for contact’s address
string
Contact’s organization or company name
string
Postal or ZIP code in contact’s address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_UPDATE_RECHARGE_CREDIT_CARDRetrieve stored credit card information for account recharge. The response may include a masked card number, expiry date and cardholder name; a 404 response is returned when the API reports no stored card.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Two-letter ISO country code for the reseller’s location (e.g., ‘US’, ‘AU’, ‘GB’)
string
IANA timezone identifier for scheduling and timestamps (e.g., ‘Australia/Melbourne’, ‘America/New_York’)
string
Reseller’s contact email address
string
Reseller’s contact phone number in international format
string
Display name for the reseller account or business
integer
Whether to automatically recharge account when credits fall below threshold: 1 to enable, 0 to disable
string
Reseller’s last name
string
Reseller’s first name
string
Credit balance threshold that triggers auto-recharge (decimal string, e.g., ‘50.00’)
string
Default country code for SMS recipients when not specified (e.g., ‘US’, ‘AU’, ‘GB’)
integer
Whether to allow Unicode characters in SMS messages: 1 to enable, 0 to restrict to GSM 7-bit characters
string
Amount in account currency to add when auto-recharge triggers (decimal string, e.g., ‘100.00’)
string
Email address for billing notifications and invoices
integer
Whether sender ID is locked and cannot be changed per message: 1 to lock sender ID, 0 to allow per-message customization
string
Mobile phone number for billing alerts in international format
integer
Whether to use email subject line as SMS message body when sending via email-to-SMS: 1 to enable, 0 to use email body
integer
Maximum character limit per SMS message (typical values: 160 for single SMS, 320 for concatenated)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The message content for your campaign. This is the SMS text that will be sent to contacts.
string
Your sender ID. This is the sender name or number that recipients will see. See ClickSend sender ID documentation for requirements.
string
required
The title assigned to your campaign. This will replace the existing campaign name.
integer
required
Identifier for your contact list. The contact list that the campaign should use.
integer
Unix timestamp for when to send the campaign. IMPORTANT: If omitted or set to 0, the campaign sends immediately and cannot be updated again. To keep a campaign editable, set this to a future timestamp. Maximum 4 months in advance.
string
A URL to compress and include in the message. Insert placeholder text in body where the shortened URL should appear.
integer
required
The unique identifier of the SMS campaign to update. Must be a valid campaign ID from your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
New email address for the subaccount. This is required for account notifications and communications.
string
New password for the subaccount. Must be a strong password for security. When provided, old_password is also required.
string
required
Last name of the subaccount user. Required field for personalization.
string
required
First name of the subaccount user. Required field for personalization.
integer
Access permission for users management. Use 0 for no access, 1 for access granted. Defaults to 1.
string
required
New API username for the subaccount. This will be used for API authentication.
string
Current password for the subaccount. Required only when updating the password field.
string
required
Phone number in E.164 format (e.g., ‘+61411111111’). Required contact number for the subaccount.
integer
required
The unique identifier of the subaccount to update. Must be a valid subaccount ID from your account.
integer
Access permission for billing features. Use 0 for no access, 1 for access granted. Defaults to 1.
integer
Access permission for contacts management. Use 0 for no access, 1 for access granted. Defaults to 0.
integer
Access permission for settings. Use 0 for no access, 1 for access granted. Defaults to 1.
integer
Access permission for reporting features. Use 0 for no access, 1 for access granted. Defaults to 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_USER_COUNTRIES_AGREE_POSTAgree to the rules and regulations for selected Global Sending countries. The response may include country details, regulatory requirements and registration status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_USER_COUNTRIES_GETTool to retrieve the list of selected countries for Global Sending. Use when you need to view which countries are currently enabled for international messaging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Array of country IDs to enable for SMS/MMS sending. Country IDs can be obtained from GET /country-list endpoint. To remove/unselect a country, exclude its ID from this array.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The activation/verification token that was sent to the email address. This token is delivered to the email address after creating it and requesting a verification email via the Send Email Verification Token action.
integer
required
The unique identifier for the allowed email address that needs verification. This ID is returned when creating an email address via the Create Allowed Email Address action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_VERIFY_FORGOT_PASSWORD_VERIFYTool 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.

Input Parameters

string
required
The new password to be set for the account
integer
required
The identifier for the subaccount that needs password reset
string
required
The verification token/code received via email from the forgot password request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_VOICE_CANCEL_ALL_PUTTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_DELETETool to delete a voice delivery receipt automation rule. Use when you need to remove a specific voice receipt automation rule.

Input Parameters

integer
required
The unique identifier of the voice delivery receipt automation rule to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_GETTool 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.

Input Parameters

integer
required
Unique identifier of the voice delivery receipt automation rule to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Response action to perform when rule matches (e.g., ‘URL’ for webhook, ‘EMAIL_FIXED’ for email notification).
integer
required
Controls activation status of the rule. 0 = disabled, 1 = enabled.
string
required
Name to identify the automation rule. Helps organize and manage multiple rules.
integer
required
Determines which delivery statuses trigger the rule. Valid values: 0 = All delivery reports, 1-2 = Specific status filters.
string
required
Target destination for the action - URL endpoint or email address where delivery receipts will be sent.
integer
required
Unique identifier of the voice delivery receipt automation rule to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Filename for the downloaded voice history export. Must be a valid filename with .csv extension. The file will contain all voice message history from your ClickSend account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

number
Optional Unix timestamp. Mark all voice delivery receipts as read before this timestamp. If not provided, all voice receipts will be marked as read.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not