This is the official API documentation for ClickSend.com Below you will find a current list of the available methods for clicksend. **NOTE**: You will need to create a free account to use the API. You can [**Register Here**](https://dashboard.clicksend.com/#/signup/step1/). # API URL The API should always be accessed over SSL. Base URL: `https://rest.clicksend.com/v3/` # Authentication Basic HTTP authentication should be used in the header. **Either:** `username`: Your API username `password`: Your API key ``` You can get your API credentials by clicking 'API Credentials' on the top right of the dashboard. ``` **OR** `username`: Your account username `password`: Your account password ``` These are the same credentials that you use to login to the dashboard. ``` ### Authorization Header The Authorization header is constructed as follows: 1. Username and password are combined into a string `username:password` 1. The resulting string is then encoded using Base64 encoding
https://rest.clicksend.com/v3205 endpoints available
/listsGet all Contact Lists
/listsCreate a new contact list
/accountGet account
/accountUpdate Account
/accountCreate a new account
/numbersGet all Dedicated Numbers
/fax/sendSend Fax
/mms/sendSend MMS
/resellerGet Reseller Setting
/resellerUpdate Reseller Setting
/sms/sendSend an SMS
/countriesGet all Countries
/fax/priceCalculate Price
/mms/priceGet Price
/sms/priceCalculate Price
/timezonesGet Timezones
/email/sendEmail Send
/voice/langVoice Languages
/voice/sendSend a Voice Call
/email/priceEmail Price
/sms/inboundGet all Inbound SMS - Pull
/sms/inboundAdd a Test Inbound SMS
/subaccountsGet all Subaccounts
/subaccountsCreate a new subaccount
/voice/priceCalculate Price
/fax/receiptsList of Fax Delivery Receipts
/fax/receiptsAdd a Test Delivery Receipt
/mms/receiptsGet all Delivery Receipts
/sms/receiptsGet all Delivery Receipts
/sms/receiptsAdd a Test Delivery Receipt
/email/historyEmail History
/sms-campaignsGet list of SMS Campaigns
/sms/email-smsList of Email-to-SMS Allowed Address
/sms/email-smsCreate Email to SMS Allowed Address
/sms/templatesList of Templates
/sms/templatesCreate a Template
/email/receiptsAdd a Test Delivery Receipt
/mms/cancel-allCancel All MMS
/sms/cancel-allCancel all Scheduled Messages
/statistics/smsGet SMS Statistics
/voice/receiptsGet Voice receipts
/voice/receiptsAdd a Test Delivery Receipt
/delivery-issuesGet Delivery Issues
/delivery-issuesCreate Delivery Issue
/email-campaignsGet All Email Campaigns
/email/addressesGet All Allowed Email Addresses
/email/addressesCreate Allowed Email Address
/email/templatesGet All Email Templates
/email/templatesCreate New Email Template from Master Template
/forgot-passwordForgot Password
/forgot-usernameForgot Username
/lists/{list_id}Get a specific contact list
/lists/{list_id}Update a specific contact list
/lists/{list_id}Delete a specific contact list
/sms/inbound-readMark all Inbound SMS as read
/statistics/voiceGet Voice Statistics
/voice/cancel-allCancel all Voice Calls
/fax/receipts-readMark Fax Delivery Receipts as read
/mms/receipts-readMark Receipts As Read
/post/letters/sendSend Post Letter
/referral/accountsGet List of Referral Accounts
/reseller/accountsList of Reseller Accounts
/reseller/accountsCreate Reseller Account
/sms/receipts-readMark Delivery Receipts as read
/post/letters/priceCalculate Price
/sms-campaigns/sendUse Short URL
/account-verify/sendSend account activation token
/contact-suggestionsList Contact Suggestions
/post/postcards/sendSend Postcard
/sdk-download/{type}SDK Download
/sms-campaigns/priceCalculate Price for SMS Campaign
/email-campaigns/sendCreate Email Campaign
/post/letters/historyGet Post Letter History
/post/postcards/priceCalculate Pricing
/recharge/credit-cardGet Credit Card info
/recharge/credit-cardUpdate Credit Card info
/reseller/{subdomain}Reseller By Subdomain
/email-campaigns/priceCalculate Price
/post/return-addressesGet List of Post Return Addresses
/post/return-addressesCreate a Post Return Address
/recharge/transactionsGet Transactions
/email/master-templatesGet All Master Email Templates
/forgot-password/verifyVerify Forgot Password
/lists/{list_id}/importImport Contacts to List
/post/postcards/historyGet Postcard History
/automations/fax/inboundList rules
/automations/fax/inboundCreate a new rule
/automations/sms/inboundList rules
/mms/{message_id}/cancelCancel MMS
/sms/{message_id}/cancelCancel a Scheduled Message
/automations/fax/receiptsList Rules
/automations/fax/receiptsCreate a New Rule
/automations/sms/inbound/Create a new rule
/automations/sms/receiptsList rules
/automations/sms/receiptsCreate a new rule
/lists/{list_id}/contactsGet all Contacts in a List
/lists/{list_id}/contactsCreate a new contact
/reseller/accounts-publicCreate Reseller Account - Public
/reseller/transfer-creditTransfer Credit
/automations/email/receiptList Rules
/automations/email/receiptCreate a New Rule
/fax/receipts/{message_id}Get a Specific Fax Delivery Receipt
/mms/receipts/{message_id}Get Delivery Receipt
/sms/receipts/{message_id}Get a Specific Delivery Receipt
/uploads?convert={convert}Upload a file
/voice/{message_id}/cancelCancel a Specific Voice Call
/automations/voice/receiptsList rules
/automations/voice/receiptsCreate a new rule
/post/direct-mail/campaignsList Direct Mail Campaigns
/post/letters/detect-addressDetect Address
/search/contacts-lists?q={q}Search Contacts-Lists
/sms/templates/{template_id}Update a Template
/sms/templates/{template_id}Delete a Template
/subaccounts/{subaccount_id}Get a specific subaccount
/subaccounts/{subaccount_id}Update a specific subaccount
/subaccounts/{subaccount_id}Delete a specific subaccount
/voice/receipts/{message_id}Get Specific Voice Receipt
/email/templates/{template_id}Get Specific Email Template
/email/templates/{template_id}Update an Email Template
/email/templates/{template_id}Delete Email Template
/lists/{list_id}/import-fieldsGet List of Acceptable Import Fields
/sms/inbound-read/{message_id}Mark a specific Inbound SMS as read
/numbers/buy/{dedicated_number}Buy dedicated number
/recharge/purchase/{package_id}Purchase a Package
/sms/email-sms-stripped-stringsList Stripped Strings
/sms/email-sms-stripped-stringsCreate Stripped String
/post/direct-mail/campaigns/sendCreate New Campaign
/sms-campaigns/{sms_campaign_id}Get SMS Campaign
/sms-campaigns/{sms_campaign_id}Update an SMS Campaign
/post/direct-mail/campaigns/priceCalculate Direct Mail Campaign Price
/sms/email-sms/{email_address_id}Get specific Email-to-SMS Allowed Address
/sms/email-sms/{email_address_id}Update Email-to-SMS Allowed Address
/sms/email-sms/{email_address_id}Delete Email-to-SMS Allowed Address
/email/master-templates-categoriesGet All Master Template Categories
/lists/{list_id}/remove-duplicatesRemove Duplicate Contacts
/sms/inbound/{outbound_message_id}Get Specific Inbound - Pull
/automations/fax/receipts/{rule_id}Get a Specific Rule
/automations/fax/receipts/{rule_id}Update a Rule
/automations/fax/receipts/{rule_id}Delete a Rule
/email/addresses/{email_address_id}Get Specific Allowed Email Address
/email/addresses/{email_address_id}Delete Allowed Email Address
/lists/{list_id}/import-csv-previewShow CSV Import File Preview
/reseller/accounts/{client_user_id}Get Reseller Account
/reseller/accounts/{client_user_id}Update Reseller Account
/account/usage/{year}/{month}/{type}Account Usage
/automations/email/receipt/{rule_id}Get a Specific Rule
/automations/email/receipt/{rule_id}Update a Rule
/automations/email/receipt/{rule_id}Delete a Rule
/email-campaigns/{email_campaign_id}Get Specific Email Campaign
/email-campaigns/{email_campaign_id}Update Email Campaign
/recharge/packages?country={country}List of Packages
/email/master-templates/{template_id}Get Specific Master Template
/email/templates-images/{template_id}Upload Image to Specific Template
/email-campaigns/{campaign_id}/historyGet Specific Email Campaign History
/lists/{list_id}/contacts/{contact_id}Get a specific contact
/lists/{list_id}/contacts/{contact_id}Update a specific contact
/lists/{list_id}/contacts/{contact_id}Delete a specific contact
/pricing/{country}?currency={currency}Get Country Pricing
/fax/history/export?filename={filename}Export Fax History
/mms/history/export?filename={filename}Export MMS History
/recharge/transactions/{transaction_id}Get a specific transaction
/sms-campaigns/{sms_campaign_id}/cancelCancel an SMS Campaign
/sms/history/export?filename={filename}Export SMS History
/account-verify/verify/{activation_token}Verify new account
/email/history/export?filename={filename}Export History
/sms/email-sms-stripped-strings/{rule_id}Find Specific Stripped String
/sms/email-sms-stripped-strings/{rule_id}Update Stripped String
/sms/email-sms-stripped-strings/{rule_id}Delete Stripped String
/voice/history/export?filename={filename}Export Voice History
/automations/fax/inbound/{inbound_rule_id}Get a specific rule
/automations/fax/inbound/{inbound_rule_id}Update a rule
/automations/fax/inbound/{inbound_rule_id}Delete a rule
/automations/sms/inbound/{inbound_rule_id}Get a specific rule
/automations/sms/inbound/{inbound_rule_id}Update a rule
/automations/sms/inbound/{inbound_rule_id}Delete a rule
/post/postcards/export?filename={filename}Export Postcard History
/post/return-addresses/{return_address_id}Get Post Return Address
/post/return-addresses/{return_address_id}Update Post Return Address
/post/return-addresses/{return_address_id}Delete Post Return Address
/sms-campaigns/{campaign_id}/link-trackingLink Tracking
/subaccounts/{subaccount_id}/regen-api-keyRegenerate API Key
/automations/sms/receipts/{receipt_rule_id}Get a specific rule
/automations/sms/receipts/{receipt_rule_id}Update a rule
/automations/sms/receipts/{receipt_rule_id}Delete a rule
/email-campaigns/{email_campaign_id}/cancelCancel Email Campaign
/lists/{list_id}/export?filename={filename}Export Contacts List
/sms-campaigns/{campaign_id}/link-statisticsLink Statistics
/automations/voice/receipts/{receipt_rule_id}Get a specific rule
/automations/voice/receipts/{receipt_rule_id}Update a rule
/automations/voice/receipts/{receipt_rule_id}Delete a rule
/email/address-verify/{email_address_id}/sendSend Verification Token
/voice/receipts-read?date_before={date_before}Marked Voice Receipts as Read
/email/master-templates-categories/{category_id}Get Specific Email Template Category
/post/letters/history/export?filename={filename}Export Post Letter History
/numbers/search/{country}?{search}=1&{search_type}=2Search Dedicated Numbers by Country
/sms/history?date_from={date_from}&date_to={date_to}Get all History
/voice/history?date_from={date_from}&date_to={date_to}Get Voice History
/post/direct-mail/locations/search/{country}/?q={query}Search Locations
/lists/{from_list_id}/contacts/{contact_id}/{to_list_id}Transfer a Contact
/lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id}Remove Opted Out Contacts
/sms-campaigns/{campaign_id}/link-export?filename={filename}Link Tracking Export
/email/master-templates-categories/{category_id}/master-templatesGet All Templates For Category
/email/address-verify/{email_address_id}/verify/{activation_token}Verify Allowed Email Address
/fax/history?date_from={date_from}&date_to={date_to}&q={q}&order_by={order_by}Get Fax History
/mms/history?q={q}&order_by={order_by}&date_from={date_from}&date_to={date_to}Get MMS History
This is the official API documentation for ClickSend.com Below you will find a current list of the available methods for clicksend. **NOTE**: You will need to create a free account to use the API. You can [**Register Here**](https://dashboard.clicksend.com/#/signup/step1/). # API URL The API should always be accessed over SSL. Base URL: `https://rest.clicksend.com/v3/` # Authentication Basic HTTP authentication should be used in the header. **Either:** `username`: Your API username `password`: Your API key ``` You can get your API credentials by clicking 'API Credentials' on the top right of the dashboard. ``` **OR** `username`: Your account username `password`: Your account password ``` These are the same credentials that you use to login to the dashboard. ``` ### Authorization Header The Authorization header is constructed as follows: 1. Username and password are combined into a string `username:password` 1. The resulting string is then encoded using Base64 encoding
https://rest.clicksend.com/v3205 endpoints available
/listsGet all Contact Lists
/listsCreate a new contact list
/accountGet account
/accountUpdate Account
/accountCreate a new account
/numbersGet all Dedicated Numbers
/fax/sendSend Fax
/mms/sendSend MMS
/resellerGet Reseller Setting
/resellerUpdate Reseller Setting
/sms/sendSend an SMS
/countriesGet all Countries
/fax/priceCalculate Price
/mms/priceGet Price
/sms/priceCalculate Price
/timezonesGet Timezones
/email/sendEmail Send
/voice/langVoice Languages
/voice/sendSend a Voice Call
/email/priceEmail Price
/sms/inboundGet all Inbound SMS - Pull
/sms/inboundAdd a Test Inbound SMS
/subaccountsGet all Subaccounts
/subaccountsCreate a new subaccount
/voice/priceCalculate Price
/fax/receiptsList of Fax Delivery Receipts
/fax/receiptsAdd a Test Delivery Receipt
/mms/receiptsGet all Delivery Receipts
/sms/receiptsGet all Delivery Receipts
/sms/receiptsAdd a Test Delivery Receipt
/email/historyEmail History
/sms-campaignsGet list of SMS Campaigns
/sms/email-smsList of Email-to-SMS Allowed Address
/sms/email-smsCreate Email to SMS Allowed Address
/sms/templatesList of Templates
/sms/templatesCreate a Template
/email/receiptsAdd a Test Delivery Receipt
/mms/cancel-allCancel All MMS
/sms/cancel-allCancel all Scheduled Messages
/statistics/smsGet SMS Statistics
/voice/receiptsGet Voice receipts
/voice/receiptsAdd a Test Delivery Receipt
/delivery-issuesGet Delivery Issues
/delivery-issuesCreate Delivery Issue
/email-campaignsGet All Email Campaigns
/email/addressesGet All Allowed Email Addresses
/email/addressesCreate Allowed Email Address
/email/templatesGet All Email Templates
/email/templatesCreate New Email Template from Master Template
/forgot-passwordForgot Password
/forgot-usernameForgot Username
/lists/{list_id}Get a specific contact list
/lists/{list_id}Update a specific contact list
/lists/{list_id}Delete a specific contact list
/sms/inbound-readMark all Inbound SMS as read
/statistics/voiceGet Voice Statistics
/voice/cancel-allCancel all Voice Calls
/fax/receipts-readMark Fax Delivery Receipts as read
/mms/receipts-readMark Receipts As Read
/post/letters/sendSend Post Letter
/referral/accountsGet List of Referral Accounts
/reseller/accountsList of Reseller Accounts
/reseller/accountsCreate Reseller Account
/sms/receipts-readMark Delivery Receipts as read
/post/letters/priceCalculate Price
/sms-campaigns/sendUse Short URL
/account-verify/sendSend account activation token
/contact-suggestionsList Contact Suggestions
/post/postcards/sendSend Postcard
/sdk-download/{type}SDK Download
/sms-campaigns/priceCalculate Price for SMS Campaign
/email-campaigns/sendCreate Email Campaign
/post/letters/historyGet Post Letter History
/post/postcards/priceCalculate Pricing
/recharge/credit-cardGet Credit Card info
/recharge/credit-cardUpdate Credit Card info
/reseller/{subdomain}Reseller By Subdomain
/email-campaigns/priceCalculate Price
/post/return-addressesGet List of Post Return Addresses
/post/return-addressesCreate a Post Return Address
/recharge/transactionsGet Transactions
/email/master-templatesGet All Master Email Templates
/forgot-password/verifyVerify Forgot Password
/lists/{list_id}/importImport Contacts to List
/post/postcards/historyGet Postcard History
/automations/fax/inboundList rules
/automations/fax/inboundCreate a new rule
/automations/sms/inboundList rules
/mms/{message_id}/cancelCancel MMS
/sms/{message_id}/cancelCancel a Scheduled Message
/automations/fax/receiptsList Rules
/automations/fax/receiptsCreate a New Rule
/automations/sms/inbound/Create a new rule
/automations/sms/receiptsList rules
/automations/sms/receiptsCreate a new rule
/lists/{list_id}/contactsGet all Contacts in a List
/lists/{list_id}/contactsCreate a new contact
/reseller/accounts-publicCreate Reseller Account - Public
/reseller/transfer-creditTransfer Credit
/automations/email/receiptList Rules
/automations/email/receiptCreate a New Rule
/fax/receipts/{message_id}Get a Specific Fax Delivery Receipt
/mms/receipts/{message_id}Get Delivery Receipt
/sms/receipts/{message_id}Get a Specific Delivery Receipt
/uploads?convert={convert}Upload a file
/voice/{message_id}/cancelCancel a Specific Voice Call
/automations/voice/receiptsList rules
/automations/voice/receiptsCreate a new rule
/post/direct-mail/campaignsList Direct Mail Campaigns
/post/letters/detect-addressDetect Address
/search/contacts-lists?q={q}Search Contacts-Lists
/sms/templates/{template_id}Update a Template
/sms/templates/{template_id}Delete a Template
/subaccounts/{subaccount_id}Get a specific subaccount
/subaccounts/{subaccount_id}Update a specific subaccount
/subaccounts/{subaccount_id}Delete a specific subaccount
/voice/receipts/{message_id}Get Specific Voice Receipt
/email/templates/{template_id}Get Specific Email Template
/email/templates/{template_id}Update an Email Template
/email/templates/{template_id}Delete Email Template
/lists/{list_id}/import-fieldsGet List of Acceptable Import Fields
/sms/inbound-read/{message_id}Mark a specific Inbound SMS as read
/numbers/buy/{dedicated_number}Buy dedicated number
/recharge/purchase/{package_id}Purchase a Package
/sms/email-sms-stripped-stringsList Stripped Strings
/sms/email-sms-stripped-stringsCreate Stripped String
/post/direct-mail/campaigns/sendCreate New Campaign
/sms-campaigns/{sms_campaign_id}Get SMS Campaign
/sms-campaigns/{sms_campaign_id}Update an SMS Campaign
/post/direct-mail/campaigns/priceCalculate Direct Mail Campaign Price
/sms/email-sms/{email_address_id}Get specific Email-to-SMS Allowed Address
/sms/email-sms/{email_address_id}Update Email-to-SMS Allowed Address
/sms/email-sms/{email_address_id}Delete Email-to-SMS Allowed Address
/email/master-templates-categoriesGet All Master Template Categories
/lists/{list_id}/remove-duplicatesRemove Duplicate Contacts
/sms/inbound/{outbound_message_id}Get Specific Inbound - Pull
/automations/fax/receipts/{rule_id}Get a Specific Rule
/automations/fax/receipts/{rule_id}Update a Rule
/automations/fax/receipts/{rule_id}Delete a Rule
/email/addresses/{email_address_id}Get Specific Allowed Email Address
/email/addresses/{email_address_id}Delete Allowed Email Address
/lists/{list_id}/import-csv-previewShow CSV Import File Preview
/reseller/accounts/{client_user_id}Get Reseller Account
/reseller/accounts/{client_user_id}Update Reseller Account
/account/usage/{year}/{month}/{type}Account Usage
/automations/email/receipt/{rule_id}Get a Specific Rule
/automations/email/receipt/{rule_id}Update a Rule
/automations/email/receipt/{rule_id}Delete a Rule
/email-campaigns/{email_campaign_id}Get Specific Email Campaign
/email-campaigns/{email_campaign_id}Update Email Campaign
/recharge/packages?country={country}List of Packages
/email/master-templates/{template_id}Get Specific Master Template
/email/templates-images/{template_id}Upload Image to Specific Template
/email-campaigns/{campaign_id}/historyGet Specific Email Campaign History
/lists/{list_id}/contacts/{contact_id}Get a specific contact
/lists/{list_id}/contacts/{contact_id}Update a specific contact
/lists/{list_id}/contacts/{contact_id}Delete a specific contact
/pricing/{country}?currency={currency}Get Country Pricing
/fax/history/export?filename={filename}Export Fax History
/mms/history/export?filename={filename}Export MMS History
/recharge/transactions/{transaction_id}Get a specific transaction
/sms-campaigns/{sms_campaign_id}/cancelCancel an SMS Campaign
/sms/history/export?filename={filename}Export SMS History
/account-verify/verify/{activation_token}Verify new account
/email/history/export?filename={filename}Export History
/sms/email-sms-stripped-strings/{rule_id}Find Specific Stripped String
/sms/email-sms-stripped-strings/{rule_id}Update Stripped String
/sms/email-sms-stripped-strings/{rule_id}Delete Stripped String
/voice/history/export?filename={filename}Export Voice History
/automations/fax/inbound/{inbound_rule_id}Get a specific rule
/automations/fax/inbound/{inbound_rule_id}Update a rule
/automations/fax/inbound/{inbound_rule_id}Delete a rule
/automations/sms/inbound/{inbound_rule_id}Get a specific rule
/automations/sms/inbound/{inbound_rule_id}Update a rule
/automations/sms/inbound/{inbound_rule_id}Delete a rule
/post/postcards/export?filename={filename}Export Postcard History
/post/return-addresses/{return_address_id}Get Post Return Address
/post/return-addresses/{return_address_id}Update Post Return Address
/post/return-addresses/{return_address_id}Delete Post Return Address
/sms-campaigns/{campaign_id}/link-trackingLink Tracking
/subaccounts/{subaccount_id}/regen-api-keyRegenerate API Key
/automations/sms/receipts/{receipt_rule_id}Get a specific rule
/automations/sms/receipts/{receipt_rule_id}Update a rule
/automations/sms/receipts/{receipt_rule_id}Delete a rule
/email-campaigns/{email_campaign_id}/cancelCancel Email Campaign
/lists/{list_id}/export?filename={filename}Export Contacts List
/sms-campaigns/{campaign_id}/link-statisticsLink Statistics
/automations/voice/receipts/{receipt_rule_id}Get a specific rule
/automations/voice/receipts/{receipt_rule_id}Update a rule
/automations/voice/receipts/{receipt_rule_id}Delete a rule
/email/address-verify/{email_address_id}/sendSend Verification Token
/voice/receipts-read?date_before={date_before}Marked Voice Receipts as Read
/email/master-templates-categories/{category_id}Get Specific Email Template Category
/post/letters/history/export?filename={filename}Export Post Letter History
/numbers/search/{country}?{search}=1&{search_type}=2Search Dedicated Numbers by Country
/sms/history?date_from={date_from}&date_to={date_to}Get all History
/voice/history?date_from={date_from}&date_to={date_to}Get Voice History
/post/direct-mail/locations/search/{country}/?q={query}Search Locations
/lists/{from_list_id}/contacts/{contact_id}/{to_list_id}Transfer a Contact
/lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id}Remove Opted Out Contacts
/sms-campaigns/{campaign_id}/link-export?filename={filename}Link Tracking Export
/email/master-templates-categories/{category_id}/master-templatesGet All Templates For Category
/email/address-verify/{email_address_id}/verify/{activation_token}Verify Allowed Email Address
/fax/history?date_from={date_from}&date_to={date_to}&q={q}&order_by={order_by}Get Fax History
/mms/history?q={q}&order_by={order_by}&date_from={date_from}&date_to={date_to}Get MMS History