ClickSend

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.

Phone & SMS Email Marketing Automation Web del proveedor

Acciones

183

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (183)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Get Account Usage by SubaccountCLICKSEND_ACCOUNT_USEAGE_BY_SUBACCOUNT_GETAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject[]
List of subaccount usage data for the specified period
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Send Account Activation TokenCLICKSEND_ACCOUNT_VERIFY_SEND_PUTAcción

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.

Parámetros de entrada

typestring
Verification method type. Required for successful verification.
countrystring
Country designation (e.g., 'US'). Required for successful verification.
user_phonestring
Your phone number in E.164 format (e.g., '+13523944199'). Required for successful verification.

Parámetros de salida

dataobject
Data model for verification response details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Confirmation message
response_codestring
Response status indicator ('SUCCESS' for successful requests)

Verify New AccountCLICKSEND_ACCOUNT_VERIFY_VERIFY_BY_ACTIVATION_TOKEN_PUTAcción

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.

Parámetros de entrada

activation_tokenintegerObligatorio
Activation token for account verification (integer format)

Parámetros de salida

datastring
Contains additional data returned by the API
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Calculate Post Letter PriceCLICKSEND_CALCULATE_POST_LETTERS_PRICEAcción

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

Parámetros de entrada

colourinteger
Whether letter is printed in colour. 0 = black and white, 1 = colour. Default is 0.
duplexinteger
Whether letter is printed double-sided. 0 = single-sided, 1 = double-sided. Default is 0.
sourcestring
Source identifier for tracking purposes. Can be any string value.
file_urlstringObligatorio
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.
recipientsobject[]Obligatorio
Array of recipient objects. Each recipient represents a person who will receive a copy of the letter.
priority_postinteger
Whether the letter is priority post. 0 = standard post, 1 = priority post. Default is 0.
template_usedinteger
Whether using a ClickSend template. 0 = not using template, 1 = using template. Default is 0.

Parámetros de salida

dataobject
Data model for post letter pricing information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable message describing the response outcome
response_codestring
Response status code indicating success or failure (e.g., 'SUCCESS')

Calculate SMS Campaign PriceCLICKSEND_CALCULATE_SMS_CAMPAIGNS_PRICEAcción

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.

Parámetros de entrada

bodystringObligatorio
Your campaign message content. Use placeholders like (First Name) for personalization. Required field.
fromstring
Sender identifier (phone number or alphanumeric sender ID). See ClickSend docs for supported formats. Optional field.
namestringObligatorio
Your campaign name for identification. Required field.
list_idintegerObligatorio
Your contact list ID containing the campaign recipients. Required field.
scheduleinteger
Unix timestamp for scheduling the campaign. Defaults to 0 for immediate sending. Optional field.
url_to_shortenstring
URL requiring shortening. Add 'http://smsg.io/xxxxx' as placeholder in message body where shortened link should appear. Optional field.

Parámetros de salida

dataobject
Data model for SMS campaign price calculation details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., SUCCESS)

Create Email Delivery Receipt AutomationCLICKSEND_CREATE_AUTOMATIONS_EMAIL_RECEIPTSAcción

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.

Parámetros de entrada

actionstring
Determines the response type when rule matches. Valid values: AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT, SMPP, or NONE.
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled (default: 1).
rule_namestring
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Specifies match criteria for the delivery receipt. 0 = match all reports (default: 0).
action_addressstring
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL endpoint for URL action).

Parámetros de salida

dataobject
Data model for the created email receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create Inbound Fax AutomationCLICKSEND_CREATE_AUTOMATIONS_FAX_INBOUNDAcción

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.

Parámetros de entrada

actionstringObligatorio
The action to perform when a fax is received. Supported actions include EMAIL_FIXED (send to fixed email), URL (send to webhook), and others.
enabledintegerObligatorio
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestringObligatorio
Name of the automation rule to identify it. Helps organize and manage multiple rules.
action_addressstringObligatorio
The destination address for the action. For EMAIL_FIXED action, provide an email address. For URL action, provide a webhook URL.
dedicated_numberstringObligatorio
The dedicated fax number to apply this rule to. Use '*' to apply the rule to all fax numbers.

Parámetros de salida

dataobject
Data model for the created inbound fax rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create Fax Delivery Receipt AutomationCLICKSEND_CREATE_AUTOMATIONS_FAX_RECEIPTSAcción

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

Parámetros de entrada

actionstringObligatorio
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.
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled (default: 1).
rule_namestringObligatorio
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Specifies match criteria for the delivery receipt. 0 = match all reports (default: 0).
action_addressstringObligatorio
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL endpoint for URL action).

Parámetros de salida

dataobject
Data model for the created fax receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create Inbound SMS AutomationCLICKSEND_CREATE_AUTOMATIONS_SMS_INBOUNDAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the created inbound SMS rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create SMS Delivery Receipt AutomationCLICKSEND_CREATE_AUTOMATIONS_SMS_RECEIPTSAcción

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.

Parámetros de entrada

actionstring
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.
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestring
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Specifies match criteria for the delivery receipt. 0 = match all reports, 1-3 = specific match types.
action_addressstring
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL for URL action).

Parámetros de salida

dataobject
Data model for the created SMS receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create Voice Delivery Receipt AutomationCLICKSEND_CREATE_AUTOMATIONS_VOICE_RECEIPTSAcción

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.

Parámetros de entrada

actionstringObligatorio
Response action to perform when rule matches (e.g., 'URL' for webhook, 'EMAIL_FIXED' for email notification).
enabledintegerObligatorio
Binary flag to activate/deactivate the rule. 1 = enabled, 0 = disabled.
rule_namestringObligatorio
Name identifying the automation rule. Helps organize and manage multiple rules.
match_typeintegerObligatorio
Determines which delivery statuses trigger the rule. Value 0 = All delivery reports, values 1-3 = Specific status filters.
action_addressstringObligatorio
Target destination for the action - URL endpoint or email address where delivery receipts will be sent.

Parámetros de salida

dataobject
Data model for the created voice receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable response message (e.g., 'Your new voice receipt has been added.')
response_codestring
Response status code (e.g., 'SUCCESS')

Create Delivery IssueCLICKSEND_CREATE_DELIVERY_ISSUESAcción

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.

Parámetros de entrada

typestringObligatorio
The type of message. Required. Must be one of: SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST.
message_idstring
The message ID of the message. Optional field to reference a specific message.
descriptionstringObligatorio
The description of the delivery issue. Required field explaining what went wrong with the message delivery.
email_addressstringObligatorio
The user's email address for contact regarding this delivery issue. Required field.
client_commentsstring
Optional comments from the user providing additional context about the delivery issue.

Parámetros de salida

dataobject
Data model for delivery issue response.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., SUCCESS)

Create Allowed Email AddressCLICKSEND_CREATE_EMAIL_ADDRESSES2Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for created email address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Allowed Email AddressesCLICKSEND_CREATE_EMAIL_ADDRESSES6Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for email addresses.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create Email Template from MasterCLICKSEND_CREATE_EMAIL_TEMPLATESAcción

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.

Parámetros de entrada

template_namestringObligatorio
The intended name for the new email template. This is a user-defined name that will identify your custom template.
template_id_masterintegerObligatorio
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.

Parámetros de salida

dataobject
Data model for the created email template details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Add Fax Delivery Receipt WebhookCLICKSEND_CREATE_FAX_RECEIPTSAcción

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

Parámetros de entrada

urlstringObligatorio
Your webhook URL where fax delivery receipt notifications will be sent. ClickSend will POST delivery status updates to this endpoint when faxes are delivered.

Parámetros de salida

dataobject
Data model for the configured receipt URL details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create Contact ListCLICKSEND_CREATE_LISTSAcción

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.

Parámetros de entrada

list_namestringObligatorio
The name of the contact list to create. Must be unique within your account.

Parámetros de salida

dataobject
Data model for the created contact list details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., SUCCESS)

Create Contact in ListCLICKSEND_CREATE_LISTS_CONTACTSAcción

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.

Parámetros de entrada

emailstring
Contact's email address. At least one of phone_number, email, or fax_number must be provided.
list_idintegerObligatorio
The unique identifier of the contact list where the contact will be created. Must be a valid list ID from your account.
custom_1string
Custom field 1 for additional contact information
custom_2string
Custom field 2 for additional contact information
custom_3string
Custom field 3 for additional contact information
custom_4string
Custom field 4 for additional contact information
last_namestring
Contact's last name
fax_numberstring
Contact's fax number. At least one of phone_number, email, or fax_number must be provided.
first_namestring
Contact's first name
address_citystring
City in contact's address
phone_numberstring
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_statestring
State or province in contact's address
address_line_1string
First line of contact's address
address_line_2string
Second line of contact's address
address_countrystring
Country name in contact's address
organization_namestring
Contact's organization or company name
address_postal_codestring
Postal or ZIP code in contact's address

Parámetros de salida

dataobject
Data model for created contact details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful creation)

Send MMS MessagesCLICKSEND_CREATE_MMS_SENDAcción

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.

Parámetros de entrada

messagesobject[]Obligatorio
Array of MMS message objects to send. Required - at least one message, maximum 1000 messages per API call.
media_filestringObligatorio
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.

Parámetros de salida

dataobject
Data model for MMS send response.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (e.g., 200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Descriptive message about operation outcome (e.g., 'Messages queued for delivery.')
response_codestring
Operation status code (e.g., 'SUCCESS')

Send Direct Mail CampaignCLICKSEND_CREATE_POST_DIRECT_MAIL_CAMPAIGNS_SENDAcción

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.

Parámetros de entrada

namestringObligatorio
Campaign name for identification and tracking purposes.
sizestringObligatorio
Size of the direct mail piece. Common values include 'A5', 'A4', 'A6', 'DL', etc.
areasobject[]Obligatorio
List of target areas with their respective quantities. Each area specifies a location_id and the number of mail pieces to send to that location.
file_urlsstring[]Obligatorio
List of publicly accessible URLs pointing to PDF files for the direct mail content. Must be valid URLs to PDF files.

Parámetros de salida

dataobject
Data model for the created direct mail campaign details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Descriptive message about the operation result
response_codestring
Response status code (e.g., 'SUCCESS')

Detect Address from PDF or StringCLICKSEND_CREATE_POST_LETTERS_DETECT_ADDRESSAcción

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.

Parámetros de entrada

addressstring
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.
contentstring
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.

Parámetros de salida

dataobject
Data model for detected address information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable message describing the response outcome
response_codestring
API response code indicating success or failure (e.g., 'SUCCESS')

Send Post LetterCLICKSEND_CREATE_POST_LETTERS_SENDAcción

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.

Parámetros de entrada

colourinteger
Whether letter is printed in colour. 0 = black and white, 1 = colour. Default is 0.
duplexinteger
Whether letter is printed double-sided. 0 = single-sided, 1 = double-sided. Default is 0.
sourcestring
Source identifier for tracking purposes. Can be any string value.
file_urlstringObligatorio
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.
recipientsobject[]Obligatorio
Array of recipient objects. Each recipient represents a person who will receive a copy of the letter.
priority_postinteger
Whether the letter is priority post. 0 = standard post, 1 = priority post. Default is 0.
template_usedinteger
Whether using a ClickSend template. 0 = not using template, 1 = using template. Default is 0.

Parámetros de salida

dataobject
Data model for individual post letter message details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable message describing the response outcome
response_codestring
Response status code indicating success or failure (e.g., 'SUCCESS')

Create Post Return AddressCLICKSEND_CREATE_POST_RETURN_ADDRESSESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the created post return address.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable message describing the response outcome
response_codestring
API response code indicating success or failure (e.g., 'SUCCESS')

Get All Post Return AddressesCLICKSEND_CREATE_POST_RETURN_ADDRESSES3Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated post return addresses.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable message describing the response
response_codestring
API response code indicating success or failure (e.g., SUCCESS)

Create and Send SMS CampaignCLICKSEND_CREATE_SMS_CAMPAIGNS_SENDAcción

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.

Parámetros de entrada

bodystringObligatorio
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).
fromstring
The sender identification. Options include: shared number, dedicated number (E.164 format like +61353787448), alpha tag (business name), or own number.
namestringObligatorio
The name of the SMS campaign for identification and tracking purposes.
list_idintegerObligatorio
The ID of the contact list to send the campaign to. Use View Contact List endpoint to see available lists.
scheduleinteger
UNIX timestamp for scheduling the campaign. Defaults to 0 (send immediately).
url_to_shortenstring
URL to be shortened. Use http://smsg.io/xxxxx as placeholder in the message body where the shortened link should appear.

Parámetros de salida

dataobject
Data model for SMS campaign details in the response.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Descriptive message about the operation result
response_codestring
Operation status code (e.g., 'SUCCESS')

Create Email-to-SMS Allowed AddressCLICKSEND_CREATE_SMS_EMAIL_SMS2Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the created email-to-SMS address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful creation)

Get SMS Email-to-SMS Allowed AddressCLICKSEND_CREATE_SMS_EMAIL_SMS3Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for email-to-SMS allowed address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful retrieval)

Update Email-to-SMS Allowed AddressCLICKSEND_CREATE_SMS_EMAIL_SMS4Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the updated email-to-SMS address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful update)

Delete SMS Email-to-SMS Allowed AddressCLICKSEND_CREATE_SMS_EMAIL_SMS5Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional data returned by the API (typically empty for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Create Email to SMS Stripped String RuleCLICKSEND_CREATE_SMS_EMAIL_SMS_STRIPPED_STRINGSAcción

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.

Parámetros de entrada

strip_stringstringObligatorio
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.

Parámetros de salida

dataobject
Data model for the created stripped string rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful creation)

Create Test Inbound SMSCLICKSEND_CREATE_SMS_INBOUNDAcción

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

Parámetros de entrada

urlstringObligatorio
The webhook URL where inbound SMS messages will be forwarded. Must be a valid HTTP/HTTPS URL.
methodstring
The HTTP method to use when sending data to the webhook URL. Valid values: 'post' (default), 'get', or 'json'. Defaults to 'post' if not specified.

Parámetros de salida

dataobject
Data model for the test inbound SMS message details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Add SMS Delivery Receipt WebhookCLICKSEND_CREATE_SMS_RECEIPTSAcción

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

Parámetros de entrada

urlstringObligatorio
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.

Parámetros de salida

dataobject
Test receipt data returned when adding SMS delivery receipt webhook.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation (e.g., 'Test receipt has been added')
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Send SMS MessagesCLICKSEND_CREATE_SMS_SENDAcción

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.

Parámetros de entrada

messagesobject[]Obligatorio
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.

Parámetros de salida

dataobject
Data model for SMS send response data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome (e.g., 'Messages queued for delivery.')
response_codestring
The response code of the operation (e.g., 'SUCCESS')

Create SMS TemplateCLICKSEND_CREATE_SMS_TEMPLATESAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the created SMS template details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Create SubaccountCLICKSEND_CREATE_SUBACCOUNTSAcción

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.

Parámetros de entrada

emailstringObligatorio
Email address for the subaccount. This is required for account notifications and communications.
notesstring
Optional notes about the subaccount for reference purposes.
user_idinteger
User ID to associate with the subaccount. Optional field for linking to existing user.
passwordstringObligatorio
Password for the new subaccount. Must be a strong password for security.
last_namestringObligatorio
Last name of the subaccount user. Required field.
first_namestringObligatorio
First name of the subaccount user. Required field.
access_smppinteger
Access to SMPP protocol. Use 0 for no access, 1 for access granted.
access_usersinteger
Access to users management. Use 0 for no access, 1 for access granted.
api_usernamestringObligatorio
Username for the new subaccount. This will be used for API authentication.
phone_numberstringObligatorio
Phone number in international format (e.g., '+61411111111'). Required contact number for the subaccount.
access_billinginteger
Access to billing features. Use 0 for no access, 1 for access granted.
access_contactsinteger
Access to contacts management. Use 0 for no access, 1 for access granted.
access_settingsinteger
Access to settings. Use 0 for no access, 1 for access granted.
access_reportinginteger
Access to reporting features. Use 0 for no access, 1 for access granted.
sms_deidentify_messageinteger
SMS de-identify message setting. Use 0 for disabled, 1 for enabled.

Parámetros de salida

dataobject
Data model for the created subaccount details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status (SUCCESS for successful creation)

Delete Email Delivery Receipt AutomationCLICKSEND_DELETE_AUTOMATIONS_EMAIL_RECEIPTSAcción

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

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the email delivery receipt automation rule to delete

Parámetros de salida

databoolean
Operation result indicating successful deletion
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete Inbound SMS AutomationCLICKSEND_DELETE_AUTOMATIONS_SMS_INBOUNDAcción

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

Parámetros de entrada

inbound_rule_idintegerObligatorio
Unique identifier of the inbound SMS automation rule to delete

Parámetros de salida

dataobject[]
Additional data returned by the API (typically empty for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete Contact ListCLICKSEND_DELETE_LISTSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional data returned by the API (typically null for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Delete Contact from ListCLICKSEND_DELETE_LISTS_CONTACTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional data returned by the API (typically empty for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Remove Opted Out Contacts from ListCLICKSEND_DELETE_LISTS_REMOVE_OPTED_OUT_CONTACTSAcción

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.

Parámetros de entrada

list_idintegerObligatorio
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_idintegerObligatorio
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.

Parámetros de salida

dataobject
Data model for deleted contacts count.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful removal)

Cancel Scheduled SMSCLICKSEND_DELETE_SMS_CANCELAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional response data about the cancelled SMS message (e.g., count)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation outcome
response_codestring
The response status code indicating operation result (e.g., SUCCESS)

Delete SMS TemplateCLICKSEND_DELETE_SMS_TEMPLATESAcción

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

Parámetros de entrada

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

Parámetros de salida

datanull
Template data parameter (deprecated, always returns null for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation outcome
response_codestring
The response status code indicating operation result (e.g., SUCCESS)

Delete SubaccountCLICKSEND_DELETE_SUBACCOUNTSAcción

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

Parámetros de entrada

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

Parámetros de salida

databoolean
Deletion confirmation, returns true on successful deletion
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Get Email CampaignCLICKSEND_EMAIL_CAMPAIGN_GETAcción

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.

Parámetros de entrada

email_campaign_idintegerObligatorio
Unique identifier of the email campaign to retrieve

Parámetros de salida

dataobject
Data model for email campaign details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete Email Delivery Receipt AutomationCLICKSEND_EMAIL_DELIVERY_RECEIPT_AUTOMATION_DELETEAcción

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

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the email delivery receipt automation rule to delete

Parámetros de salida

databoolean
Operation result indicating successful deletion
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Email Delivery Receipt AutomationCLICKSEND_EMAIL_DELIVERY_RECEIPT_AUTOMATION_GETAcción

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

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the email delivery receipt automation rule to retrieve

Parámetros de salida

dataobject
Data model for email receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Email Delivery Receipt AutomationCLICKSEND_EMAIL_DELIVERY_RECEIPT_AUTOMATION_PUTAcción

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

Parámetros de entrada

actionstring
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.
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestring
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Specifies match criteria for the delivery receipt. 0 = match all reports (default: 0).
action_addressstring
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL endpoint for URL action).
receipt_rule_idintegerObligatorio
Unique identifier of the email delivery receipt automation rule to update

Parámetros de salida

dataobject
Data model for the updated email receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete Email TemplateCLICKSEND_EMAIL_TEMPLATE_DELETEAcción

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

Parámetros de entrada

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

Parámetros de salida

datanull
Additional data returned by the API (null for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Get Email TemplateCLICKSEND_EMAIL_TEMPLATE_GETAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for email template details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Update Email TemplateCLICKSEND_EMAIL_TEMPLATE_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the updated email template details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Export Post Letters HistoryCLICKSEND_EXPORT_POST_LETTERS_HISTORY_EXPORTAcción

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.

Parámetros de entrada

filenamestringObligatorio
Filename to download post letters history as (e.g., 'letters_history.csv'). Must include .csv extension.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Fax Delivery Receipt AutomationCLICKSEND_FAX_DELIVERY_RECEIPT_AUTOMATION_DELETEAcción

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.

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the fax delivery receipt automation rule to delete

Parámetros de salida

dataobject[]
Additional data returned by the API (typically null for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Fax Delivery Receipt AutomationCLICKSEND_FAX_DELIVERY_RECEIPT_AUTOMATION_GETAcción

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.

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the fax delivery receipt automation rule to retrieve

Parámetros de salida

dataobject
Data model for fax receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Fax Delivery Receipt AutomationCLICKSEND_FAX_DELIVERY_RECEIPT_AUTOMATION_PUTAcción

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

Parámetros de entrada

actionstringObligatorio
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.
enabledintegerObligatorio
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestringObligatorio
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeintegerObligatorio
Specifies match criteria for the delivery receipt. 0 = match all reports.
action_addressstringObligatorio
Designates the target destination or endpoint for the triggered action (e.g., URL endpoint or email address).
receipt_rule_idintegerObligatorio
The unique identifier of the receipt rule to update

Parámetros de salida

dataobject
Data model for the updated fax receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Inbound Fax AutomationCLICKSEND_FAX_INBOUND_AUTOMATION_PUTAcción

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

Parámetros de entrada

actionstringObligatorio
The action to perform when a fax is received. Allowed 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.
enabledintegerObligatorio
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestringObligatorio
Name of the automation rule to identify it. Helps organize and manage multiple rules.
action_addressstringObligatorio
The destination address for the action. For EMAIL_FIXED action, provide an email address. For URL action, provide a webhook URL.
inbound_rule_idintegerObligatorio
The unique identifier of the inbound fax rule to update.
dedicated_numberstringObligatorio
The dedicated fax number to apply this rule to. Use '*' to apply the rule to all fax numbers.

Parámetros de salida

dataobject
Data model for the updated inbound fax rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Fax Receipt by Message IDCLICKSEND_FAX_RECEIPTS_BY_MESSAGE_ID_GETAcción

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.

Parámetros de entrada

message_idstringObligatorio
Unique identifier for the fax message (UUID format)

Parámetros de salida

dataobject
Data model for fax receipt details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Mark Fax Receipts as ReadCLICKSEND_FAX_RECEIPTS_READ_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional response data (typically null for this endpoint)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Account InformationCLICKSEND_GET_ACCOUNTAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Data model for account details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Email Delivery Receipt AutomationsCLICKSEND_GET_AUTOMATIONS_EMAIL_RECEIPTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for email receipt rules.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Inbound Fax AutomationsCLICKSEND_GET_AUTOMATIONS_FAX_INBOUNDAcción

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.

Parámetros de entrada

pageinteger
The page number to retrieve. Default: 1
limitinteger
Number of items per page. Minimum: 15, Maximum: 100, Default: 15

Parámetros de salida

dataobject
Pagination and data model for fax inbound rules.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Fax Delivery Receipt AutomationsCLICKSEND_GET_AUTOMATIONS_FAX_RECEIPTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for fax receipt rules.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Inbound SMS AutomationsCLICKSEND_GET_AUTOMATIONS_SMS_INBOUNDAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for SMS inbound rules.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All SMS Delivery Receipt AutomationsCLICKSEND_GET_AUTOMATIONS_SMS_RECEIPTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for SMS receipt rules.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Voice Delivery Receipt AutomationsCLICKSEND_GET_AUTOMATIONS_VOICE_RECEIPTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for voice receipt rules.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Contact SuggestionsCLICKSEND_GET_CONTACT_SUGGESTIONSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for contact suggestions.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All CountriesCLICKSEND_GET_COUNTRIESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]
List of country objects with codes and names
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Delivery IssuesCLICKSEND_GET_DELIVERY_ISSUESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for delivery issues.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Master Email TemplatesCLICKSEND_GET_EMAIL_MASTER_TEMPLATESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]
Array of master email template objects
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Master Email Template CategoriesCLICKSEND_GET_EMAIL_MASTER_TEMPLATES_CATEGORIESAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject[]
Array of email template category objects
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All User Email TemplatesCLICKSEND_GET_EMAIL_TEMPLATESAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject
Paginated data structure for email templates.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Fax Delivery ReceiptsCLICKSEND_GET_FAX_RECEIPTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for fax receipts.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All Contact ListsCLICKSEND_GET_LISTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated contact lists.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Specific Contact ListCLICKSEND_GET_LISTS2Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for contact list details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Get All Contacts in ListCLICKSEND_GET_LISTS_CONTACTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated contacts.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful retrieval)

Get Specific ContactCLICKSEND_GET_LISTS_CONTACTS2Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for contact details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful retrieval)

Export Contacts ListCLICKSEND_GET_LISTS_EXPORTAcción

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.

Parámetros de entrada

list_idintegerObligatorio
The ID of the contact list to export
filenamestringObligatorio
Filename to download the contacts list as (e.g., 'contacts_export.csv'). Must include .csv extension.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Import Contacts to ListCLICKSEND_GET_LISTS_IMPORTAcción

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.

Parámetros de entrada

list_idintegerObligatorio
The unique identifier of the contact list to import contacts into. Must be a valid list ID from your account.
file_urlstringObligatorio
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_orderstring[]Obligatorio
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.

Parámetros de salida

dataobject
Additional data returned by the API for the import operation. Can be a dictionary or an integer status code.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful import initiation)

Preview CSV Import for Contact ListCLICKSEND_GET_LISTS_IMPORT_CSV_PREVIEWAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for CSV preview information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get List Import FieldsCLICKSEND_GET_LISTS_IMPORT_FIELDSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]
Array of acceptable import field objects with field names and labels
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Export MMS HistoryCLICKSEND_GET_MMS_HISTORYAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for MMS history pagination and message data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (e.g., 200)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Response message (e.g., 'Here are your data.')
response_codestring
Response status code (e.g., 'SUCCESS')

Get MMS Delivery ReceiptsCLICKSEND_GET_MMS_RECEIPTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Pagination and data model for MMS receipts.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Dedicated NumbersCLICKSEND_GET_NUMBERSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated dedicated numbers.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Search Dedicated Numbers by CountryCLICKSEND_GET_NUMBERS_SEARCHAcción

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.

Parámetros de entrada

pageinteger
Page number for pagination. Must be at least 1.
limitinteger
Number of records per page. Must be at least 1.
searchstring
Search pattern or query to match against available phone numbers
countrystringObligatorio
Two-letter country code to search for available dedicated numbers (e.g., 'US', 'AU', 'GB')
search_typeintegerenum
Search strategy: 0 = starts with, 1 = anywhere, 2 = ends with
012

Parámetros de salida

dataobject
Pagination wrapper for dedicated number search results.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Search Direct Mail LocationsCLICKSEND_GET_POST_DIRECT_MAIL_LOCATIONS_SEARCHAcción

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.

Parámetros de entrada

qstringObligatorio
Search query string to find matching locations. Can be city name, state, postal code, or address fragment.
countrystringObligatorio
Country code or country name to search locations within (e.g., 'US', 'AU', 'United States')

Parámetros de salida

dataobject
Data model for locations search results.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Post Letters HistoryCLICKSEND_GET_POST_LETTERS_HISTORYAcción

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

Parámetros de entrada

pageinteger
Page number for pagination
limitinteger
Number of records per page

Parámetros de salida

dataobject
Data model for post letters history pagination and letter data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable response message
response_codestring
Response status code (e.g., 'SUCCESS')

Get Country PricingCLICKSEND_GET_PRICINGAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for individual pricing information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Referral AccountsCLICKSEND_GET_REFERRAL_ACCOUNTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated referral accounts.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Reseller SettingsCLICKSEND_GET_RESELLERAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Data model for reseller settings.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Reseller AccountsCLICKSEND_GET_RESELLER_ACCOUNTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated reseller accounts.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get SMS CampaignCLICKSEND_GET_SMS_CAMPAIGNSAcción

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.

Parámetros de entrada

sms_campaign_idintegerObligatorio
Unique identifier of the SMS campaign to retrieve

Parámetros de salida

dataobject
Data model for SMS campaign details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get SMS Campaigns ListCLICKSEND_GET_SMS_CAMPAIGNS3Acción

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.

Parámetros de entrada

qstring
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.
pageinteger
Page number for paginated results. Must be at least 1.
limitinteger
Number of items to return per page. Must be between 15 and 100.

Parámetros de salida

dataobject
Data model for SMS campaigns pagination and data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable response message
response_codestring
Response status code (e.g., 'SUCCESS')

Get Email to SMS Stripped String Rules ListCLICKSEND_GET_SMS_EMAIL_SMS_STRIPPED_STRINGSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated stripped string rules.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get SMS HistoryCLICKSEND_GET_SMS_HISTORYAcción

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.

Parámetros de entrada

qstring
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.
pageinteger
Page number for pagination. Used to navigate through result pages.
limitinteger
Number of records to return per page.
date_tointeger
Filter messages sent up to this date. Unix timestamp format (seconds since epoch).
operatorstringenum
Logical operator for multiple search filters. Use 'AND' to match all filters or 'OR' to match any filter.
ANDOR
order_bystring
Sort results by field. Format: field:asc or field:desc (e.g., 'date:desc', 'status:asc').
date_frominteger
Filter messages sent from this date onwards. Unix timestamp format (seconds since epoch).

Parámetros de salida

dataobject
Data model for SMS history pagination and message data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (e.g., 200)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Message describing the outcome
response_codestring
Operation response code (e.g., 'SUCCESS')

Get Inbound SMS MessagesCLICKSEND_GET_SMS_INBOUNDAcción

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

Parámetros de entrada

qstring
Search query to filter results. Format: field_name:value (e.g., from:+61437085284). Searches are not case-sensitive. Available searchable fields include: from, to, message_id, body, and other SMS fields
pageinteger
Page number for pagination. Default: 1
limitinteger
Number of records per page. Default: 15
operatorstring
Search operator to use when multiple search criteria are provided. Default: AND
order_bystring
Field and direction to sort results. Format: field_name:direction (asc or desc). Default: date:asc

Parámetros de salida

dataobject
Pagination and data model for inbound SMS messages.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code of the operation (e.g., 'SUCCESS')

Get SMS Delivery ReceiptsCLICKSEND_GET_SMS_RECEIPTSAcción

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.

Parámetros de entrada

pageinteger
Page number for pagination. Minimum: 1. Default: 1
limitinteger
Number of records per page. Minimum: 1. Default: 10

Parámetros de salida

dataobject
Pagination and data model for SMS receipts.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All SMS TemplatesCLICKSEND_GET_SMS_TEMPLATESAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated SMS templates.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get SMS StatisticsCLICKSEND_GET_STATISTICS_SMSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Data model for SMS statistics details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Voice StatisticsCLICKSEND_GET_STATISTICS_VOICEAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Data model for voice statistics details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get All SubaccountsCLICKSEND_GET_SUBACCOUNTSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated subaccounts.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Specific SubaccountCLICKSEND_GET_SUBACCOUNTS2Acción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for subaccount details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Supported TimezonesCLICKSEND_GET_TIMEZONESAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

datastring[]
Array of available timezone names (e.g., 'America/New_York', 'Europe/London', 'Australia/Sydney')
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Voice LanguagesCLICKSEND_GET_VOICE_LANGAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]
Array of available voice language objects with code, country, and gender options
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

List CountriesCLICKSEND_LIST_COUNTRIES_GETAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]
Contains the list of countries with their IDs
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Copy Contact to Another ListCLICKSEND_LISTS_COPY_CONTACT_PUTAcción

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.

Parámetros de entrada

contact_idintegerObligatorio
Contact ID of the contact to be copied. Must be a valid contact ID within the source list.
to_list_idintegerObligatorio
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_idintegerObligatorio
List ID for list that contains the contact. This is the source list ID from which the contact will be copied.

Parámetros de salida

dataobject
Data model for copied contact details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful copy)

Transfer Contact Between ListsCLICKSEND_LISTS_TRANSFER_CONTACT_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional data returned by the API about the transfer operation
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful transfer)

Mark SMS Receipts as ReadCLICKSEND_MARK_SMS_RECEIPTSAcción

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

Parámetros de entrada

date_beforeinteger
Unix timestamp format. Cutoff date - only receipts sent before this time will be marked as read. If not provided, all receipts will be marked as read.

Parámetros de salida

dataobject
Contains additional response data, typically null for this endpoint
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response (e.g., 200)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation (e.g., 'Receipts have been marked as read.')
response_codestring
The response code indicating operation status (e.g., 'SUCCESS')

Mark Voice Receipts as ReadCLICKSEND_MARK_VOICE_RECEIPTS_READAcción

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

Parámetros de entrada

date_beforenumber
Optional Unix timestamp. Mark all voice delivery receipts as read that were received before this timestamp. If not provided, all voice message receipts will be marked as read. It's recommended to use the date from the last message in the GET /voice/receipts response.

Parámetros de salida

datainteger
Usually null, or the number of receipts marked as read
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Get Master Email Template CategoryCLICKSEND_MASTER_EMAIL_TEMPLATE_CATEGORY_GETAcción

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.

Parámetros de entrada

category_idintegerObligatorio
The unique identifier of the master email template category to retrieve

Parámetros de salida

dataobject
Data model for master email template category details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Master Email TemplateCLICKSEND_MASTER_EMAIL_TEMPLATE_GETAcción

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

Parámetros de entrada

template_idintegerObligatorio
The unique identifier of the master email template to retrieve. Must be a valid template ID.

Parámetros de salida

dataobject
Data model for master email template details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Get Master Email Templates in CategoryCLICKSEND_MASTER_EMAIL_TEMPLATES_IN_CATEGORY_GETAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject[]
Array of master template objects
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable message describing the result
response_codestring
Response status indicator (e.g., 'SUCCESS')

Update MMS CampaignCLICKSEND_MMS_CAMPAIGNS_BY_MMS_CAMPAIGN_ID_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the updated MMS campaign details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable response message (e.g., 'MMS campaign has been updated.')
response_codestring
Response status code (e.g., 'SUCCESS')

Cancel MMS CampaignCLICKSEND_MMS_CAMPAIGNS_CANCEL_BY_MMS_CAMPAIGN_ID_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional response data about the cancelled campaign
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get MMS CampaignsCLICKSEND_MMS_CAMPAIGNS_GETAcción

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.

Parámetros de entrada

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

Parámetros de salida

tointeger
Ending record number
dataobject[]
Array of MMS campaign objects
frominteger
Starting record number
errorstring
Error if any occurred during the execution of the action
totalinteger
Total number of campaigns
per_pageinteger
Number of campaigns per page
last_pageinteger
Last page number
successfulbooleanObligatorio
Whether or not the action execution was successful or not
current_pageinteger
Current page number
next_page_urlstring
URL for next page or null
prev_page_urlstring
URL for previous page or null

Calculate MMS Campaign PriceCLICKSEND_MMS_CAMPAIGNS_PRICE_POSTAcción

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.

Parámetros de entrada

bodystringObligatorio
The body text of the MMS message. Required field.
fromstringObligatorio
The sender phone number in international format with plus sign. Required field.
namestringObligatorio
The name of the MMS campaign. Required field.
list_idintegerObligatorio
The ID of the contact list to send the MMS campaign to. Required field.
subjectstringObligatorio
The subject line of the MMS message. Required field.
media_filestringObligatorio
URL of the media file to be included in the MMS. Must be a publicly accessible URL. Required field.

Parámetros de salida

dataobject
Data model for MMS campaign price calculation details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., SUCCESS)

Send MMS CampaignCLICKSEND_MMS_CAMPAIGNS_SEND_POSTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the created MMS campaign details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Descriptive message (e.g., 'MMS campaign has been created.')
response_codestring
Response status code (e.g., 'SUCCESS')

Export MMS HistoryCLICKSEND_MMS_HISTORY_EXPORT_GETAcción

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

Parámetros de entrada

filenamestringObligatorio
Filename to download MMS history as (e.g., 'mms_history_export.csv')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get MMS HistoryCLICKSEND_MMS_HISTORY_GETAcción

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

Parámetros de entrada

qstring
Custom query string for filtering results. Format: field:value pairs separated by commas (e.g., 'from:+61411111111,status_code:201')
pageinteger
Page number for pagination
limitinteger
Number of records per page
date_tointeger
End date for filtering history as Unix timestamp (seconds since epoch)
date_frominteger
Start date for filtering history as Unix timestamp (seconds since epoch)

Parámetros de salida

dataobject
Data model for MMS history pagination and message data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable response message
response_codestring
Response status code (e.g., 'SUCCESS')

Calculate MMS PriceCLICKSEND_MMS_PRICE_POSTAcción

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.

Parámetros de entrada

messagesobject[]Obligatorio
Array of message objects to calculate price for. Required - at least one message.
media_filestringObligatorio
URL of the media file to send with the MMS (e.g., image URL). Required.

Parámetros de salida

dataobject
Data model for MMS price calculation response.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable response message
response_codestring
Response status code (e.g., 'SUCCESS')

Mark MMS Receipts as ReadCLICKSEND_MMS_RECEIPTS_READ_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional response data (typically null or confirmation message for this endpoint)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Buy Dedicated NumberCLICKSEND_POST_NUMBERS_BUYAcción

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.

Parámetros de entrada

typestringObligatorio
The type of service for the number (e.g., 'sms')
countrystring
Two-character ISO country code (e.g., 'US', 'AU')
dedicated_numberstringObligatorio
The phone number to purchase, including country code (e.g., '+14155551234')
registration_dataobject
Registration information for compliance purposes.

Parámetros de salida

dataobject
Data model for the purchased number details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete Post Return AddressCLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_DELETEAcción

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

Parámetros de entrada

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

Parámetros de salida

datastring
Additional data returned by the API (typically null for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Get Post Return AddressCLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_GETAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for post return address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful retrieval)

Update Post Return AddressCLICKSEND_POST_RETURN_ADDRESSES_BY_RETURN_ADDRESS_ID_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for updated post return address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful update)

Upload FileCLICKSEND_POST_UPLOADSAcción

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.

Parámetros de entrada

contentstringObligatorio
Your base64 encoded file string. The file content should be encoded in base64 format before uploading.
convertstring
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.

Parámetros de salida

dataobject
Data model for upload details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Forgot PasswordCLICKSEND_PUT_FORGOT_PASSWORDAcción

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

Parámetros de entrada

usernamestringObligatorio
Username belonging to the account that needs password recovery. Required field.

Parámetros de salida

dataarray
Additional response data (typically empty array for this endpoint)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome (e.g., 'An email notification has been sent.')
response_codestring
The response code indicating operation status (e.g., SUCCESS)

Forgot UsernameCLICKSEND_PUT_FORGOT_USERNAMEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataarray
Additional response data (typically empty array for this endpoint)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome (e.g., 'An email notification has been sent.')
response_codestring
The response code indicating operation status (e.g., SUCCESS)

Get Recharge PackagesCLICKSEND_RECHARGE_PACKAGES_GETAcción

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.

Parámetros de entrada

countrystring
Country code to filter packages by specific country (e.g., 'US', 'AU', 'GB').

Parámetros de salida

dataobject
Data model for recharge packages response data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Purchase Recharge PackageCLICKSEND_RECHARGE_PURCHASE_BY_PACKAGE_ID_PUTAcción

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

Parámetros de entrada

package_idintegerObligatorio
ID of the recharge package to purchase. Must be a positive integer.

Parámetros de salida

dataobject
Data model for package purchase transaction information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Get Recharge Transaction by IDCLICKSEND_RECHARGE_TRANSACTIONS_BY_TRANSACTION_ID_GETAcción

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.

Parámetros de entrada

transaction_idstringObligatorio
The unique identifier of the recharge transaction to retrieve

Parámetros de salida

dataobject
Data model for recharge transaction details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Get All Recharge TransactionsCLICKSEND_RECHARGE_TRANSACTIONS_GETAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for paginated recharge transactions.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Search Contact ListsCLICKSEND_SEARCH_CONTACTS_LISTS_GETAcción

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

Parámetros de entrada

qstring
Search query string to filter contact lists by name or other attributes
pageinteger
Page number for paginated results. Must be at least 1.
limitinteger
Number of records per page. Must be at least 1.

Parámetros de salida

dataobject
Data model for paginated contact lists search results.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Send Email Verification TokenCLICKSEND_SEND_VERIFICATION_TOKEN_GETAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional data returned by the API (typically null for this operation)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable message confirming verification email has been sent
response_codestring
Response status code (SUCCESS for successful requests)

Cancel SMS CampaignCLICKSEND_SMS_CAMPAIGNS_CANCEL_BY_SMS_CAMPAIGN_ID_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional response data about the cancelled campaign
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Cancel All Scheduled SMSCLICKSEND_SMS_CANCEL_ALL_PUTAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Additional response data about the cancelled SMS messages
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete SMS Delivery Receipt AutomationCLICKSEND_SMS_DELIVERY_RECEIPT_AUTOMATION_DELETEAcción

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

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the SMS delivery receipt automation rule to delete

Parámetros de salida

dataobject[]
Additional data returned by the API (typically empty for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get SMS Delivery Receipt AutomationCLICKSEND_SMS_DELIVERY_RECEIPT_AUTOMATION_GETAcción

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.

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the SMS delivery receipt automation rule to retrieve

Parámetros de salida

dataobject
Data model for SMS receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update SMS Delivery Receipt AutomationCLICKSEND_SMS_DELIVERY_RECEIPT_AUTOMATION_PUTAcción

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

Parámetros de entrada

actionstring
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.
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestring
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Specifies match criteria for the delivery receipt. 0 = match all reports (default: 0).
action_addressstring
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL endpoint for URL action).
receipt_rule_idintegerObligatorio
Unique identifier of the SMS delivery receipt automation rule to update

Parámetros de salida

dataobject
Data model for the updated SMS receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete Email to SMS Stripped String RuleCLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_DELETEAcción

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.

Parámetros de entrada

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

Parámetros de salida

databoolean
Additional data returned by the API (typically a boolean true for successful delete operations, or a list for other responses)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful deletion)

Get Email to SMS Stripped String RuleCLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_GETAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for stripped string rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Email to SMS Stripped String RuleCLICKSEND_SMS_EMAIL_SMS_STRIPPED_STRING_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for stripped string rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful update)

Export SMS HistoryCLICKSEND_SMS_HISTORY_EXPORT_GETAcción

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

Parámetros de entrada

filenamestringObligatorio
Filename to download SMS history as (e.g., 'sms_history_export.csv')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get SMS HistoryCLICKSEND_SMS_HISTORY_GETAcción

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

Parámetros de entrada

qstring
Custom query string for filtering results. Format: field:value pairs separated by commas. Example: 'from:+61411111111,status_code:201' or 'status:Sent'. Available status values: Queued, Completed, Scheduled, WaitApproval, Failed, Cancelled, CancelledAfterReview, Received, Sent
pageinteger
Page number for pagination (minimum: 1)
limitinteger
Number of records per page (minimum: 1)
date_tointeger
End date for filtering history as Unix timestamp (seconds since epoch)
date_frominteger
Start date for filtering history as Unix timestamp (seconds since epoch)

Parámetros de salida

dataobject
Data model for SMS history pagination and message data.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
Human-readable response message
response_codestring
Response status code (e.g., 'SUCCESS')

Delete Inbound SMS AutomationCLICKSEND_SMS_INBOUND_AUTOMATION_DELETEAcción

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

Parámetros de entrada

inbound_rule_idintegerObligatorio
Unique identifier of the inbound SMS automation rule to delete

Parámetros de salida

dataobject[]
Additional data returned by the API (typically empty for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get Inbound SMS AutomationCLICKSEND_SMS_INBOUND_AUTOMATION_GETAcción

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.

Parámetros de entrada

inbound_rule_idintegerObligatorio
Unique identifier of the inbound SMS automation rule to retrieve

Parámetros de salida

dataobject
Data model for inbound SMS automation rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Inbound SMS AutomationCLICKSEND_SMS_INBOUND_AUTOMATION_PUTAcción

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

Parámetros de entrada

actionstringObligatorio
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.
enabledintegerObligatorio
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestringObligatorio
Name of the automation rule to identify it. Helps organize and manage multiple rules.
webhook_typestring
Webhook format type. Valid values: 'post', 'get', or 'json'. Defaults to 'post' if not specified.
action_addressstringObligatorio
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_idintegerObligatorio
Unique identifier of the inbound SMS automation rule to update
dedicated_numberstringObligatorio
The dedicated phone number to apply this rule to. Use '*' to apply the rule to all numbers.
message_search_termstring
Text pattern to match against incoming messages. Can be null for message_search_type=0 (any message).
message_search_typeintegerObligatorio
Message matching logic. 0 = Any message, 1 = starts with, 2 = contains, 3 = does not contain.

Parámetros de salida

dataobject
Data model for the updated inbound SMS rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Mark Inbound SMS as Read by Message IDCLICKSEND_SMS_INBOUND_READ_BY_MESSAGE_ID_PUTAcción

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.

Parámetros de entrada

message_idstringObligatorio
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).

Parámetros de salida

datanull
Data field (deprecated and returns null for this endpoint)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code of the operation (e.g., 'SUCCESS')

Mark Inbound SMS as ReadCLICKSEND_SMS_INBOUND_READ_PUTAcción

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

Parámetros de entrada

date_beforenumber
Optional Unix timestamp. Mark all inbound SMS as read that were received before this timestamp. If not provided, all inbound messages will be marked as read. It's recommended to use the date from the last message in the GET /sms/inbound response.

Parámetros de salida

datainteger
Usually null, or the number of messages marked as read
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Calculate SMS PriceCLICKSEND_SMS_PRICE_POSTAcción

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.

Parámetros de entrada

messagesobject[]Obligatorio
Array of SMS message objects to calculate price for. Required - at least one message.

Parámetros de salida

dataobject
Data model for SMS price calculation response.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response (e.g., 200)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code of the operation (e.g., 'SUCCESS')

Get SMS Receipt by Message IDCLICKSEND_SMS_RECEIPTS_BY_MESSAGE_ID_GETAcción

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.

Parámetros de entrada

message_idstringObligatorio
Unique identifier for the SMS message (UUID format)

Parámetros de salida

dataobject
Data model for SMS receipt details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Mark SMS Delivery Receipts as ReadCLICKSEND_SMS_RECEIPTS_READ_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional data (typically empty for this endpoint)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete SMS TemplateCLICKSEND_SMS_TEMPLATES_BY_TEMPLATE_ID_DELETEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject[]
Additional data returned by the API (typically empty for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Update SMS TemplateCLICKSEND_SMS_TEMPLATES_BY_TEMPLATE_ID_PUTAcción

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

Parámetros de entrada

bodystring
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_idintegerObligatorio
Unique identifier of the SMS template to update. Must be a valid template ID from your account.
template_namestring
The new name for the template. If not provided, the existing name will be retained.

Parámetros de salida

dataobject
Data model for the updated SMS template details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Delete Specific Allowed Email AddressCLICKSEND_SPECIFIC_ALLOWED_EMAIL_ADDRESS_DELETEAcción

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.

Parámetros de entrada

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

Parámetros de salida

datanull
Additional data returned by the API (always null for delete operations)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful deletion)

Get Specific Allowed Email AddressCLICKSEND_SPECIFIC_ALLOWED_EMAIL_ADDRESS_GETAcción

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.

Parámetros de entrada

email_address_idintegerObligatorio
The unique identifier for the specific email address to retrieve

Parámetros de salida

dataobject
Data model for email address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Regenerate Subaccount API KeyCLICKSEND_SUBACCOUNTS_REGEN_API_KEY_BY_SUBACCOUNT_ID_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for regenerated API key information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response status code (SUCCESS for successful regeneration)

Update Account InformationCLICKSEND_UPDATE_ACCOUNTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for account details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Email Delivery Receipt AutomationCLICKSEND_UPDATE_AUTOMATIONS_EMAIL_RECEIPTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the updated email receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Inbound Fax AutomationCLICKSEND_UPDATE_AUTOMATIONS_FAX_INBOUNDAcción

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.

Parámetros de entrada

actionstringObligatorio
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.
enabledintegerObligatorio
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestringObligatorio
Name of the automation rule to identify it. Helps organize and manage multiple rules.
action_addressstringObligatorio
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_idintegerObligatorio
The unique identifier of the inbound rule to update
dedicated_numberstringObligatorio
The dedicated fax number to apply this rule to. Use '*' to apply the rule to all fax numbers.

Parámetros de salida

dataobject
Data model for the updated inbound fax rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Fax Delivery Receipt AutomationCLICKSEND_UPDATE_AUTOMATIONS_FAX_RECEIPTSAcción

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.

Parámetros de entrada

actionstringObligatorio
Determines the response type when rule matches. Supported options: AUTO_REPLY, EMAIL_USER, EMAIL_FIXED, URL, SMS, POLL, GROUP_SMS, MOVE_CONTACT, CREATE_CONTACT.
enabledintegerObligatorio
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestringObligatorio
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeintegerObligatorio
Specifies match criteria for the delivery receipt. 0 = match all reports.
action_addressstringObligatorio
Designates the target destination or endpoint for the triggered action (e.g., URL endpoint or email address).
receipt_rule_idintegerObligatorio
The unique identifier of the receipt rule to update

Parámetros de salida

dataobject
Data model for the updated fax receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Inbound SMS AutomationCLICKSEND_UPDATE_AUTOMATIONS_SMS_INBOUNDAcción

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

Parámetros de entrada

actionstringObligatorio
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.
enabledintegerObligatorio
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestringObligatorio
Name of the automation rule to identify it. Helps organize and manage multiple rules.
webhook_typestring
Webhook format type. Valid values: 'post', 'get', or 'json'. Defaults to 'post' if not specified.
action_addressstringObligatorio
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_idintegerObligatorio
Unique identifier of the inbound SMS automation rule to update
dedicated_numberstringObligatorio
The dedicated phone number to apply this rule to. Use '*' to apply the rule to all numbers.
message_search_termstringObligatorio
Text pattern to match against incoming messages.
message_search_typeintegerObligatorio
Message matching logic. 0 = Any message, 1 = starts with, 2 = contains, 3 = does not contain.

Parámetros de salida

dataobject
Data model for the updated inbound SMS rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update SMS Delivery Receipt AutomationCLICKSEND_UPDATE_AUTOMATIONS_SMS_RECEIPTSAcción

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.

Parámetros de entrada

actionstring
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.
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestring
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Specifies match criteria for the delivery receipt. 0 = match all reports, 3 = specific match type.
action_addressstring
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL for URL action).
receipt_rule_idintegerObligatorio
The unique identifier of the receipt rule to update

Parámetros de salida

dataobject
Data model for the updated SMS receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Voice Delivery Receipt AutomationCLICKSEND_UPDATE_AUTOMATIONS_VOICE_RECEIPTSAcción

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

Parámetros de entrada

actionstring
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, or NONE.
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestring
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Specifies match criteria for the delivery receipt. 0 = match all reports.
action_addressstring
Specifies where the action should be directed (e.g., email address for EMAIL_FIXED action, URL for URL action).
receipt_rule_idintegerObligatorio
The unique identifier of the receipt rule to update

Parámetros de salida

dataobject
Data model for the updated voice receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Contact ListCLICKSEND_UPDATE_LISTSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for updated contact list information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation result
response_codestring
The response code (SUCCESS for successful update)

Update Contact in ListCLICKSEND_UPDATE_LISTS_CONTACTSAcción

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.

Parámetros de entrada

emailstring
Contact's email address. At least one contact method (phone_number, email, or fax_number) must be provided.
list_idintegerObligatorio
The unique identifier of the contact list containing the contact. Must be a valid list ID from your account.
custom_1string
Custom field 1 for additional contact information
custom_2string
Custom field 2 for additional contact information
custom_3string
Custom field 3 for additional contact information
custom_4string
Custom field 4 for additional contact information
last_namestring
Contact's last name
contact_idintegerObligatorio
The unique identifier of the contact to update. Must be a valid contact ID within the specified list.
fax_numberstring
Contact's fax number. At least one contact method (phone_number, email, or fax_number) must be provided.
first_namestring
Contact's first name
address_citystring
City in contact's address
phone_numberstring
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_statestring
State or province in contact's address
address_line_1string
First line of contact's street address
address_line_2string
Second line of contact's address (apartment, suite, etc.)
address_countrystring
Country code in ISO 3166 format (2-letter country code) for contact's address
organization_namestring
Contact's organization or company name
address_postal_codestring
Postal or ZIP code in contact's address

Parámetros de salida

dataobject
Data model for updated contact details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful update)

Get Recharge Credit Card InfoCLICKSEND_UPDATE_RECHARGE_CREDIT_CARDAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Data model for credit card information.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Recharge Credit Card InfoCLICKSEND_UPDATE_RECHARGE_CREDIT_CARD2Acción

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

Parámetros de entrada

cvcintegerObligatorio
CVC security code on the credit card (3 or 4 digits)
namestringObligatorio
Name printed on the credit card
numberstringObligatorio
Credit card number (e.g., '5520000000000000'). ClickSend does not store this, only a token.
bank_namestringObligatorio
Name of the bank that issued the credit card
expiry_yearintegerObligatorio
Credit card expiry year (4-digit format, e.g., 2026)
expiry_monthintegerObligatorio
Credit card expiry month (1-12)

Parámetros de salida

dataobject
Data model for credit card information returned after update.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Reseller SettingsCLICKSEND_UPDATE_RESELLERAcción

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.

Parámetros de entrada

countrystring
Country code to update (e.g., 'US', 'AU')
timezonestring
Account timezone to update (e.g., 'Australia/Melbourne', 'America/New_York')
user_emailstring
Reseller email address to update
user_phonestring
Reseller phone number to update
account_namestring
Reseller account name to update
auto_rechargeinteger
Auto recharge enabled status to update (0 or 1)
user_last_namestring
Reseller last name to update
user_first_namestring
Reseller first name to update
low_credit_amountstring
Low credit threshold to update as decimal string
default_country_smsstring
Default country for SMS to update
setting_unicode_smsinteger
Unicode SMS setting to update (0 or 1)
auto_recharge_amountstring
Auto recharge amount to update as decimal string
account_billing_emailstring
Billing email address to update
setting_fix_sender_idinteger
Fixed sender ID setting to update (0 or 1)
account_billing_mobilestring
Billing mobile number to update
setting_email_sms_subjectinteger
Email SMS subject setting to update (0 or 1)
setting_sms_message_char_limitinteger
SMS character limit setting to update

Parámetros de salida

dataobject
Data model for updated reseller settings.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update SMS CampaignCLICKSEND_UPDATE_SMS_CAMPAIGNSAcción

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

Parámetros de entrada

bodystringObligatorio
The message content for your campaign. This is the SMS text that will be sent to contacts.
fromstring
Your sender ID. This is the sender name or number that recipients will see. See ClickSend sender ID documentation for requirements.
namestringObligatorio
The title assigned to your campaign. This will replace the existing campaign name.
list_idintegerObligatorio
Identifier for your contact list. The contact list that the campaign should use.
scheduleinteger
Unix timestamp for when to send the campaign. Defaults to 0 for immediate sending. Use a future timestamp to schedule the campaign.
url_to_shortenstring
A URL to compress and include in the message. Insert placeholder text in body where the shortened URL should appear.
sms_campaign_idintegerObligatorio
The unique identifier of the SMS campaign to update. Must be a valid campaign ID from your account.

Parámetros de salida

dataobject
Data model for updated SMS campaign details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation (e.g., 'Your SMS Campaign has been updated.')
response_codestring
The response code indicating the status of the operation (e.g., 'SUCCESS')

Update Stripped StringCLICKSEND_UPDATE_SMS_EMAIL_SMS_STRIPPED_STRINGSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for stripped string rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful update)

Update SMS TemplateCLICKSEND_UPDATE_SMS_TEMPLATESAcción

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

Parámetros de entrada

bodystring
The new content/text of the SMS template. If not provided, the current body will remain unchanged.
template_idintegerObligatorio
The unique identifier of the template to update. Must be a valid template ID from your account.
template_namestring
The new name for the SMS template. If not provided, the current name will remain unchanged.

Parámetros de salida

dataobject
Data model for updated SMS template.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A descriptive message about the operation outcome
response_codestring
The response status code indicating operation result (e.g., SUCCESS)

Update SubaccountCLICKSEND_UPDATE_SUBACCOUNTSAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Data model for the updated subaccount details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (SUCCESS for successful update)

Upload FileCLICKSEND_UPLOADS_POSTAcción

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

Parámetros de entrada

contentstringObligatorio
Base64 encoded file content. The file data must be encoded in base64 format before uploading.
filenamestringObligatorio
The name for the uploaded file including the file extension. This will be used to identify the file in the ClickSend system.

Parámetros de salida

dataobject
Data model for upload response details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Agree to User Countries RulesCLICKSEND_USER_COUNTRIES_AGREE_POSTAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

datastring
Response message confirming agreement to rules and regulations
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Get User CountriesCLICKSEND_USER_COUNTRIES_GETAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Data model for user countries list.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Select User CountriesCLICKSEND_USER_COUNTRIES_POSTAcción

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.

Parámetros de entrada

country_list_idsinteger[]Obligatorio
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.

Parámetros de salida

dataobject
Contains the operation result data
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation (e.g., SUCCESS)

Verify Allowed Email AddressCLICKSEND_VERIFY_ALLOWED_EMAIL_ADDRESS_GETAcción

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

Parámetros de entrada

activation_tokenstringObligatorio
The activation/verification token that was sent to the email address
email_address_idintegerObligatorio
The unique identifier for the allowed email address that needs verification

Parámetros de salida

dataobject
Data model for email address details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Verify Forgot PasswordCLICKSEND_VERIFY_FORGOT_PASSWORD_VERIFYAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataarray
Contains the response data. May be an empty array upon successful password update, or may contain user account details
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response (200 for success)
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome (e.g., 'Your password has been updated.')
response_codestring
The response code indicating operation status (e.g., SUCCESS)

Cancel All Scheduled Voice MessagesCLICKSEND_VOICE_CANCEL_ALL_PUTAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject
Additional response data about the cancelled voice messages
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Delete Voice Receipt AutomationCLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_DELETEAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Voice Delivery Receipt AutomationCLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_GETAcción

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.

Parámetros de entrada

receipt_rule_idintegerObligatorio
Unique identifier of the voice delivery receipt automation rule to retrieve

Parámetros de salida

dataobject
Data model for voice receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Update Voice Delivery Receipt AutomationCLICKSEND_VOICE_DELIVERY_RECEIPT_AUTOMATION_PUTAcción

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.

Parámetros de entrada

actionstring
Response action to perform when rule matches (e.g., 'URL' for webhook, 'EMAIL_FIXED' for email notification).
enabledinteger
Controls activation status of the rule. 0 = disabled, 1 = enabled.
rule_namestring
Name to identify the automation rule. Helps organize and manage multiple rules.
match_typeinteger
Determines which delivery statuses trigger the rule. Value 0 = All delivery reports, values 1-3 = Specific status filters.
action_addressstring
Target destination for the action - URL endpoint or email address where delivery receipts will be sent.
receipt_rule_idintegerObligatorio
Unique identifier of the voice delivery receipt automation rule to update

Parámetros de salida

dataobject
Data model for the updated voice receipt rule details.
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation

Export Voice HistoryCLICKSEND_VOICE_HISTORY_EXPORT_GETAcción

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

Parámetros de entrada

filenamestringObligatorio
Filename to download voice history as (e.g., 'voice_history_export.csv')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Mark Voice Delivery Receipts as ReadCLICKSEND_VOICE_RECEIPTS_READ_PUTAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobject
Additional response data (typically null for this endpoint)
errorstring
Error if any occurred during the execution of the action
http_codeinteger
The HTTP status code of the response
successfulbooleanObligatorio
Whether or not the action execution was successful or not
response_msgstring
A message describing the outcome of the operation
response_codestring
The response code indicating the status of the operation