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

Tools

ToolDescription
clicksend_email_allowed_email_address_getGet all email addresses
clicksend_email_allowed_email_address_postCreate allowed Email Address
clicksend_email_campaign_getGet specific email campaign
clicksend_email_campaign_history_export_getExport specific email campaign history
clicksend_email_campaign_history_getGet specific email campaign history
clicksend_email_campaign_postSend email campaign
clicksend_email_campaign_price_postCalculate email campaign price
clicksend_email_campaign_putEdit email campaign
clicksend_email_campaigns_getGet all email campaigns
clicksend_email_cancel_email_campaign_putCancel email campaign
clicksend_email_delivery_receipt_automation_deleteDelete email delivery receipt automation
clicksend_email_delivery_receipt_automation_getGet specific email delivery receipt automation
clicksend_email_delivery_receipt_automation_postCreate email delivery receipt automations
clicksend_email_delivery_receipt_automation_putUpdate email delivery receipt automation
clicksend_email_delivery_receipt_automations_getGet all email delivery receipt automations
clicksend_email_history_export_getExport all Transactional Email history
clicksend_email_history_getGet all transactional email history
clicksend_email_master_email_template_categories_getGet all master email template categories
clicksend_email_master_email_template_category_getGet specific master email template category
clicksend_email_master_email_template_getGet specific master email template
clicksend_email_master_email_templates_getGet all master email templates
clicksend_email_master_email_templates_in_category_getGet all master email templates in a category
clicksend_email_price_postGet transactional email price
clicksend_email_send_postSend transactional email
clicksend_email_send_verification_token_getSend verification token
clicksend_email_specific_allowed_email_address_deleteDelete specific email address
clicksend_email_specific_allowed_email_address_getGet specific email address
clicksend_email_template_deleteDelete user email template
clicksend_email_template_getGet specific user email template
clicksend_email_template_postCreate email template
clicksend_email_template_putUpdate email template
clicksend_email_templates_getGet all user email templates
clicksend_email_verify_allowed_email_address_getVerify email address using verification token

clicksend_email_allowed_email_address_get

Get all email addresses Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_allowed_email_address_post

Create allowed Email Address Parameters:
ParameterTypeRequiredDefaultDescription
email_addressstringYesEmail to be allowed.

clicksend_email_campaign_get

Get specific email campaign Parameters:
ParameterTypeRequiredDefaultDescription
email_campaign_idintegerYesAllowed email campaign id

clicksend_email_campaign_history_export_get

Export specific email campaign history Parameters:
ParameterTypeRequiredDefaultDescription
email_campaign_idintegerYesAllowed email campaign id
date_fromintegerNoStart date
date_tointegerNoEnd date

clicksend_email_campaign_history_get

Get specific email campaign history Parameters:
ParameterTypeRequiredDefaultDescription
email_campaign_idintegerYesAllowed email campaign id
date_fromintegerNoStart date
date_tointegerNoEnd date
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_campaign_post

Send email campaign Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesYour campaign message.
from_email_address_idnumberYesThe allowed email address id.
from_namestringYesYour name or business name.
list_idnumberYesYour contact list id.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
subjectstringYesYour campaign subject.
template_idnumberNoYour template id.

clicksend_email_campaign_price_post

Calculate email campaign price Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesYour campaign message.
from_email_address_idnumberYesThe allowed email address id.
from_namestringYesYour name or business name.
list_idnumberYesYour contact list id.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
subjectstringYesYour campaign subject.
template_idnumberNoYour template id.

clicksend_email_campaign_put

Edit email campaign Parameters:
ParameterTypeRequiredDefaultDescription
email_campaign_idintegerYesAllowed email campaign id
bodystringYesYour campaign message.
from_email_address_idnumberYesThe allowed email address id.
from_namestringYesYour name or business name.
list_idnumberYesYour contact list id.
namestringYesYour campaign name.
scheduleintegerNoYour schedule timestamp.
subjectstringYesYour campaign subject.
template_idnumberNoYour template id.

clicksend_email_campaigns_get

Get all email campaigns Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_cancel_email_campaign_put

Cancel email campaign Parameters:
ParameterTypeRequiredDefaultDescription
email_campaign_idintegerYesAllowed email campaign id

clicksend_email_delivery_receipt_automation_delete

Delete email delivery receipt automation Parameters:
ParameterTypeRequiredDefaultDescription
receipt_rule_idintegerYesReceipt rule id

clicksend_email_delivery_receipt_automation_get

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

clicksend_email_delivery_receipt_automation_post

Create email 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_email_delivery_receipt_automation_put

Update email 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_email_delivery_receipt_automations_get

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

clicksend_email_history_export_get

Export all Transactional Email history Parameters:
ParameterTypeRequiredDefaultDescription
filenamestringYesFilename to download history as
date_fromintegerNoStart date
date_tointegerNoEnd date

clicksend_email_history_get

Get all transactional email history Parameters:
ParameterTypeRequiredDefaultDescription
date_fromintegerNoStart date
date_tointegerNoEnd date
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_master_email_template_categories_get

Get all master email template categories Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_master_email_template_category_get

Get specific master email template category Parameters:
ParameterTypeRequiredDefaultDescription
category_idintegerYesEmail category id

clicksend_email_master_email_template_get

Get specific master email template Parameters:
ParameterTypeRequiredDefaultDescription
template_idintegerYesEmail template id

clicksend_email_master_email_templates_get

Get all master email templates Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_master_email_templates_in_category_get

Get all master email templates in a category Parameters:
ParameterTypeRequiredDefaultDescription
category_idintegerYesEmail category id
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_price_post

Get transactional email price Parameters:
ParameterTypeRequiredDefaultDescription
attachmentsobject[]NoArray of Attachment items.
bccobject[]NoArray of Bcc Recipient items.
bodystringYesBody of the email.
ccobject[]NoArray of Cc Recipient items.
fromobjectYesFrom Email object.
schedulenumberNoSchedule.
subjectstringNoSubject of the email.
toobject[]YesArray of To Recipient items.

clicksend_email_send_post

Send transactional email Parameters:
ParameterTypeRequiredDefaultDescription
attachmentsobject[]NoArray of Attachment items.
bccobject[]NoArray of Bcc Recipient items.
bodystringYesBody of the email.
ccobject[]NoArray of Cc Recipient items.
fromobjectYesFrom Email object.
schedulenumberNoSchedule.
subjectstringNoSubject of the email.
toobject[]YesArray of To Recipient items.

clicksend_email_send_verification_token_get

Send verification token Parameters:
ParameterTypeRequiredDefaultDescription
email_address_idintegerYesAllowed email address id

clicksend_email_specific_allowed_email_address_delete

Delete specific email address Parameters:
ParameterTypeRequiredDefaultDescription
email_address_idintegerYesAllowed email address id

clicksend_email_specific_allowed_email_address_get

Get specific email address Parameters:
ParameterTypeRequiredDefaultDescription
email_address_idintegerYesAllowed email address id

clicksend_email_template_delete

Delete user email template Parameters:
ParameterTypeRequiredDefaultDescription
template_idintegerYesEmail template id

clicksend_email_template_get

Get specific user email template Parameters:
ParameterTypeRequiredDefaultDescription
template_idintegerYesEmail template id

clicksend_email_template_post

Create email template Parameters:
ParameterTypeRequiredDefaultDescription
template_id_masternumberYesThe ID of the master template you want to base on.
template_namestringYesThe intended name for the new template.

clicksend_email_template_put

Update email template Parameters:
ParameterTypeRequiredDefaultDescription
template_idintegerYesEmail template id
bodystringYesYour template body.
template_namestringNoThe intended name for the template.

clicksend_email_templates_get

Get all user email templates Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_email_verify_allowed_email_address_get

Verify email address using verification token Parameters:
ParameterTypeRequiredDefaultDescription
email_address_idintegerYesAllowed email address id
activation_tokenstringYesYour activation token.