ClickSend REST API v3
  1. Email Marketing
ClickSend REST API v3
  • Account
    • Get account
      GET
    • Create a new account
      POST
    • Update Account
      PUT
    • Send account activation token
      PUT
    • Verify new account
      PUT
    • Account Usage
      GET
  • Automation Rules
    • List Rules
    • Create a New Rule
    • Delete a Rule
    • Get a Specific Rule
    • Update a Rule
    • List rules
    • Create a new rule
    • Delete a rule
    • Get a specific rule
    • Update a rule
    • List Rules
    • Create a New Rule
    • Delete a Rule
    • Get a Specific Rule
    • Update a Rule
    • List rules
    • Create a new rule
    • Delete a rule
    • Get a specific rule
    • Update a rule
    • List rules
    • Create a new rule
    • Delete a rule
    • Get a specific rule
    • Update a rule
    • List rules
    • Create a new rule
    • Delete a rule
    • Get a specific rule
    • Update a rule
  • Contact Suggestions
    • List Contact Suggestions
  • Countries
    • Get all Countries
  • Delivery Issues
    • Get Delivery Issues
    • Create Delivery Issue
  • Email Marketing
    • Get All Email Campaigns
      GET
    • Calculate Price
      POST
    • Create Email Campaign
      POST
    • Get Specific Email Campaign History
      GET
    • Get Specific Email Campaign
      GET
    • Update Email Campaign
      PUT
    • Cancel Email Campaign
      PUT
    • Send Verification Token
      PUT
    • Verify Allowed Email Address
      PUT
    • Get All Allowed Email Addresses
      GET
    • Create Allowed Email Address
      POST
    • Delete Allowed Email Address
      DELETE
    • Get Specific Allowed Email Address
      GET
    • Get All Master Email Templates
      GET
    • Get All Master Template Categories
      GET
    • Get Specific Email Template Category
      GET
    • Get All Templates For Category
      GET
    • Get Specific Master Template
      GET
    • Get All Email Templates
      GET
    • Create New Email Template from Master Template
      POST
    • Upload Image to Specific Template
      POST
    • Delete Email Template
      DELETE
    • Get Specific Email Template
      GET
    • Update an Email Template
      PUT
  • Transactional Email
    • Email History
    • Export History
    • Email Price
    • Add a Test Delivery Receipt
    • Email Send
  • Fax
    • Export Fax History
    • Get Fax History
    • Calculate Price
    • List of Fax Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Fax Delivery Receipts as read
    • Get a Specific Fax Delivery Receipt
    • Send Fax
  • Forgot Account
    • Forgot Password
    • Verify Forgot Password
    • Forgot Username
  • Contact Lists
    • Get all Contact Lists
    • Create a new contact list
    • Delete a specific contact list
    • Get a specific contact list
    • Update a specific contact list
    • Export Contacts List
    • Import Contacts to List
    • Show CSV Import File Preview
    • Get List of Acceptable Import Fields
    • Remove Duplicate Contacts
  • Contacts
    • Transfer a Contact
    • Get all Contacts in a List
    • Create a new contact
    • Delete a specific contact
    • Get a specific contact
    • Update a specific contact
    • Remove Opted Out Contacts
  • MMS
    • Cancel All MMS
    • Export MMS History
    • Get MMS History
    • Get Price
    • Get all Delivery Receipts
    • Mark Receipts As Read
    • Get Delivery Receipt
    • Send MMS
    • Cancel MMS
  • Numbers
    • Get all Dedicated Numbers
    • Buy dedicated number
    • Search Dedicated Numbers by Country
  • Post Direct Mail
    • List Direct Mail Campaigns
    • Calculate Direct Mail Campaign Price
    • Create New Campaign
    • Search Locations
  • Post Address Detection
    • Detect Address
  • Post Letter
    • Get Post Letter History
    • Export Post Letter History
    • Calculate Price
    • Send Post Letter
    • Get List of Post Return Addresses
    • Create a Post Return Address
    • Delete Post Return Address
    • Get Post Return Address
    • Update Post Return Address
  • Postcards
    • Export Postcard History
    • Get Postcard History
    • Calculate Pricing
    • Send Postcard
  • Pricing
    • Get Country Pricing
  • Account Recharge
    • Get Credit Card info
    • Update Credit Card info
    • List of Packages
    • Purchase a Package
    • Get Transactions
    • Get a specific transaction
  • Referral Accounts
    • Get List of Referral Accounts
  • Reseller
    • Get Reseller Setting
    • Update Reseller Setting
    • Reseller By Subdomain
  • Reseller Accounts
    • List of Reseller Accounts
    • Create Reseller Account
    • Create Reseller Account - Public
    • Get Reseller Account
    • Update Reseller Account
    • Transfer Credit
  • SDK
    • SDK Download
  • Search
    • Search Contacts-Lists
  • SMS Campaigns
    • Get list of SMS Campaigns
    • Calculate Price for SMS Campaign
    • Use Short URL
    • Link Tracking Export
    • Link Statistics
    • Link Tracking
    • Get SMS Campaign
    • Update an SMS Campaign
    • Cancel an SMS Campaign
  • SMS
    • Cancel all Scheduled Messages
    • Export SMS History
    • Get all History
    • Get all Inbound SMS - Pull
    • Add a Test Inbound SMS
    • Mark all Inbound SMS as read
    • Mark a specific Inbound SMS as read
    • Get Specific Inbound - Pull
    • Calculate Price
    • Get all Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Delivery Receipts as read
    • Get a Specific Delivery Receipt
    • Send an SMS
    • Cancel a Scheduled Message
  • Email-to-SMS Allowed Address
    • List of Email-to-SMS Allowed Address
    • Create Email to SMS Allowed Address
    • Delete Email-to-SMS Allowed Address
    • Get specific Email-to-SMS Allowed Address
    • Update Email-to-SMS Allowed Address
  • Email-to-SMS Stripped Strings
    • List Stripped Strings
    • Create Stripped String
    • Delete Stripped String
    • Find Specific Stripped String
    • Update Stripped String
  • SMS Templates
    • List of Templates
    • Create a Template
    • Delete a Template
    • Update a Template
  • Statistics
    • Get SMS Statistics
    • Get Voice Statistics
  • Subaccounts
    • Get all Subaccounts
    • Create a new subaccount
    • Delete a specific subaccount
    • Get a specific subaccount
    • Update a specific subaccount
    • Regenerate API Key
  • Timezones
    • Get Timezones
  • Uploads
    • Upload a file
  • Voice
    • Cancel all Voice Calls
    • Export Voice History
    • Get Voice History
    • Voice Languages
    • Calculate Price
    • Get Voice receipts
    • Add a Test Delivery Receipt
    • Marked Voice Receipts as Read
    • Get Specific Voice Receipt
    • Send a Voice Call
    • Cancel a Specific Voice Call
  1. Email Marketing

Create Email Campaign

POST
/email-campaigns/send
Email Marketing
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://rest.clicksend.com/v3/email-campaigns/send' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body": "<p>This is a test</p>",
    "from_email_address_id": 2,
    "from_name": "From name",
    "list_id": 456,
    "name": "John Doe",
    "subject": "Lorem Ipsum",
    "template_id": 31
}'
Response Response Example
{
    "data": {
        "currency": {
            "currency_name_long": "Australian Dollars",
            "currency_name_short": "AUD",
            "currency_prefix_c": "c",
            "currency_prefix_d": "$"
        },
        "data": {
            "abuse_count": 0,
            "body": "<p>This is a test</p>",
            "body_plain_text": "This is a test",
            "click_count": 0,
            "custom_string": "",
            "date_added": "1458011424",
            "email_campaign_id": 69,
            "from_email_address_id": 2,
            "from_name": "From name",
            "hard_bounce_count": 0,
            "list_id": 456,
            "name": "John Doe",
            "open_count": 0,
            "schedule": "",
            "send_count": 0,
            "soft_bounce_count": 0,
            "status": "Queued",
            "subaccount_id": 1038,
            "subject": "Lorem Ipsum",
            "template_id": 31,
            "unsubscribe_count": 0,
            "user_id": 1201
        },
        "queued_count": 2,
        "total_count": 6,
        "total_price": "0.0066"
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Email campaign has been created."
}

Request

Body Params application/json
from_email_address_id
number 
required
The allowed email address id.
from_name
string 
required
The name that will appear on the email.
list_id
number 
required
The list id you want to access.
name
string 
required
The name of the sender.
schedule
number 
optional
Leave blank for immediate delivery. Your schedule time as a unix timestamp.
subject
string 
required
The subject of the email campaign.
template_id
number 
required
The template id you want to use.
Examples

Responses

🟢200OK
application/json
Body
object {0}
Previous
Calculate Price
Next
Get Specific Email Campaign History
Built with