# ClickSend

ClickSend is a cloud-based SMS and email marketing platform that enables businesses to send and receive SMS messages, manage contacts, and track campaign performance.

- **Category:** phone & sms
- **Auth:** BASIC
- **Composio Managed App Available?** N/A
- **Tools:** 168
- **Triggers:** 0
- **Slug:** `CLICKSEND`
- **Version:** 20260316_00

## Tools

### Get Account Usage by Subaccount

**Slug:** `CLICKSEND_ACCOUNT_USEAGE_BY_SUBACCOUNT_GET`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Year to filter usage by in four-digit format (yyyy) |
| `month` | integer | Yes | Month to filter usage by in numeric format (1-12) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Account Activation Token

**Slug:** `CLICKSEND_ACCOUNT_VERIFY_SEND_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Verification method type. Required for successful verification. |
| `country` | string | No | Country designation (e.g., 'US'). Required for successful verification. |
| `user_phone` | string | No | Your phone number in E.164 format (e.g., '+13523944199'). Required for successful verification. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify New Account

**Slug:** `CLICKSEND_ACCOUNT_VERIFY_VERIFY_BY_ACTIVATION_TOKEN_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activation_token` | integer | Yes | Activation token for account verification (integer format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Post Letter Price

**Slug:** `CLICKSEND_CALCULATE_POST_LETTERS_PRICE`

Calculate 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `colour` | integer | No | Whether letter is printed in colour. 0 = black and white, 1 = colour. Default is 0. |
| `duplex` | integer | No | Whether letter is printed double-sided. 0 = single-sided, 1 = double-sided. Default is 0. |
| `source` | string | No | Source identifier for tracking purposes. Can be any string value. |
| `file_url` | string | Yes | 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. |
| `recipients` | array | Yes | Array of recipient objects. Each recipient represents a person who will receive a copy of the letter. |
| `priority_post` | integer | No | Whether the letter is priority post. 0 = standard post, 1 = priority post. Default is 0. |
| `template_used` | integer | No | Whether using a ClickSend template. 0 = not using template, 1 = using template. Default is 0. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate SMS Campaign Price

**Slug:** `CLICKSEND_CALCULATE_SMS_CAMPAIGNS_PRICE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Your campaign message content. Use placeholders like (First Name) for personalization. Required field. |
| `from` | string | No | Sender identifier (phone number or alphanumeric sender ID). See ClickSend docs for supported formats. Optional field. |
| `name` | string | Yes | Your campaign name for identification. Required field. |
| `list_id` | integer | Yes | Your contact list ID containing the campaign recipients. Required field. |
| `schedule` | integer | No | Unix timestamp for scheduling the campaign. Defaults to 0 for immediate sending. Optional field. |
| `url_to_shorten` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Delivery Receipt Automation

**Slug:** `CLICKSEND_CREATE_AUTOMATIONS_EMAIL_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | Yes | 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. |
| `enabled` | integer | Yes | Controls activation status of the rule. Use 1 to enable the rule immediately, or 0 to create it in a disabled state. |
| `rule_name` | string | Yes | Name to identify the automation rule. Helps organize and manage multiple rules. |
| `match_type` | integer | Yes | Specifies match criteria for the delivery receipt. Use 0 to match all email delivery reports. |
| `action_address` | string | Yes | The URL endpoint where delivery receipt data should be posted. Must be a valid HTTP or HTTPS URL. Required when action is 'URL'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Inbound Fax Automation

**Slug:** `CLICKSEND_CREATE_AUTOMATIONS_FAX_INBOUND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | Yes | 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. |
| `enabled` | integer | Yes | Controls activation status of the rule. 0 = disabled, 1 = enabled. |
| `rule_name` | string | Yes | Name of the automation rule to identify it. Helps organize and manage multiple rules. |
| `action_address` | string | Yes | 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. |
| `dedicated_number` | string | Yes | The dedicated fax number to apply this rule to. Use '*' to apply the rule to all fax numbers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Fax Delivery Receipt Automation

**Slug:** `CLICKSEND_CREATE_AUTOMATIONS_FAX_RECEIPTS`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | Yes | 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. |
| `enabled` | integer | No | Rule activation status. 1 = rule is active and will trigger, 0 = rule is disabled. Default: 1 |
| `rule_name` | string | Yes | Descriptive name for the automation rule. Used to identify and organize rules in your account. |
| `match_type` | integer | No | Match criteria type for fax receipts. Currently only 0 (match all fax delivery receipts) is supported. Default: 0 |
| `action_address` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Inbound SMS Automation

**Slug:** `CLICKSEND_CREATE_AUTOMATIONS_SMS_INBOUND`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SMS Delivery Receipt Automation

**Slug:** `CLICKSEND_CREATE_AUTOMATIONS_SMS_RECEIPTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Voice Delivery Receipt Automation

**Slug:** `CLICKSEND_CREATE_AUTOMATIONS_VOICE_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | Yes | Response action to perform when rule matches (e.g., 'URL' for webhook, 'EMAIL_FIXED' for email notification). |
| `enabled` | integer | Yes | Binary flag to activate/deactivate the rule. 1 = enabled, 0 = disabled. |
| `rule_name` | string | Yes | Name identifying the automation rule. Helps organize and manage multiple rules. |
| `match_type` | integer | Yes | 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. |
| `action_address` | string | Yes | Target destination for the action - URL endpoint or email address where delivery receipts will be sent. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Delivery Issue

**Slug:** `CLICKSEND_CREATE_DELIVERY_ISSUES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | The type of message. Required. Must be one of: SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST. |
| `message_id` | string | Yes | 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. |
| `description` | string | Yes | The description of the delivery issue. Required field explaining what went wrong with the message delivery. |
| `email_address` | string | Yes | The user's email address for contact regarding this delivery issue. Required field. |
| `client_comments` | string | No | Optional comments from the user providing additional context about the delivery issue. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Allowed Email Address

**Slug:** `CLICKSEND_CREATE_EMAIL_ADDRESSES2`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_address` | string | Yes | Email address to be allowed for sending transactional emails. This address will need to be verified before use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Allowed Email Addresses

**Slug:** `CLICKSEND_CREATE_EMAIL_ADDRESSES6`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1. Minimum value is 1. |
| `limit` | integer | No | Number of records per page. Default: 15. Minimum value is 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email Template from Master

**Slug:** `CLICKSEND_CREATE_EMAIL_TEMPLATES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_name` | string | Yes | The intended name for the new email template. This is a user-defined name that will identify your custom template. |
| `template_id_master` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Fax Delivery Receipt Webhook

**Slug:** `CLICKSEND_CREATE_FAX_RECEIPTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact List

**Slug:** `CLICKSEND_CREATE_LISTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_name` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact in List

**Slug:** `CLICKSEND_CREATE_LISTS_CONTACTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send MMS Messages

**Slug:** `CLICKSEND_CREATE_MMS_SEND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | Array of MMS message objects to send. Required - at least one message, maximum 1000 messages per API call. |
| `media_file` | string | Yes | Publicly accessible URL to the media file/image to be sent with the MMS. Must be a valid URL. Maximum file size: 250 kB (some older devices limited to 30 kB). Required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Direct Mail Campaign

**Slug:** `CLICKSEND_CREATE_POST_DIRECT_MAIL_CAMPAIGNS_SEND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Campaign name for identification and tracking purposes. |
| `size` | string | Yes | 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. |
| `areas` | array | Yes | 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. |
| `file_urls` | array | Yes | List of publicly accessible URLs pointing to PDF files for the direct mail content. Must be valid URLs to PDF files. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Detect Address from PDF or String

**Slug:** `CLICKSEND_CREATE_POST_LETTERS_DETECT_ADDRESS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address` | string | No | 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. |
| `content` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Post Letter

**Slug:** `CLICKSEND_CREATE_POST_LETTERS_SEND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `colour` | integer | No | Whether letter is printed in colour. 0 = black and white, 1 = colour. Default is 0. |
| `duplex` | integer | No | Whether letter is printed double-sided. 0 = single-sided, 1 = double-sided. Default is 0. |
| `source` | string | No | Source identifier for tracking purposes. Can be any string value. |
| `file_url` | string | Yes | 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. |
| `recipients` | array | Yes | Array of recipient objects. Each recipient represents a person who will receive a copy of the letter. |
| `priority_post` | integer | No | Whether the letter is priority post. 0 = standard post, 1 = priority post. Default is 0. |
| `template_used` | integer | No | Whether using a ClickSend template. 0 = not using template, 1 = using template. Default is 0. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Post Return Address

**Slug:** `CLICKSEND_CREATE_POST_RETURN_ADDRESSES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_city` | string | Yes | City name for the return address. This is a required field. |
| `address_name` | string | Yes | Name or label for the return address. This will be used to identify the address in your account. |
| `address_state` | string | No | State, province, or region for the return address. This is an optional field but recommended. |
| `address_line_1` | string | Yes | First line of the street address. This is a required field for the return address. |
| `address_line_2` | string | No | Second line of the street address (apartment, suite, building, etc.). This is an optional field. |
| `address_country` | string | Yes | Country code for the return address (e.g., 'US', 'AU', 'GB'). This is a required field. Use ISO country codes. |
| `address_postal_code` | string | Yes | Postal code or ZIP code for the return address. This is a required field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Post Return Addresses

**Slug:** `CLICKSEND_CREATE_POST_RETURN_ADDRESSES3`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Specifies which page of results to retrieve. Must be at least 1. |
| `limit` | integer | No | Number of records to return per page. Must be between 15 and 100. Default is 15. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create and Send SMS Campaign

**Slug:** `CLICKSEND_CREATE_SMS_CAMPAIGNS_SEND`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email-to-SMS Allowed Address

**Slug:** `CLICKSEND_CREATE_SMS_EMAIL_SMS2`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Email-to-SMS Allowed Address

**Slug:** `CLICKSEND_CREATE_SMS_EMAIL_SMS3`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_address_id` | integer | Yes | The unique identifier of the allowed email address to retrieve. Must be a valid email address ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email-to-SMS Allowed Address

**Slug:** `CLICKSEND_CREATE_SMS_EMAIL_SMS4`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | string | Yes | The SMS sender number or identifier that will be used when messages are sent from this email address. |
| `lang` | string | No | Language code for text-to-speech conversion (if applicable). Common values include 'en-us', 'en-gb', etc. |
| `voice` | string | No | Voice type for text-to-speech conversion (if applicable). Common values include 'female', 'male'. |
| `email_address` | string | Yes | The email address to update. Must be a valid email address. |
| `email_address_id` | integer | Yes | The unique identifier of the allowed email address to update. Must be a valid email address ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SMS Email-to-SMS Allowed Address

**Slug:** `CLICKSEND_CREATE_SMS_EMAIL_SMS5`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_address_id` | integer | Yes | The unique identifier of the email address to delete from allowed email addresses. Must be a valid email address ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Email to SMS Stripped String Rule

**Slug:** `CLICKSEND_CREATE_SMS_EMAIL_SMS_STRIPPED_STRINGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `strip_string` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Test Inbound SMS

**Slug:** `CLICKSEND_CREATE_SMS_INBOUND`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The webhook URL where the test inbound SMS will be sent. Must be a valid HTTP/HTTPS URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Test SMS Delivery Receipt

**Slug:** `CLICKSEND_CREATE_SMS_RECEIPTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send SMS Messages

**Slug:** `CLICKSEND_CREATE_SMS_SEND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SMS Template

**Slug:** `CLICKSEND_CREATE_SMS_TEMPLATES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The content/message text of the SMS template. This is the actual SMS message content that will be sent when using this template. |
| `template_name` | string | Yes | The name of the SMS template. This is a user-defined name that will identify your custom template. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Subaccount

**Slug:** `CLICKSEND_CREATE_SUBACCOUNTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Inbound SMS Automation

**Slug:** `CLICKSEND_DELETE_AUTOMATIONS_SMS_INBOUND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbound_rule_id` | integer | Yes | Unique identifier of the inbound SMS automation rule to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact List

**Slug:** `CLICKSEND_DELETE_LISTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list to delete. Must be a valid list ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact from List

**Slug:** `CLICKSEND_DELETE_LISTS_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list from which the contact will be deleted. Must be a valid list ID from your account. |
| `contact_id` | integer | Yes | The unique identifier of the contact to delete from the list. Must be a valid contact ID within the specified list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Opted Out Contacts from List

**Slug:** `CLICKSEND_DELETE_LISTS_REMOVE_OPTED_OUT_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list from which opted out contacts will be removed. Must be a valid list ID from your account. |
| `opt_out_list_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Scheduled SMS

**Slug:** `CLICKSEND_DELETE_SMS_CANCEL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | Unique identifier for the scheduled SMS message to cancel (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Subaccount

**Slug:** `CLICKSEND_DELETE_SUBACCOUNTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subaccount_id` | integer | Yes | The unique identifier of the subaccount to delete. Must be a valid subaccount ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Campaign

**Slug:** `CLICKSEND_EMAIL_CAMPAIGN_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_campaign_id` | integer | Yes | Unique identifier of the email campaign to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Delivery Receipt Automation

**Slug:** `CLICKSEND_EMAIL_DELIVERY_RECEIPT_AUTOMATION_DELETE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | Unique identifier of the email delivery receipt automation rule to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Delivery Receipt Automation

**Slug:** `CLICKSEND_EMAIL_DELIVERY_RECEIPT_AUTOMATION_GET`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email Template

**Slug:** `CLICKSEND_EMAIL_TEMPLATE_DELETE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | Yes | Unique identifier of the email template to delete. Must be a valid template ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Template

**Slug:** `CLICKSEND_EMAIL_TEMPLATE_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | Yes | Unique identifier of the email template to retrieve. Must be a valid template ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Template

**Slug:** `CLICKSEND_EMAIL_TEMPLATE_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The HTML content of the email template. This is the body content that will be used when sending emails using this template. |
| `template_id` | integer | Yes | Unique identifier of the email template to update. Must be a valid template ID from your account. |
| `template_name` | string | No | The new name for the template. If not provided, the existing name will be retained. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Post Letters History

**Slug:** `CLICKSEND_EXPORT_POST_LETTERS_HISTORY_EXPORT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | Filename to download post letters history as (e.g., 'letters_history.csv'). Should include .csv extension for proper file type detection. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Fax Delivery Receipt Automation

**Slug:** `CLICKSEND_FAX_DELIVERY_RECEIPT_AUTOMATION_DELETE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | Unique identifier of the fax delivery receipt automation rule to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fax Delivery Receipt Automation

**Slug:** `CLICKSEND_FAX_DELIVERY_RECEIPT_AUTOMATION_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | Unique identifier of the fax delivery receipt automation rule to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fax Receipt by Message ID

**Slug:** `CLICKSEND_FAX_RECEIPTS_BY_MESSAGE_ID_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | Unique identifier for the fax message (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Fax Receipts as Read

**Slug:** `CLICKSEND_FAX_RECEIPTS_READ_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_before` | number | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Information

**Slug:** `CLICKSEND_GET_ACCOUNT`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Email Delivery Receipt Automations

**Slug:** `CLICKSEND_GET_AUTOMATIONS_EMAIL_RECEIPTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Inbound Fax Automations

**Slug:** `CLICKSEND_GET_AUTOMATIONS_FAX_INBOUND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to retrieve. Default: 1 |
| `limit` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Fax Delivery Receipt Automations

**Slug:** `CLICKSEND_GET_AUTOMATIONS_FAX_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query or keyword for filtering results |
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Inbound SMS Automations

**Slug:** `CLICKSEND_GET_AUTOMATIONS_SMS_INBOUND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search keyword or query filter to search automation rules |
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All SMS Delivery Receipt Automations

**Slug:** `CLICKSEND_GET_AUTOMATIONS_SMS_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query to filter automation rules by rule name, action type, or action address |
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Voice Delivery Receipt Automations

**Slug:** `CLICKSEND_GET_AUTOMATIONS_VOICE_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query or keyword for filtering results |
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Suggestions

**Slug:** `CLICKSEND_GET_CONTACT_SUGGESTIONS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Countries

**Slug:** `CLICKSEND_GET_COUNTRIES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Delivery Issues

**Slug:** `CLICKSEND_GET_DELIVERY_ISSUES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Master Email Templates

**Slug:** `CLICKSEND_GET_EMAIL_MASTER_TEMPLATES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Master Email Template Categories

**Slug:** `CLICKSEND_GET_EMAIL_MASTER_TEMPLATES_CATEGORIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All User Email Templates

**Slug:** `CLICKSEND_GET_EMAIL_TEMPLATES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Fax Delivery Receipts

**Slug:** `CLICKSEND_GET_FAX_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Contact Lists

**Slug:** `CLICKSEND_GET_LISTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Specific Contact List

**Slug:** `CLICKSEND_GET_LISTS2`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list to retrieve. Must be a valid list ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Contacts in List

**Slug:** `CLICKSEND_GET_LISTS_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be between 1 and 100. |
| `list_id` | integer | Yes | The unique identifier of the contact list to retrieve contacts from. Must be a valid list ID from your account. |
| `updated_after` | integer | No | Unix timestamp to filter contacts. Returns only contacts updated after this timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Specific Contact

**Slug:** `CLICKSEND_GET_LISTS_CONTACTS2`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list containing the contact. Must be a valid list ID from your account. |
| `contact_id` | integer | Yes | The unique identifier of the contact to retrieve. Must be a valid contact ID within the specified list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Contacts List

**Slug:** `CLICKSEND_GET_LISTS_EXPORT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Contacts to List

**Slug:** `CLICKSEND_GET_LISTS_IMPORT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list to import contacts into. Must be a valid list ID from your account. |
| `file_url` | string | Yes | 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. |
| `field_order` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Preview CSV Import for Contact List

**Slug:** `CLICKSEND_GET_LISTS_IMPORT_CSV_PREVIEW`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list to preview CSV import for. Must be a valid list ID from your account. |
| `file_url` | string | Yes | The URL of the CSV file to preview. Must be a publicly accessible URL pointing to a CSV file containing contact data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get List Import Fields

**Slug:** `CLICKSEND_GET_LISTS_IMPORT_FIELDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list to retrieve import fields for. Must be a valid list ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export MMS History

**Slug:** `CLICKSEND_GET_MMS_HISTORY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Custom query string for filtering results. Format: field:value pairs separated by commas (e.g., 'from:+61411111111,status_code:201') |
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of records per page |
| `date_to` | integer | No | End date for filtering history as Unix timestamp (seconds since epoch) |
| `order_by` | string | No | Field to order results by. Format: 'field:order' where order is 'asc' or 'desc' (e.g., 'date_added:desc', 'date:asc') |
| `date_from` | integer | No | Start date for filtering history as Unix timestamp (seconds since epoch) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get MMS Delivery Receipts

**Slug:** `CLICKSEND_GET_MMS_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records per page. Default: 10 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dedicated Numbers

**Slug:** `CLICKSEND_GET_NUMBERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Dedicated Numbers by Country

**Slug:** `CLICKSEND_GET_NUMBERS_SEARCH`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Direct Mail Locations

**Slug:** `CLICKSEND_GET_POST_DIRECT_MAIL_LOCATIONS_SEARCH`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | Yes | Search query string to find matching locations. Can be city name, state, postal code, or address fragment. |
| `country` | string | Yes | Country code or country name to search locations within (e.g., 'US', 'AU', 'United States') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Post Letters History

**Slug:** `CLICKSEND_GET_POST_LETTERS_HISTORY`

Retrieves the history of all post letters sent through ClickSend with pagination support. Use this tool to view past post letters, check their status (e.g., WaitApproval, Scheduled, delivered), review recipient details, pricing information, and delivery timestamps. Returns comprehensive details including message IDs, addresses, file URLs, and return address information for each letter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination |
| `limit` | integer | No | Number of records per page |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country Pricing

**Slug:** `CLICKSEND_GET_PRICING`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | Yes | Two-letter ISO country code for which to retrieve pricing (e.g., 'US', 'AU', 'GB') |
| `currency` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Referral Accounts

**Slug:** `CLICKSEND_GET_REFERRAL_ACCOUNTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. Default is 15. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reseller Settings

**Slug:** `CLICKSEND_GET_RESELLER`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Reseller Accounts

**Slug:** `CLICKSEND_GET_RESELLER_ACCOUNTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query for filtering results. Not case-sensitive. Format: field_name:value |
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. Default is 15. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign

**Slug:** `CLICKSEND_GET_SMS_CAMPAIGNS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sms_campaign_id` | integer | Yes | Unique identifier of the SMS campaign to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaigns List

**Slug:** `CLICKSEND_GET_SMS_CAMPAIGNS3`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | 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. |
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of items to return per page. Must be between 15 and 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email to SMS Stripped String Rules List

**Slug:** `CLICKSEND_GET_SMS_EMAIL_SMS_STRIPPED_STRINGS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS History

**Slug:** `CLICKSEND_GET_SMS_HISTORY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | 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. |
| `page` | integer | No | Page number for pagination. Used to navigate through result pages. |
| `limit` | integer | No | Number of records to return per page. |
| `date_to` | integer | No | Filter messages sent up to this date. Unix timestamp format (seconds since epoch). |
| `operator` | string ("AND" | "OR") | No | Logical operator for multiple search filters. Use 'AND' to match all filters or 'OR' to match any filter. |
| `order_by` | string | No | Sort results by field. Format: field:asc or field:desc (e.g., 'date:desc', 'status:asc'). |
| `date_from` | integer | No | Filter messages sent from this date onwards. Unix timestamp format (seconds since epoch). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inbound SMS Messages

**Slug:** `CLICKSEND_GET_SMS_INBOUND`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | 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. |
| `page` | integer | No | Page number for pagination. Default: 1 Increment iteratively with consistent limit to retrieve all records. |
| `limit` | integer | No | Number of records per page. Default: 15 |
| `operator` | string | No | 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 |
| `order_by` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Delivery Receipts

**Slug:** `CLICKSEND_GET_SMS_RECEIPTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All SMS Templates

**Slug:** `CLICKSEND_GET_SMS_TEMPLATES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Statistics

**Slug:** `CLICKSEND_GET_STATISTICS_SMS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Voice Statistics

**Slug:** `CLICKSEND_GET_STATISTICS_VOICE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Subaccounts

**Slug:** `CLICKSEND_GET_SUBACCOUNTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Specific Subaccount

**Slug:** `CLICKSEND_GET_SUBACCOUNTS2`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subaccount_id` | integer | Yes | The unique identifier of the subaccount to retrieve. Must be a valid subaccount ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Supported Timezones

**Slug:** `CLICKSEND_GET_TIMEZONES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Voice Languages

**Slug:** `CLICKSEND_GET_VOICE_LANG`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Countries

**Slug:** `CLICKSEND_LIST_COUNTRIES_GET`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Copy Contact to Another List

**Slug:** `CLICKSEND_LISTS_COPY_CONTACT_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | Contact ID of the contact to be copied. Must be a valid contact ID within the source list. |
| `to_list_id` | integer | Yes | List ID for list you want to copy the contact to. This is the destination list ID where the contact will be duplicated. |
| `from_list_id` | integer | Yes | List ID for list that contains the contact. This is the source list ID from which the contact will be copied. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Transfer Contact Between Lists

**Slug:** `CLICKSEND_LISTS_TRANSFER_CONTACT_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | The unique identifier of the contact to transfer. Must be a valid contact ID within the source list. |
| `to_list_id` | integer | Yes | The unique identifier of the destination list where the contact will be transferred. Must be a valid list ID from your account. |
| `from_list_id` | integer | Yes | The unique identifier of the list that currently contains the contact. Must be a valid list ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Master Email Template Category

**Slug:** `CLICKSEND_MASTER_EMAIL_TEMPLATE_CATEGORY_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | The unique identifier of the master email template category to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Master Email Template

**Slug:** `CLICKSEND_MASTER_EMAIL_TEMPLATE_GET`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | Yes | The unique identifier of the master email template to retrieve. Use 'Get All Master Email Templates' to get available template IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Master Email Templates in Category

**Slug:** `CLICKSEND_MASTER_EMAIL_TEMPLATES_IN_CATEGORY_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default: 1 |
| `limit` | integer | No | Number of records to return per page. Default: 15 |
| `category_id` | integer | Yes | The unique identifier of the template category. Examples: 2 (Alerts/Notifications), 3 (Art), 4 (Birthday), 23 (Blank Template) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update MMS Campaign

**Slug:** `CLICKSEND_MMS_CAMPAIGNS_BY_MMS_CAMPAIGN_ID_PUT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel MMS Campaign

**Slug:** `CLICKSEND_MMS_CAMPAIGNS_CANCEL_BY_MMS_CAMPAIGN_ID_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mms_campaign_id` | integer | Yes | The unique identifier of the MMS campaign to cancel. Required field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get MMS Campaigns

**Slug:** `CLICKSEND_MMS_CAMPAIGNS_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query string to filter campaigns by name or other fields |
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of items to return per page. Must be between 15 and 100. |
| `operator` | string | No | Search operator to combine query terms. Use 'AND' or 'OR'. |
| `order_by` | string | No | Field name to sort results by (e.g., 'date_added', 'name') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate MMS Campaign Price

**Slug:** `CLICKSEND_MMS_CAMPAIGNS_PRICE_POST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The text content of the MMS message that will be sent to contacts. |
| `from` | string | Yes | The sender phone number in E.164 international format (must start with + followed by country code and number, e.g., +61411111111). |
| `name` | string | Yes | The name you want to give this MMS campaign for identification purposes. |
| `list_id` | integer | Yes | 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. |
| `subject` | string | Yes | The subject line for the MMS message. |
| `media_file` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send MMS Campaign

**Slug:** `CLICKSEND_MMS_CAMPAIGNS_SEND_POST`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export MMS History

**Slug:** `CLICKSEND_MMS_HISTORY_EXPORT_GET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Custom query string for filtering results. Format: field:value pairs separated by commas (e.g., 'from:+61411111111,status_code:201') |
| `limit` | integer | No | Maximum number of records to export. Use to limit the export size |
| `date_to` | integer | No | End date for filtering history as Unix timestamp (seconds since epoch) |
| `filename` | string | Yes | Filename to download MMS history as (e.g., 'mms_history_export.csv') |
| `order_by` | string | No | Field to order results by. Format: 'field:order' where order is 'asc' or 'desc' (e.g., 'date_added:desc', 'date:asc') |
| `date_from` | integer | No | Start date for filtering history as Unix timestamp (seconds since epoch) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate MMS Price

**Slug:** `CLICKSEND_MMS_PRICE_POST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | Array of message objects to calculate price for. Required - at least one message. |
| `media_file` | string | Yes | URL of the media file to send with the MMS (e.g., image URL). Required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark MMS Receipts as Read

**Slug:** `CLICKSEND_MMS_RECEIPTS_READ_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_before` | number | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Buy Dedicated Number

**Slug:** `CLICKSEND_POST_NUMBERS_BUY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | The type of service for the number (e.g., 'sms') |
| `country` | string | No | Two-character ISO country code (e.g., 'US', 'AU') |
| `dedicated_number` | string | Yes | The phone number to purchase, including country code (e.g., '+14155551234') |
| `registration_data` | object | No | Registration information for compliance purposes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Post Return Address

**Slug:** `CLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_DELETE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `return_address_id` | integer | Yes | The unique identifier of the post return address to delete. Must be a valid return address ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Post Return Address

**Slug:** `CLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `return_address_id` | integer | Yes | The unique identifier of the post return address to retrieve. Must be a valid return address ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Post Return Address

**Slug:** `CLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address_city` | string | Yes | Your city. This is a required field for the city name. |
| `address_name` | string | Yes | Your address name. This is a required field that identifies the return address. |
| `address_state` | string | No | Your state. This is an optional field for the state, province, or region. |
| `address_line_1` | string | Yes | Your address line 1. This is a required field for the primary street address. |
| `address_line_2` | string | No | Your address line 2. This is an optional field for additional address details like apartment, suite, or floor number. |
| `address_country` | string | Yes | Your country. This is a required field for the country code (e.g., 'AU' for Australia). |
| `return_address_id` | integer | Yes | The unique identifier of the post return address to update. Must be a valid return address ID from your account. |
| `address_postal_code` | string | Yes | Your postal code. This is a required field for the postal or ZIP code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File

**Slug:** `CLICKSEND_POST_UPLOADS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Your base64 encoded file string. The file content should be encoded in base64 format before uploading. |
| `convert` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Forgot Password

**Slug:** `CLICKSEND_PUT_FORGOT_PASSWORD`

Initiates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Forgot Username

**Slug:** `CLICKSEND_PUT_FORGOT_USERNAME`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Email address registered to the account. Either email or phone_number must be provided. |
| `phone_number` | string | No | Phone number registered to the account in E.164 format or local format. Either email or phone_number must be provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recharge Packages

**Slug:** `CLICKSEND_RECHARGE_PACKAGES_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | Country code to filter packages by specific country (e.g., 'US', 'AU', 'GB'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Purchase Recharge Package

**Slug:** `CLICKSEND_RECHARGE_PURCHASE_BY_PACKAGE_ID_PUT`

Purchase 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `package_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Recharge Transactions

**Slug:** `CLICKSEND_RECHARGE_TRANSACTIONS_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recharge Transaction by ID

**Slug:** `CLICKSEND_RECHARGE_TXNS_BY_TXN_ID_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transaction_id` | string | Yes | The unique identifier of the recharge transaction to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Contact Lists and Contacts

**Slug:** `CLICKSEND_SEARCH_CONTACTS_LISTS_GET`

Search 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `q` | string | No | Search query string to filter contact lists and contacts by name. Search is case-insensitive and matches partial names. |
| `page` | integer | No | Page number for paginated results. Must be at least 1. |
| `limit` | integer | No | Number of records per page. Must be at least 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Email Verification Token

**Slug:** `CLICKSEND_SEND_VERIFICATION_TOKEN_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_address_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel SMS Campaign

**Slug:** `CLICKSEND_SMS_CAMPAIGNS_CANCEL_BY_SMS_CAMPAIGN_ID_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sms_campaign_id` | integer | Yes | The unique identifier of the SMS campaign to cancel. Required field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel All Scheduled SMS

**Slug:** `CLICKSEND_SMS_CANCEL_ALL_PUT`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SMS Delivery Receipt Automation

**Slug:** `CLICKSEND_SMS_DELIVERY_RECEIPT_AUTOMATION_DELETE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | Unique identifier of the SMS delivery receipt automation rule to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Delivery Receipt Automation

**Slug:** `CLICKSEND_SMS_DELIVERY_RECEIPT_AUTOMATION_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | Unique identifier of the SMS delivery receipt automation rule to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Email to SMS Stripped String Rule

**Slug:** `CLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_DELETE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | integer | Yes | The unique identifier of the stripped string rule to delete. Must be a valid rule ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email to SMS Stripped String Rule

**Slug:** `CLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | integer | Yes | The unique identifier of the stripped string rule to retrieve. Must be a valid rule ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email to SMS Stripped String Rule

**Slug:** `CLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | integer | Yes | The unique identifier of the stripped string rule to update. Must be a valid rule ID from your account. |
| `strip_string` | string | Yes | The new text string/pattern to be stripped from emails before SMS conversion. This will replace the existing stripped string for this rule. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export SMS History

**Slug:** `CLICKSEND_SMS_HISTORY_EXPORT_GET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | Filename to download SMS history as (e.g., 'sms_history_export.csv') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Inbound SMS Automation

**Slug:** `CLICKSEND_SMS_INBOUND_AUTOMATION_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbound_rule_id` | integer | Yes | Unique identifier of the inbound SMS automation rule to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inbound SMS Automation

**Slug:** `CLICKSEND_SMS_INBOUND_AUTOMATION_PUT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Inbound SMS as Read by Message ID

**Slug:** `CLICKSEND_SMS_INBOUND_READ_BY_MESSAGE_ID_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Inbound SMS as Read

**Slug:** `CLICKSEND_SMS_INBOUND_READ_PUT`

Mark 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_before` | number | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate SMS Price

**Slug:** `CLICKSEND_SMS_PRICE_POST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messages` | array | Yes | Array of SMS message objects to calculate price for. Required - at least one message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Receipt by Message ID

**Slug:** `CLICKSEND_SMS_RECEIPTS_BY_MESSAGE_ID_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | Unique identifier for the SMS message (UUID format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark SMS Delivery Receipts as Read

**Slug:** `CLICKSEND_SMS_RECEIPTS_READ_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_before` | integer | No | Unix timestamp. Receipts received before this time will be marked as read. If not provided, all receipts will be marked as read. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SMS Template

**Slug:** `CLICKSEND_SMS_TEMPLATES_BY_TEMPLATE_ID_DELETE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | Yes | Unique identifier of the SMS template to delete. Must be a valid template ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SMS Template

**Slug:** `CLICKSEND_SMS_TEMPLATES_BY_TEMPLATE_ID_PUT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | 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. |
| `template_id` | integer | Yes | Unique identifier of the SMS template to update. Must be a valid template ID from your account. |
| `template_name` | string | No | The new name for the template. If not provided, the existing name will be retained. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Specific Allowed Email Address

**Slug:** `CLICKSEND_SPECIFIC_ALLOWED_EMAIL_ADDRESS_DELETE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_address_id` | integer | Yes | The unique identifier of the email address to delete. Must be a valid email address ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Specific Allowed Email Address

**Slug:** `CLICKSEND_SPECIFIC_ALLOWED_EMAIL_ADDRESS_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email_address_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Regenerate Subaccount API Key

**Slug:** `CLICKSEND_SUBACCOUNTS_REGEN_API_KEY_BY_SUBACCOUNT_ID_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subaccount_id` | integer | Yes | The unique identifier of the subaccount to regenerate API key for. Must be a valid subaccount ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account Information

**Slug:** `CLICKSEND_UPDATE_ACCOUNT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country` | string | No | User's country code (ISO 3166-1 alpha-2 format, e.g., 'US', 'AU', 'GB') |
| `user_phone` | string | No | User's phone number in E.164 format (e.g., '+16068249028') |
| `user_last_name` | string | No | User's last name to update |
| `user_first_name` | string | No | User's first name to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Email Delivery Receipt Automation

**Slug:** `CLICKSEND_UPDATE_AUTOMATIONS_EMAIL_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | No | 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. |
| `enabled` | integer | No | Controls activation status of the rule. 0 = disabled, 1 = enabled. |
| `rule_name` | string | No | Name to identify the automation rule. Helps organize and manage multiple rules. Optional - only specify if you want to update the rule name. |
| `match_type` | integer | No | 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. |
| `action_address` | string | No | Designates the target destination or endpoint for the triggered action (e.g., URL endpoint or email address). |
| `receipt_rule_id` | integer | Yes | The unique identifier of the receipt rule to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Inbound Fax Automation

**Slug:** `CLICKSEND_UPDATE_AUTOMATIONS_FAX_INBOUND`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | Yes | 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. |
| `enabled` | integer | Yes | Controls activation status of the rule. 0 = disabled, 1 = enabled. |
| `rule_name` | string | Yes | Name of the automation rule to identify it. Helps organize and manage multiple rules. |
| `action_address` | string | Yes | 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. |
| `inbound_rule_id` | integer | Yes | The unique identifier of the inbound rule to update |
| `dedicated_number` | string | Yes | The dedicated fax number to apply this rule to. Use '*' to apply the rule to all fax numbers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Fax Delivery Receipt Automation

**Slug:** `CLICKSEND_UPDATE_AUTOMATIONS_FAX_RECEIPTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | No | 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. |
| `enabled` | integer | No | Controls activation status of the rule. 0 = disabled, 1 = enabled. |
| `rule_name` | string | No | Name to identify the automation rule. Helps organize and manage multiple rules. |
| `match_type` | integer | No | Specifies match criteria for the delivery receipt. 0 = match all reports. |
| `action_address` | string | No | Designates the target destination or endpoint for the triggered action (e.g., URL endpoint or email address). |
| `receipt_rule_id` | integer | Yes | The unique identifier of the receipt rule to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SMS Delivery Receipt Automation

**Slug:** `CLICKSEND_UPDATE_AUTOMATIONS_SMS_RECEIPTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact List

**Slug:** `CLICKSEND_UPDATE_LISTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | The unique identifier of the contact list to update. Must be a valid list ID from your account. |
| `list_name` | string | Yes | The new name for the contact list. This will replace the existing list name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact in List

**Slug:** `CLICKSEND_UPDATE_LISTS_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Contact's email address. At least one contact method (phone_number, email, or fax_number) must be provided. |
| `list_id` | integer | Yes | The unique identifier of the contact list containing the contact. Must be a valid list ID from your account. |
| `custom_1` | string | No | Custom field 1 for additional contact information |
| `custom_2` | string | No | Custom field 2 for additional contact information |
| `custom_3` | string | No | Custom field 3 for additional contact information |
| `custom_4` | string | No | Custom field 4 for additional contact information |
| `last_name` | string | No | Contact's last name |
| `contact_id` | integer | Yes | The unique identifier of the contact to update. Must be a valid contact ID within the specified list. |
| `fax_number` | string | No | Contact's fax number. At least one contact method (phone_number, email, or fax_number) must be provided. |
| `first_name` | string | No | Contact's first name |
| `address_city` | string | No | City in contact's address |
| `phone_number` | string | No | 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. |
| `address_state` | string | No | State or province in contact's address |
| `address_line_1` | string | No | First line of contact's street address |
| `address_line_2` | string | No | Second line of contact's address (apartment, suite, etc.) |
| `address_country` | string | No | Country code in ISO 3166 format (2-letter country code) for contact's address |
| `organization_name` | string | No | Contact's organization or company name |
| `address_postal_code` | string | No | Postal or ZIP code in contact's address |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Recharge Credit Card Info

**Slug:** `CLICKSEND_UPDATE_RECHARGE_CREDIT_CARD`

Retrieve stored credit card payment information in tokenized/masked form. This tool retrieves the credit card details currently saved for account recharge operations. Returns masked card number (format: XXXX-XXXX-XXXX-0000), expiry date, and cardholder name. ClickSend does not store actual card numbers - only secure tokens. Use this when you need to: - Check what credit card is currently stored for auto-recharge - Verify cardholder details - Confirm card expiration date before recharge operations Returns 404 if no credit card is stored on the account. Note: This is a read-only GET action. To update credit card details, use ClicksendUpdateRechargeCreditCard2 instead.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Reseller Settings

**Slug:** `CLICKSEND_UPDATE_RESELLER`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SMS Campaign

**Slug:** `CLICKSEND_UPDATE_SMS_CAMPAIGNS`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | The message content for your campaign. This is the SMS text that will be sent to contacts. |
| `from` | string | No | Your sender ID. This is the sender name or number that recipients will see. See ClickSend sender ID documentation for requirements. |
| `name` | string | Yes | The title assigned to your campaign. This will replace the existing campaign name. |
| `list_id` | integer | Yes | Identifier for your contact list. The contact list that the campaign should use. |
| `schedule` | integer | No | 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. |
| `url_to_shorten` | string | No | A URL to compress and include in the message. Insert placeholder text in body where the shortened URL should appear. |
| `sms_campaign_id` | integer | Yes | The unique identifier of the SMS campaign to update. Must be a valid campaign ID from your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Subaccount

**Slug:** `CLICKSEND_UPDATE_SUBACCOUNTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | New email address for the subaccount. This is required for account notifications and communications. |
| `password` | string | No | New password for the subaccount. Must be a strong password for security. When provided, old_password is also required. |
| `last_name` | string | Yes | Last name of the subaccount user. Required field for personalization. |
| `first_name` | string | Yes | First name of the subaccount user. Required field for personalization. |
| `access_users` | integer | No | Access permission for users management. Use 0 for no access, 1 for access granted. Defaults to 1. |
| `api_username` | string | Yes | New API username for the subaccount. This will be used for API authentication. |
| `old_password` | string | No | Current password for the subaccount. Required only when updating the password field. |
| `phone_number` | string | Yes | Phone number in E.164 format (e.g., '+61411111111'). Required contact number for the subaccount. |
| `subaccount_id` | integer | Yes | The unique identifier of the subaccount to update. Must be a valid subaccount ID from your account. |
| `access_billing` | integer | No | Access permission for billing features. Use 0 for no access, 1 for access granted. Defaults to 1. |
| `access_contacts` | integer | No | Access permission for contacts management. Use 0 for no access, 1 for access granted. Defaults to 0. |
| `access_settings` | integer | No | Access permission for settings. Use 0 for no access, 1 for access granted. Defaults to 1. |
| `access_reporting` | integer | No | Access permission for reporting features. Use 0 for no access, 1 for access granted. Defaults to 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Agree to User Countries Rules

**Slug:** `CLICKSEND_USER_COUNTRIES_AGREE_POST`

Agrees to the rules and regulations for all previously selected countries in Global Sending. This action confirms acceptance of the regulatory requirements and content restrictions for countries that have been selected via POST /user-countries. After agreeing, the action returns a detailed list of all selected countries including their specific regulatory requirements, registration status, and any additional compliance information needed for sending SMS/MMS to those regions. Use this after selecting countries for international messaging to formally acknowledge compliance with their sending rules. The response includes critical information such as content restrictions (e.g., no gambling, adult content), registration requirements, and links to detailed country-specific guidelines. This is typically part of a workflow: 1) Get available countries (GET /country-list) → 2) Select countries (POST /user-countries) → 3) Agree to rules (this action) → 4) Begin sending messages.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Countries

**Slug:** `CLICKSEND_USER_COUNTRIES_GET`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Select User Countries

**Slug:** `CLICKSEND_USER_COUNTRIES_POST`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_list_ids` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Allowed Email Address

**Slug:** `CLICKSEND_VERIFY_ALLOWED_EMAIL_ADDRESS_GET`

Verify 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `activation_token` | string | Yes | 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. |
| `email_address_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Forgot Password

**Slug:** `CLICKSEND_VERIFY_FORGOT_PASSWORD_VERIFY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `password` | string | Yes | The new password to be set for the account |
| `subaccount_id` | integer | Yes | The identifier for the subaccount that needs password reset |
| `activation_token` | string | Yes | The verification token/code received via email from the forgot password request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel All Scheduled Voice Messages

**Slug:** `CLICKSEND_VOICE_CANCEL_ALL_PUT`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Voice Receipt Automation

**Slug:** `CLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_DELETE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | The unique identifier of the voice delivery receipt automation rule to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Voice Delivery Receipt Automation

**Slug:** `CLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_GET`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt_rule_id` | integer | Yes | Unique identifier of the voice delivery receipt automation rule to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Voice Delivery Receipt Automation

**Slug:** `CLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_PUT`

Tool to update a voice delivery receipt automation rule in ClickSend. Use when you need to modify the configuration of an existing voice receipt automation rule. 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Voice History

**Slug:** `CLICKSEND_VOICE_HISTORY_EXPORT_GET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Voice Delivery Receipts as Read

**Slug:** `CLICKSEND_VOICE_RECEIPTS_READ_PUT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date_before` | number | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |