/clicksend-email | Type: Application | PCID required: Yes
Tools
clicksend_email_allowed_email_address_get
Get all email addresses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_allowed_email_address_post
Create allowed Email Address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address | string | Yes | — | Email to be allowed. |
clicksend_email_campaign_get
Get specific email campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_campaign_id | integer | Yes | — | Allowed email campaign id |
clicksend_email_campaign_history_export_get
Export specific email campaign history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_campaign_id | integer | Yes | — | Allowed email campaign id |
date_from | integer | No | — | Start date |
date_to | integer | No | — | End date |
clicksend_email_campaign_history_get
Get specific email campaign history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_campaign_id | integer | Yes | — | Allowed email campaign id |
date_from | integer | No | — | Start date |
date_to | integer | No | — | End date |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_campaign_post
Send email campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | Yes | — | Your campaign message. |
from_email_address_id | number | Yes | — | The allowed email address id. |
from_name | string | Yes | — | Your name or business name. |
list_id | number | Yes | — | Your contact list id. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
subject | string | Yes | — | Your campaign subject. |
template_id | number | No | — | Your template id. |
clicksend_email_campaign_price_post
Calculate email campaign price Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | Yes | — | Your campaign message. |
from_email_address_id | number | Yes | — | The allowed email address id. |
from_name | string | Yes | — | Your name or business name. |
list_id | number | Yes | — | Your contact list id. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
subject | string | Yes | — | Your campaign subject. |
template_id | number | No | — | Your template id. |
clicksend_email_campaign_put
Edit email campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_campaign_id | integer | Yes | — | Allowed email campaign id |
body | string | Yes | — | Your campaign message. |
from_email_address_id | number | Yes | — | The allowed email address id. |
from_name | string | Yes | — | Your name or business name. |
list_id | number | Yes | — | Your contact list id. |
name | string | Yes | — | Your campaign name. |
schedule | integer | No | — | Your schedule timestamp. |
subject | string | Yes | — | Your campaign subject. |
template_id | number | No | — | Your template id. |
clicksend_email_campaigns_get
Get all email campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_cancel_email_campaign_put
Cancel email campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_campaign_id | integer | Yes | — | Allowed email campaign id |
clicksend_email_delivery_receipt_automation_delete
Delete email delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
clicksend_email_delivery_receipt_automation_get
Get specific email delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
clicksend_email_delivery_receipt_automation_post
Create email delivery receipt automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | Yes | — | Action 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_address | string | Yes | — | Action address. |
enabled | number | Yes | — | Enabled: Disabled=0 or Enabled=1. |
match_type | number | Yes | — | Match Type. 0=All reports. |
rule_name | string | Yes | — | Rule Name. |
clicksend_email_delivery_receipt_automation_put
Update email delivery receipt automation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
receipt_rule_id | integer | Yes | — | Receipt rule id |
action | string | Yes | — | Action 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_address | string | Yes | — | Action address. |
enabled | number | Yes | — | Enabled: Disabled=0 or Enabled=1. |
match_type | number | Yes | — | Match Type. 0=All reports. |
rule_name | string | Yes | — | Rule Name. |
clicksend_email_delivery_receipt_automations_get
Get all email delivery receipt automations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | No | — | Your keyword or query. |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_history_export_get
Export all Transactional Email history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | Yes | — | Filename to download history as |
date_from | integer | No | — | Start date |
date_to | integer | No | — | End date |
clicksend_email_history_get
Get all transactional email history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date_from | integer | No | — | Start date |
date_to | integer | No | — | End date |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_master_email_template_categories_get
Get all master email template categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_master_email_template_category_get
Get specific master email template category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | integer | Yes | — | Email category id |
clicksend_email_master_email_template_get
Get specific master email template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | integer | Yes | — | Email template id |
clicksend_email_master_email_templates_get
Get all master email templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_master_email_templates_in_category_get
Get all master email templates in a category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category_id | integer | Yes | — | Email category id |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_price_post
Get transactional email price Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attachments | object[] | No | — | Array of Attachment items. |
bcc | object[] | No | — | Array of Bcc Recipient items. |
body | string | Yes | — | Body of the email. |
cc | object[] | No | — | Array of Cc Recipient items. |
from | object | Yes | — | From Email object. |
schedule | number | No | — | Schedule. |
subject | string | No | — | Subject of the email. |
to | object[] | Yes | — | Array of To Recipient items. |
clicksend_email_send_post
Send transactional email Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attachments | object[] | No | — | Array of Attachment items. |
bcc | object[] | No | — | Array of Bcc Recipient items. |
body | string | Yes | — | Body of the email. |
cc | object[] | No | — | Array of Cc Recipient items. |
from | object | Yes | — | From Email object. |
schedule | number | No | — | Schedule. |
subject | string | No | — | Subject of the email. |
to | object[] | Yes | — | Array of To Recipient items. |
clicksend_email_send_verification_token_get
Send verification token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address_id | integer | Yes | — | Allowed email address id |
clicksend_email_specific_allowed_email_address_delete
Delete specific email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address_id | integer | Yes | — | Allowed email address id |
clicksend_email_specific_allowed_email_address_get
Get specific email address Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address_id | integer | Yes | — | Allowed email address id |
clicksend_email_template_delete
Delete user email template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | integer | Yes | — | Email template id |
clicksend_email_template_get
Get specific user email template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | integer | Yes | — | Email template id |
clicksend_email_template_post
Create email template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id_master | number | Yes | — | The ID of the master template you want to base on. |
template_name | string | Yes | — | The intended name for the new template. |
clicksend_email_template_put
Update email template Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | integer | Yes | — | Email template id |
body | string | Yes | — | Your template body. |
template_name | string | No | — | The intended name for the template. |
clicksend_email_templates_get
Get all user email templates Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_email_verify_allowed_email_address_get
Verify email address using verification token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email_address_id | integer | Yes | — | Allowed email address id |
activation_token | string | Yes | — | Your activation token. |

