Skip to main content
Server path: /clicksend-sms | Type: Application | PCID required: Yes

Tools

ToolDescription
clicksend_sms_campaign_by_sms_campaign_id_getGet specific sms campaign
clicksend_sms_campaigns_by_sms_campaign_id_putUpdate sms campaign
clicksend_sms_campaigns_cancel_by_sms_campaign_id_putCancel sms campaign
clicksend_sms_campaigns_getGet list of sms campaigns
clicksend_sms_campaigns_price_postCalculate price for sms campaign
clicksend_sms_campaigns_send_postCreate sms campaign
clicksend_sms_cancel_all_putUpdate all scheduled message as cancelled
clicksend_sms_cancel_by_message_id_putUpdate scheduled message as cancelled
clicksend_sms_delivery_receipt_automation_deleteDelete sms delivery receipt automation
clicksend_sms_delivery_receipt_automation_getGet specific sms delivery receipt automation
clicksend_sms_delivery_receipt_automation_postCreate sms delivery receipt automations
clicksend_sms_delivery_receipt_automation_putUpdate sms delivery receipt automation
clicksend_sms_delivery_receipt_automations_getGet all sms delivery receipt automations
clicksend_sms_email_sms_getGet list of email to sms allowed addresses
clicksend_sms_email_sms_postCreate email to sms allowed address
clicksend_sms_email_sms_stripped_string_deleteDelete email to sms stripped string rule
clicksend_sms_email_sms_stripped_string_getGet email to sms stripped string rule
clicksend_sms_email_sms_stripped_string_postCreate email to sms stripped string rule
clicksend_sms_email_sms_stripped_string_putUpdate email to sms stripped string rule
clicksend_sms_email_sms_stripped_strings_getGet list of email to sms stripped string rules
clicksend_sms_history_export_getExport all sms history
clicksend_sms_history_getGet all sms history
clicksend_sms_inbound_automation_deleteDelete inbound sms automation
clicksend_sms_inbound_automation_getGet specific inbound sms automation
clicksend_sms_inbound_automation_postCreate new inbound sms automation
clicksend_sms_inbound_automation_putUpdate inbound sms automation
clicksend_sms_inbound_automations_getGet all inbound sms automations
clicksend_sms_inbound_getGet all inbound sms
clicksend_sms_inbound_postCreate inbound sms
clicksend_sms_inbound_read_by_message_id_putMark inbound SMS as read
clicksend_sms_inbound_read_putMark inbound SMS as read
clicksend_sms_list_countries_getList of countries
clicksend_sms_price_postCalculate sms price
clicksend_sms_receipts_by_message_id_getGet a Specific Delivery Receipt
clicksend_sms_receipts_getGet all delivery receipts
clicksend_sms_receipts_postAdd a delivery receipt
clicksend_sms_receipts_read_putMark delivery receipts as read
clicksend_sms_send_postSend sms message(s)
clicksend_sms_templates_by_template_id_deleteDelete sms template
clicksend_sms_templates_by_template_id_putUpdate sms template
clicksend_sms_templates_getGet lists of all sms templates
clicksend_sms_templates_postCreate sms template
clicksend_sms_user_countries_agree_postAgree to rules and regulation
clicksend_sms_user_countries_getGet Countries for Global Sending
clicksend_sms_user_countries_postSelect Countries for Global Sending

clicksend_sms_campaign_by_sms_campaign_id_get

Get specific sms campaign Parameters:
ParameterTypeRequiredDefaultDescription
sms_campaign_idintegerYesID of SMS campaign to retrieve

clicksend_sms_campaigns_by_sms_campaign_id_put

Update sms campaign Parameters:
ParameterTypeRequiredDefaultDescription
sms_campaign_idintegerYesID of SMS campaign to update
bodystringYesYour campaign message.
fromstringNoYour sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
list_idintegerYesYour list id.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
url_to_shortenstringNourl to be shortened add http://smsg.io/xxxxx` to the body as a placeholder.

clicksend_sms_campaigns_cancel_by_sms_campaign_id_put

Cancel sms campaign Parameters:
ParameterTypeRequiredDefaultDescription
sms_campaign_idintegerYesID of SMS Campaign to cancel

clicksend_sms_campaigns_get

Get list of sms campaigns Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_campaigns_price_post

Calculate price for sms campaign Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesYour campaign message.
fromstringNoYour sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
list_idintegerYesYour list id.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
url_to_shortenstringNourl to be shortened add http://smsg.io/xxxxx` to the body as a placeholder.

clicksend_sms_campaigns_send_post

Create sms campaign Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesYour campaign message.
fromstringNoYour sender id - more info: https://help.clicksend.com/en/collections/57584-numbers-sender-ids.
list_idintegerYesYour list id.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
url_to_shortenstringNourl to be shortened add http://smsg.io/xxxxx` to the body as a placeholder.

clicksend_sms_cancel_all_put

Update all scheduled message as cancelled

clicksend_sms_cancel_by_message_id_put

Update scheduled message as cancelled Parameters:
ParameterTypeRequiredDefaultDescription
message_idstringYesThe message ID you want to cancel

clicksend_sms_delivery_receipt_automation_delete

Delete sms delivery receipt automation Parameters:
ParameterTypeRequiredDefaultDescription
receipt_rule_idintegerYesReceipt rule id

clicksend_sms_delivery_receipt_automation_get

Get specific sms delivery receipt automation Parameters:
ParameterTypeRequiredDefaultDescription
receipt_rule_idintegerYesReceipt rule id

clicksend_sms_delivery_receipt_automation_post

Create sms delivery receipt automations Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesAction to be taken (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).
action_addressstringYesAction address.
enablednumberYesEnabled: Disabled=0 or Enabled=1.
match_typenumberYesMatch Type. 0=All reports.
rule_namestringYesRule Name.

clicksend_sms_delivery_receipt_automation_put

Update sms delivery receipt automation Parameters:
ParameterTypeRequiredDefaultDescription
receipt_rule_idintegerYesReceipt rule id
actionstringYesAction to be taken (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).
action_addressstringYesAction address.
enablednumberYesEnabled: Disabled=0 or Enabled=1.
match_typenumberYesMatch Type. 0=All reports.
rule_namestringYesRule Name.

clicksend_sms_delivery_receipt_automations_get

Get all sms delivery receipt automations Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoYour keyword or query.
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_email_sms_get

Get list of email to sms allowed addresses Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_email_sms_post

Create email to sms allowed address Parameters:
ParameterTypeRequiredDefaultDescription
email_addressstringYesYour email address
fromstringYesYour sender id
subaccount_idstringNoYour subaccount id

clicksend_sms_email_sms_stripped_string_delete

Delete email to sms stripped string rule Parameters:
ParameterTypeRequiredDefaultDescription
rule_idintegerYesYour rule id

clicksend_sms_email_sms_stripped_string_get

Get email to sms stripped string rule Parameters:
ParameterTypeRequiredDefaultDescription
rule_idintegerYesYour rule id

clicksend_sms_email_sms_stripped_string_post

Create email to sms stripped string rule Parameters:
ParameterTypeRequiredDefaultDescription
strip_stringstringYesString to be.

clicksend_sms_email_sms_stripped_string_put

Update email to sms stripped string rule Parameters:
ParameterTypeRequiredDefaultDescription
rule_idintegerYesYour rule id
strip_stringstringYesString to be.

clicksend_sms_email_sms_stripped_strings_get

Get list of email to sms stripped string rules Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_history_export_get

Export all sms history Parameters:
ParameterTypeRequiredDefaultDescription
filenamestringYesFilename to download history as

clicksend_sms_history_get

Get all sms history Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoCustom query Example: from:{number},status_code:201.
date_fromintegerNoStart date
date_tointegerNoEnd date
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_inbound_automation_delete

Delete inbound sms automation Parameters:
ParameterTypeRequiredDefaultDescription
inbound_rule_idintegerYesInbound rule id

clicksend_sms_inbound_automation_get

Get specific inbound sms automation Parameters:
ParameterTypeRequiredDefaultDescription
inbound_rule_idintegerYesInbound rule id

clicksend_sms_inbound_automation_post

Create new inbound sms automation Parameters:
ParameterTypeRequiredDefaultDescription
actionstringYesAction to be taken (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).
action_addressstringYesAction address.
dedicated_numberstringYesDedicated Number. Can be ’*’ to apply to all numbers.
enablednumberYesEnabled: Disabled=0 or Enabled=1.
message_search_termstringYesMessage search term.
message_search_typenumberYesMessage Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.
rule_namestringYesRule Name.
webhook_typestringNopost, get, or json. post by default

clicksend_sms_inbound_automation_put

Update inbound sms automation Parameters:
ParameterTypeRequiredDefaultDescription
inbound_rule_idintegerYesInbound rule id
actionstringYesAction to be taken (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).
action_addressstringYesAction address.
dedicated_numberstringYesDedicated Number. Can be ’*’ to apply to all numbers.
enablednumberYesEnabled: Disabled=0 or Enabled=1.
message_search_termstringYesMessage search term.
message_search_typenumberYesMessage Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.
rule_namestringYesRule Name.
webhook_typestringNopost, get, or json. post by default

clicksend_sms_inbound_automations_get

Get all inbound sms automations Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoYour keyword or query.
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_inbound_get

Get all inbound sms Parameters:
ParameterTypeRequiredDefaultDescription
qstringNoYour keyword or query.
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_inbound_post

Create inbound sms Parameters:
ParameterTypeRequiredDefaultDescription
urlstringYesYour url.

clicksend_sms_inbound_read_by_message_id_put

Mark inbound SMS as read Parameters:
ParameterTypeRequiredDefaultDescription
message_idstringYesMessage ID

clicksend_sms_inbound_read_put

Mark inbound SMS as read Parameters:
ParameterTypeRequiredDefaultDescription
date_beforenumberNoAn optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read.

clicksend_sms_list_countries_get

List of countries

clicksend_sms_price_post

Calculate sms price Parameters:
ParameterTypeRequiredDefaultDescription
messagesobject[]YesArray of SmsMessage items

clicksend_sms_receipts_by_message_id_get

Get a Specific Delivery Receipt Parameters:
ParameterTypeRequiredDefaultDescription
message_idstringYesMessage ID

clicksend_sms_receipts_get

Get all delivery receipts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_receipts_post

Add a delivery receipt Parameters:
ParameterTypeRequiredDefaultDescription
urlstringYesYour url.

clicksend_sms_receipts_read_put

Mark delivery receipts as read Parameters:
ParameterTypeRequiredDefaultDescription
date_beforenumberNoAn optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read.

clicksend_sms_send_post

Send sms message(s) Parameters:
ParameterTypeRequiredDefaultDescription
messagesobject[]YesArray of SmsMessage items

clicksend_sms_templates_by_template_id_delete

Delete sms template Parameters:
ParameterTypeRequiredDefaultDescription
template_idintegerYesTemplate id

clicksend_sms_templates_by_template_id_put

Update sms template Parameters:
ParameterTypeRequiredDefaultDescription
template_idintegerYesTemplate id
bodystringYesBody of template
template_namestringYesName of template

clicksend_sms_templates_get

Get lists of all sms templates Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_sms_templates_post

Create sms template Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesBody of template
template_namestringYesName of template

clicksend_sms_user_countries_agree_post

Agree to rules and regulation

clicksend_sms_user_countries_get

Get Countries for Global Sending

clicksend_sms_user_countries_post

Select Countries for Global Sending Parameters:
ParameterTypeRequiredDefaultDescription
country_list_idsinteger[]YesArray of country ids