ClickSend REST API v3
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
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:
- Username and password are combined into a string
username:password - The resulting string is then encoded using Base64 encoding
- The authorization method and a space i.e. "Basic " is then put before the encoded string.
For example, if the user uses Aladdin as the username and open sesame as the password then the header is formed as follows:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
PHP Authentication Header Example (using cURL)
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic ' . base64_encode("$username:$password")]);
Verbs
The API uses restful verbs.
| Verb | Description |
|---|---|
GET | Select one or more items. Success returns 200 status code. |
POST | Create a new item. Success returns 200 status code. |
PUT | Update an item. Success returns 200 status code. |
DELETE | Delete an item. Success returns 200 status code. |
Status Codes
The API will respond with one of the following HTTP status codes.
| Code | Response | Description |
|---|---|---|
200 | SUCCESS | Request completed successfully. |
400 | BAD_REQUEST | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
401 | UNAUTHORIZED | Authentication credentials were missing or incorrect. |
403 | FORBIDDEN | The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why. |
404 | NOT_FOUND | The URI requested is invalid or the resource requested does not exists. |
405 | NOT_FOUND | Method doesn't exist or is not allowed. |
429 | TOO_MANY_REQUESTS | Rate Limit Exceeded. Returned when a request cannot be served due to the application’s rate limit having been exhausted for the resource. See Rate Limiting. |
500 | INTERNAL_SERVER_ERROR | Something is broken |
Application Status Codes
The following status codes can be returned in addition to the HTTP status code. For example, when using the Send SMS endpoint:
| Response | Description |
|---|---|
SUCCESS | Message added to queue OK. Use delivery reports to get an update on the delivery status. |
MISSING_CREDENTIALS | Not enough information has been supplied for authentication. Please ensure that your Username and Unique Key are supplied in your request. |
ACCOUNT_NOT_ACTIVATED | Your account has not been activated. |
INVALID_RECIPIENT | The destination mobile number is invalid. |
THROTTLED | Identical message body recently sent to the same recipient. Please try again in a few seconds. |
INVALID_SENDER_ID | Invalid Sender ID. Please ensure Sender ID is no longer than 11 characters (if alphanumeric), and contains no spaces. |
INSUFFICIENT_CREDIT | You have reached the end of your message credits. You will need to purchase more message credits. |
INVALID_CREDENTIALS | Your Username or Unique Key is incorrect. |
ALREADY_EXISTS | The resource you're trying to add already exists. |
EMPTY_MESSAGE | Message is empty. |
TOO_MANY_RECIPIENTS | Too many recipients. |
MISSING_REQUIRED_FIELDS | Some required fields are missing. |
INVALID_SCHEDULE | The schedule specified is invalid. Use a unix timestamp e.g. 1429170372. |
NOT_ENOUGH_PERMISSION_TO_LIST_ID | Don't have enough privilege to access or send to a list_id. |
INTERNAL_ERROR | Internal error. |
INVALID_LANG | An invalid language option has been provided. |
INVALID_VOICE | An invalid voice (gender) option has been provided. |
SUBJECT_REQUIRED | Usually happens when MMS Subject is empty. |
INVALID_MEDIA_FILE | Usually MMS media file is invalid file. |
SOMETHING_IS_WRONG | Generic Error happened. |
Required Headers
You'll need to send some headers when making API calls.
| Header | Value |
|---|---|
Content-type | application/json |
Pagination
Some methods are paginated. By default, 1 page of 15 items will be returned. You can set the pagination parameters by adding ?page={page}&limit={limit} to the URL.
Request
| Parameter | Type | Default | Value |
|---|---|---|---|
page | integer | 1 | … |
Endpoints 205
Account
- GETGet account
/account - PUTUpdate Account
/account - POSTCreate a new account
/accountNote: *Authentication isn't required to create a new account.* - PUTSend account activation token
/account-verify/send - PUTVerify new account
/account-verify/verify/:activation_token - GETAccount Usage
/account/usage/:year/:month/:type
Account Recharge
- GETGet Credit Card info
/recharge/credit-card - PUTUpdate Credit Card info
/recharge/credit-card - GETList of Packages
/recharge/packages?country=:country - PUTPurchase a Package
/recharge/purchase/:package_id - GETGet Transactions
/recharge/transactions - GETGet a specific transaction
/recharge/transactions/:transaction_id
Automation Rules
- GETList Rules
/automations/email/receipt - POSTCreate a New Rule
/automations/email/receipt - GETGet a Specific Rule
/automations/email/receipt/:rule_id - PUTUpdate a Rule
/automations/email/receipt/:rule_id - DELETEDelete a Rule
/automations/email/receipt/:rule_id - GETList rules
/automations/fax/inbound - POSTCreate a new rule
/automations/fax/inbound - GETGet a specific rule
/automations/fax/inbound/:inbound_rule_id - PUTUpdate a rule
/automations/fax/inbound/:inbound_rule_id - DELETEDelete a rule
/automations/fax/inbound/:inbound_rule_id - GETList Rules
/automations/fax/receipts - POSTCreate a New Rule
/automations/fax/receipts - GETGet a Specific Rule
/automations/fax/receipts/:rule_id - PUTUpdate a Rule
/automations/fax/receipts/:rule_id - DELETEDelete a Rule
/automations/fax/receipts/:rule_id - GETList rules
/automations/sms/inbound - POSTCreate a new rule
/automations/sms/inbound/ - GETGet a specific rule
/automations/sms/inbound/:inbound_rule_id - PUTUpdate a rule
/automations/sms/inbound/:inbound_rule_id - DELETEDelete a rule
/automations/sms/inbound/:inbound_rule_id - GETList rules
/automations/sms/receipts - POSTCreate a new rule
/automations/sms/receipts - GETGet a specific rule
/automations/sms/receipts/:receipt_rule_id - PUTUpdate a rule
/automations/sms/receipts/:receipt_rule_id - DELETEDelete a rule
/automations/sms/receipts/:receipt_rule_id - GETList rules
/automations/voice/receipts - POSTCreate a new rule
/automations/voice/receipts - GETGet a specific rule
/automations/voice/receipts/:receipt_rule_id - PUTUpdate a rule
/automations/voice/receipts/:receipt_rule_id - DELETEDelete a rule
/automations/voice/receipts/:receipt_rule_id
Contact Lists
- GETGet all Contact Lists
/lists - POSTCreate a new contact list
/lists - GETGet a specific contact list
/lists/:list_id - PUTUpdate a specific contact list
/lists/:list_id - DELETEDelete a specific contact list
/lists/:list_id - GETExport Contacts List
/lists/:list_id/export?filename=:filename - POSTImport Contacts to List
/lists/:list_id/import - POSTShow CSV Import File Preview
/lists/:list_id/import-csv-previewShow first row of the csv import file. - GETGet List of Acceptable Import Fields
/lists/:list_id/import-fields - PUTRemove Duplicate Contacts
/lists/:list_id/remove-duplicates
Contact Suggestions
- GETList Contact Suggestions
/contact-suggestions
Contacts
- PUTTransfer a Contact
/lists/:from_list_id/contacts/:contact_id/:to_list_idTransfers a specific contact to another list. - GETGet all Contacts in a List
/lists/:list_id/contacts - POSTCreate a new contact
/lists/:list_id/contactsNote that the fields phone_number, fax_number and email are all optional; however at least one of them must be specified, otherwise the API call will fail. - GETGet a specific contact
/lists/:list_id/contacts/:contact_id - PUTUpdate a specific contact
/lists/:list_id/contacts/:contact_id - DELETEDelete a specific contact
/lists/:list_id/contacts/:contact_id - PUTRemove Opted Out Contacts
/lists/:list_id/remove-opted-out-contacts/:opt_out_list_id
Countries
- GETGet all Countries
/countries
Delivery Issues
- GETGet Delivery Issues
/delivery-issues - POSTCreate Delivery Issue
/delivery-issues
Email Marketing
- GETGet All Email Campaigns
/email-campaigns - POSTCalculate Price
/email-campaigns/price - POSTCreate Email Campaign
/email-campaigns/send - GETGet Specific Email Campaign History
/email-campaigns/:campaign_id/history - GETGet Specific Email Campaign
/email-campaigns/:email_campaign_id - PUTUpdate Email Campaign
/email-campaigns/:email_campaign_id - PUTCancel Email Campaign
/email-campaigns/:email_campaign_id/cancel - PUTSend Verification Token
/email/address-verify/:email_address_id/send - PUTVerify Allowed Email Address
/email/address-verify/:email_address_id/verify/:activation_token - GETGet All Allowed Email Addresses
/email/addresses - POSTCreate Allowed Email Address
/email/addresses - GETGet Specific Allowed Email Address
/email/addresses/:email_address_id - DELETEDelete Allowed Email Address
/email/addresses/:email_address_id - GETGet All Master Email Templates
/email/master-templates - GETGet All Master Template Categories
/email/master-templates-categories - GETGet Specific Email Template Category
/email/master-templates-categories/:category_id - GETGet All Templates For Category
/email/master-templates-categories/:category_id/master-templates - GETGet Specific Master Template
/email/master-templates/:template_id - GETGet All Email Templates
/email/templates - POSTCreate New Email Template from Master Template
/email/templates - POSTUpload Image to Specific Template
/email/templates-images/:template_id - GETGet Specific Email Template
/email/templates/:template_id - PUTUpdate an Email Template
/email/templates/:template_id - DELETEDelete Email Template
/email/templates/:template_id
Email-to-SMS Allowed Address
- GETList of Email-to-SMS Allowed Address
/sms/email-smsGet list of allowed email addresses. - POSTCreate Email to SMS Allowed Address
/sms/email-smsCreate an allowed email address. - GETGet specific Email-to-SMS Allowed Address
/sms/email-sms/:email_address_idGet a specific allowed email address. - PUTUpdate Email-to-SMS Allowed Address
/sms/email-sms/:email_address_idUpdate a specific allowed email address. - DELETEDelete Email-to-SMS Allowed Address
/sms/email-sms/:email_address_idDelete a specific allowed email address.
Email-to-SMS Stripped Strings
- GETList Stripped Strings
/sms/email-sms-stripped-strings - POSTCreate Stripped String
/sms/email-sms-stripped-strings - GETFind Specific Stripped String
/sms/email-sms-stripped-strings/:rule_id - PUTUpdate Stripped String
/sms/email-sms-stripped-strings/:rule_id - DELETEDelete Stripped String
/sms/email-sms-stripped-strings/:rule_id
Fax
- GETExport Fax History
/fax/history/export?filename=:filename - GETGet Fax History
/fax/history?date_from=:date_from&date_to=:date_to&q=:q&order_by=:order_byGet a list of Fax History. - POSTCalculate Price
/fax/price - GETList of Fax Delivery Receipts
/fax/receipts - POSTAdd a Test Delivery Receipt
/fax/receipts - PUTMark Fax Delivery Receipts as read
/fax/receipts-read - GETGet a Specific Fax Delivery Receipt
/fax/receipts/:message_id - POSTSend Fax
/fax/sendLetter File Options Use existing URL With this option, you can use an existing URL to a PDF document. For example, you might generate the pdf on your server.…
Forgot Account
- PUTForgot Password
/forgot-password - PUTVerify Forgot Password
/forgot-password/verify - PUTForgot Username
/forgot-username
MMS
- PUTCancel All MMS
/mms/cancel-all - GETExport MMS History
/mms/history/export?filename=:filename - GETGet MMS History
/mms/history?q=:q&order_by=:order_by&date_from=:date_from&date_to=:date_to - POSTGet Price
/mms/price - GETGet all Delivery Receipts
/mms/receipts - PUTMark Receipts As Read
/mms/receipts-read - GETGet Delivery Receipt
/mms/receipts/:message_id - POSTSend MMS
/mms/send - PUTCancel MMS
/mms/:message_id/cancel
Numbers
- GETGet all Dedicated Numbers
/numbers - POSTBuy dedicated number
/numbers/buy/:dedicated_number - GETSearch Dedicated Numbers by Country
/numbers/search/:country?:search=1&:search_type=2
Pricing
- GETGet Country Pricing
/pricing/:country?currency=:currency
Post Address Detection
- POSTDetect Address
/post/letters/detect-addressThe detect-address endpoint accepts either a letter in PDF format or an address string and attempts to convert it to a standard address format. Note that the…
Post Direct Mail
- GETList Direct Mail Campaigns
/post/direct-mail/campaignsGet list of direct mail campaigns. - POSTCalculate Direct Mail Campaign Price
/post/direct-mail/campaigns/priceCalculate direct mail campaign price. - POSTCreate New Campaign
/post/direct-mail/campaigns/sendCreate new direct mail campaign. - GETSearch Locations
/post/direct-mail/locations/search/:country/?q=:query
Post Letter
- GETGet Post Letter History
/post/letters/history - GETExport Post Letter History
/post/letters/history/export?filename=:filename - POSTCalculate Price
/post/letters/price - POSTSend Post Letter
/post/letters/sendSupported File Types We support pdf, docx and doc files. Contact us to add support for any other file type. If you're using docx or doc files, you'll need to… - GETGet List of Post Return Addresses
/post/return-addresses - POSTCreate a Post Return Address
/post/return-addresses - GETGet Post Return Address
/post/return-addresses/:return_address_id - PUTUpdate Post Return Address
/post/return-addresses/:return_address_id - DELETEDelete Post Return Address
/post/return-addresses/:return_address_id
Postcards
- GETExport Postcard History
/post/postcards/export?filename=:filename - GETGet Postcard History
/post/postcards/history - POSTCalculate Pricing
/post/postcards/priceFor file_urls field. You can attach at least 1 and max of 2 PDF file urls. Supply a single pdf with 2 pages (front and back) Supply 2 urls to seperate PDFs - POSTSend Postcard
/post/postcards/sendSupported File Types We support PDF, docx and doc. Contact us to add support for any other file type. If you're using docx or doc files, you'll need to…
Referral Accounts
- GETGet List of Referral Accounts
/referral/accounts
Reseller
- GETGet Reseller Setting
/resellerGet reseller setting. - PUTUpdate Reseller Setting
/resellerUpdate a specific reseller setting. - GETReseller By Subdomain
/reseller/:subdomainGet reseller setting by subdomin.
Reseller Accounts
- GETList of Reseller Accounts
/reseller/accountsGet list of Reseller Accounts - POSTCreate Reseller Account
/reseller/accounts - POSTCreate Reseller Account - Public
/reseller/accounts-public - GETGet Reseller Account
/reseller/accounts/:client_user_idGet a specific reseller account. - PUTUpdate Reseller Account
/reseller/accounts/:client_user_id - PUTTransfer Credit
/reseller/transfer-credit
SDK
- GETSDK Download
/sdk-download/:type
Search
- GETSearch Contacts-Lists
/search/contacts-lists?q=:q
SMS
- PUTCancel all Scheduled Messages
/sms/cancel-all - GETExport SMS History
/sms/history/export?filename=:filename - GETGet all History
/sms/history?date_from=:date_from&date_to=:date_toSMS Delivery Status Status (status field) Status Codes (status_code field) - GETGet all Inbound SMS - Pull
/sms/inbound - POSTAdd a Test Inbound SMS
/sms/inbound - PUTMark all Inbound SMS as read
/sms/inbound-read - PUTMark a specific Inbound SMS as read
/sms/inbound-read/:message_id - GETGet Specific Inbound - Pull
/sms/inbound/:outbound_message_id - POSTCalculate Price
/sms/price - GETGet all Delivery Receipts
/sms/receipts - POSTAdd a Test Delivery Receipt
/sms/receipts - PUTMark Delivery Receipts as read
/sms/receipts-read - GETGet a Specific Delivery Receipt
/sms/receipts/:message_id - POSTSend an SMS
/sms/sendYou can post up to 1000 messages with each API call. - PUTCancel a Scheduled Message
/sms/:message_id/cancel
SMS Campaigns
- GETGet list of SMS Campaigns
/sms-campaigns - POSTCalculate Price for SMS Campaign
/sms-campaigns/price - POSTUse Short URL
/sms-campaigns/sendThis is functionally identical to the POST /sms-campaigns/send endpoint, other than adding the smsg.us/xxxxx string to the message body additional… - GETLink Tracking Export
/sms-campaigns/:campaign_id/link-export?filename=:filenameCompile all link tracking for the specified campaign into a CSV for download. - GETLink Statistics
/sms-campaigns/:campaign_id/link-statisticsGet the breakdown of statistics for your campaign. Note that the returned values vary depending on your specific customers' interaction, so it's not safe to… - GETLink Tracking
/sms-campaigns/:campaign_id/link-trackingThis endpoint gives you a paginated overview of all the links in a particular campaign, and who has and hasn't visited them. - GETGet SMS Campaign
/sms-campaigns/:sms_campaign_id - PUTUpdate an SMS Campaign
/sms-campaigns/:sms_campaign_id - PUTCancel an SMS Campaign
/sms-campaigns/:sms_campaign_id/cancel
SMS Templates
- GETList of Templates
/sms/templatesGet list of templates. - POSTCreate a Template
/sms/templatesCreate new template. - PUTUpdate a Template
/sms/templates/:template_id - DELETEDelete a Template
/sms/templates/:template_id
Statistics
- GETGet SMS Statistics
/statistics/sms - GETGet Voice Statistics
/statistics/voice
Subaccounts
- GETGet all Subaccounts
/subaccounts - POSTCreate a new subaccount
/subaccounts - GETGet a specific subaccount
/subaccounts/:subaccount_id - PUTUpdate a specific subaccount
/subaccounts/:subaccount_id - DELETEDelete a specific subaccount
/subaccounts/:subaccount_id - PUTRegenerate API Key
/subaccounts/:subaccount_id/regen-api-key
Timezones
- GETGet Timezones
/timezonesGet supported list of timezones.
Transactional Email
- GETEmail History
/email/history - GETExport History
/email/history/export?filename=:filename - POSTEmail Price
/email/price - POSTAdd a Test Delivery Receipt
/email/receipts - POSTEmail Send
/email/send
Uploads
- POSTUpload a file
/uploads?convert=:convert
Voice
- PUTCancel all Voice Calls
/voice/cancel-all - GETExport Voice History
/voice/history/export?filename=:filename - GETGet Voice History
/voice/history?date_from=:date_from&date_to=:date_to - GETVoice Languages
/voice/lang - POSTCalculate Price
/voice/price - GETGet Voice receipts
/voice/receipts - POSTAdd a Test Delivery Receipt
/voice/receipts - PUTMarked Voice Receipts as Read
/voice/receipts-read?date_before=:date_before - GETGet Specific Voice Receipt
/voice/receipts/:message_id - POSTSend a Voice Call
/voice/sendYou can post up to 1000 messages with each API call. We support some SSML tags allowing custom breaks or pauses to be entered, and the readout rate to be… - PUTCancel a Specific Voice Call
/voice/:message_id/cancel
API details
- Base URL
https://rest.clicksend.com/v3- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 205 operations on 150 pathsGET 93POST 50PUT 47DELETE 15
- Main resources
- Automation Rules 30Email Marketing 24SMS 15Voice 11Contact Lists 10MMS 9Post Letter 9SMS Campaigns 9Fax 8Contacts 7
- Response formats
application/jsonapplication/pdf- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ClickSend REST API v3 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ClickSend REST API v3 collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get account” (GET /account), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ClickSend REST API v3?
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… It is listed under Communication and has 205 endpoints.
Who publishes the ClickSend REST API v3?
It is listed from ClickSend's public API description (an OpenAPI document), not published by ClickSend on Swastik Codes. Anyone who controls clicksend.com can claim the profile by adding a DNS TXT record.
What is the base URL of the ClickSend REST API v3?
Requests go to https://rest.clicksend.com/v3. Endpoint paths are added to this base URL.
How do I authenticate with the ClickSend REST API v3?
With HTTP Basic authentication (username and password).
How many endpoints does the ClickSend REST API v3 have?
205 operations on 150 paths (93 GET, 50 POST, 47 PUT, 15 DELETE). The largest groups are Automation Rules, Email Marketing, SMS, Voice.
Is forking the ClickSend REST API v3 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.