ClickSend REST API v3
This is the official API documentation for ClickSend
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://rest.clicksend.com/v3"
}
],
"info": {
"description": "This is the official API documentation for ClickSend.com\n\nBelow you will find a current list of the available methods for clicksend.\n\n**NOTE**: You will need to create a free account to use the API.\n\nYou can\n[**Register Here**](https://dashboard.clicksend.com/#/signup/step1/).\n\n# API URL\n\nThe API should always be accessed over SSL.\n\nBase URL: `https://rest.clicksend.com/v3/`\n\n# Authentication\n\nBasic HTTP authentication should be used in the header.\n\n**Either:**\n\n`username`: Your API username\n\n`password`: Your API key\n\n```\nYou can get your API credentials by clicking 'API Credentials' on the top right of the dashboard.\n```\n\n**OR**\n\n`username`: Your account username\n\n`password`: Your account password\n\n```\nThese are the same credentials that you use to login to the dashboard.\n```\n\n### Authorization Header\n\nThe Authorization header is constructed as follows:\n1. Username and password are combined into a string `username:password`\n1. The resulting string is then encoded using Base64 encoding\n1. The authorization method and a space i.e. \"Basic \" is then put before the encoded string.\n\nFor example, if the user uses `Aladdin` as the username and `open sesame` as the password then the header is formed as follows:\n\n`Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==`\n\n### PHP Authentication Header Example (using cURL)\n\n`curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic ' . base64_encode(\"$username:$password\")]);`\n\n# Verbs\n\nThe API uses restful verbs.\n\n| Verb | Description |\n|---|---|\n| `GET` | Select one or more items. Success returns `200` status code. |\n| `POST` | Create a new item. Success returns `200` status code. |\n| `PUT` | Update an item. Success returns `200` status code. |\n| `DELETE` | Delete an item. Success returns `200` status code. |\n\n# Status Codes\n\nThe API will respond with one of the following HTTP status codes.\n\n| Code | Response | Description |\n|---|---|---|\n| `200` | `SUCCESS` | Request completed successfully. |\n| `400` | `BAD_REQUEST` | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |\n| `401` | `UNAUTHORIZED` | Authentication credentials were missing or incorrect. |\n| `403` | `FORBIDDEN` | The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why. |\n| `404` | `NOT_FOUND` | The URI requested is invalid or the resource requested does not exists. |\n| `405` | `NOT_FOUND` | Method doesn't exist or is not allowed. |\n| `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. |\n| `500` | `INTERNAL_SERVER_ERROR` | Something is broken |\n\n# Application Status Codes\n\nThe following status codes can be returned in addition to the HTTP status code. For example, when using the Send SMS endpoint:\n\n| Response | Description |\n|---|---|\n| `SUCCESS` | Message added to queue OK. Use delivery reports to get an update on the delivery status.|\n| `MISSING_CREDENTIALS` | Not enough information has been supplied for authentication. Please ensure that your Username and Unique Key are supplied in your request.|\n| `ACCOUNT_NOT_ACTIVATED` | Your account has not been activated.|\n| `INVALID_RECIPIENT` | The destination mobile number is invalid.|\n| `THROTTLED` | Identical message body recently sent to the same recipient. Please try again in a few seconds.|\n| `INVALID_SENDER_ID` | Invalid Sender ID. Please ensure Sender ID is no longer than 11 characters (if alphanumeric), and contains no spaces.|\n| `INSUFFICIENT_CREDIT` | You have reached the end of your message credits. You will need to purchase more message credits.|\n| `INVALID_CREDENTIALS` | Your Username or Unique Key is incorrect.|\n| `ALREADY_EXISTS` | The resource you're trying to add already exists.|\n| `EMPTY_MESSAGE` | Message is empty.|\n| `TOO_MANY_RECIPIENTS` | Too many recipients.|\n| `MISSING_REQUIRED_FIELDS` | Some required fields are missing.|\n| `INVALID_SCHEDULE` | The schedule specified is invalid. Use a unix timestamp e.g. 1429170372.|\n| `NOT_ENOUGH_PERMISSION_TO_LIST_ID` | Don't have enough privilege to access or send to a list_id.|\n| `INTERNAL_ERROR` | Internal error.|\n| `INVALID_LANG` | An invalid language option has been provided.|\n| `INVALID_VOICE` | An invalid voice (gender) option has been provided.|\n| `SUBJECT_REQUIRED` | Usually happens when MMS Subject is empty.|\n| `INVALID_MEDIA_FILE` | Usually MMS media file is invalid file.|\n| `SOMETHING_IS_WRONG` | Generic Error happened.|\n\n# Required Headers\n\nYou'll need to send some headers when making API calls.\n\n| Header | Value |\n|---|---|\n| `Content-type` | `application/json` |\n\n# Pagination\n\nSome 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.\n\n## Request\n\n| Parameter | Type | Default | Value |\n|---|---|---|---|\n| `page` | integer | `1` | The page number to return in the response. |\n| `limit` | integer | `15` | The number of results per page. Min 15, Max 100. |\n\n## Response\n\n| Attribute | Type | Value |\n|---|---|---|---|\n| `total` | integer | Total number of results available. |\n| `per_page` | integer | Number of results returned per page. |\n| `current_page` | integer | Current page number. |\n| `last_page` | integer | Last page number. |\n| `next_page_url` | string | A URL of the next page. `null` if not available.|\n| `prev_page_url` | string | A URL of the previous page. `null` if not available.|\n| `from` | integer | Number of the first result in current page. |\n| `to` | integer | Number of the last result in current page. |\n\n# Searching and Sorting\n\nMost GET endpoints allow searching and sorting. Searches are **not** case-sensitive.\n\n## Search\n\nTo perform a search, add `q` as a query parameter. For example:\n\n`/subaccounts?q=field:value,field2:value`\n\n## Order\n\nTo perform a sort, add `order_by` as a query parameter. For example:\n\n`/subaccounts?order_by=field:desc/asc`\n\n## AND / OR\n\nBy default, it will search using the `AND` operator. This can be set using `operator` as a query parameter. For example:\n\n`/subaccounts?q=field:value&operator=OR`\n\n**Options:**\n\n- `AN` - returns results matching **all** query fields specified\n\n- `OR` - returns results matching **any** query fields specified\n\n## Example\n\n`/subaccounts?q=first_name:john,last_name:smith&order_by=subaccount_id:asc&operator=AND`\n\n# CORS\n\nWhen creating your API app, specify the JavaScript (CORS) origins you'll be using. We use these origins to return the headers needed for CORS.\n\n# Date and Time\n\nAll date/timestamps will be returned in Unix time (also known as POSIX time or erroneously as Epoch time) with no leap seconds.\n\nFor example: `1435255816`\n\n```\n(ISO 8601: 2015-06-25T18:10:16Z)\n```\n\nMore information: [Wikipedia: Unix time](https://en.wikipedia.org/wiki/Unix_time).\n\nThere is ony one Unix time and it is created by using the UTC/GMT time zone. This means you might have convert time zones to calculate timestamps. Most programming language have libraries to help you converting time zones.\n\n**The current Unix time can be found here:** [Epoch Converter](http://www.epochconverter.com)\n\n# Testing\n\n## Test Credentials\n\nThese API credentials can be used to test specific scenarios.\n\n**Note:** you will need to create a free account to test other scenarios. Refer to introduction.\n\n| API Username | API Key | Description |\n|---|---|---|---|\n| `nocredit` | `D83DED51-9E35-4D42-9BB9-0E34B7CA85AE` | This account has no credit. |\n| `notactive` | `D83DED51-9E35-4D42-9BB9-0E34B7CA85AE` | This account is not active. |\n| `banned` | `D83DED51-9E35-4D42-9BB9-0E34B7CA85AE` | This account is banned. |\n\n## Test SMS/MMS Numbers\n\nThe following numbers can be used when testing. No messages will be sent, and your account won't be charged. A success response will be returned.\n\n- `+61411111111`\n\n- `+61422222222`\n\n- `+61433333333`\n\n- `+61444444444`\n\n- `+14055555555`\n\n- `+14055555666`\n\n- `+447777777777`\n\n- `+8615555555555`\n\n## Test Voice Numbers\n\nThe following numbers can be used when testing. No messages will be sent, and your account won't be charged. A success response will be returned.\n\n- `+61411111111`\n\n- `+61422222222`\n\n- `+61433333333`\n\n- `+61444444444`\n\n- `+14055555555`\n\n- `+14055555666`\n\n- `+447777777777`\n\n- `+8615555555555`\n\n## Test Fax Numbers\n\nThe following numbers can be used when testing. No messages will be sent, and your account won't be charged. A success response will be returned.\n\n- `+61261111111`\n\n- `+61262222222`\n\n- `+61263333333`\n\n## Test Email Addresses\n\nThe following email addresses can be used when testing. No messages will be sent, and your account won't be charged. A success response will be returned.\n\n- `test1@test.com`\n\n- `test2@test.com`\n\n- `test3@test.com`\n\n## Test Post Letter Addresses\n\nThe following Postal Codes (address_postal_code) can be used when testing. No messages will be sent when using these post codes, and your account won't be charged. A success response will be returned.\n\n- `11111`\n\n- `22222`\n\n- `33333`",
"title": "ClickSend REST API v3",
"version": "1.0.0",
"x-apisguru-categories": [
"email"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_www.clicksend.com_img_favicons_apple-touch-icon.png"
},
"x-origin": [
{
"format": "swagger",
"url": "https://clicksend.docs.apiary.io/api-description-document",
"version": "2.0"
}
],
"x-providerName": "clicksend.com"
},
"tags": [
{
"name": "Account"
},
{
"name": "Account Recharge"
},
{
"name": "Automation Rules"
},
{
"name": "Contact Lists"
},
{
"name": "Contact Suggestions"
},
{
"name": "Contacts"
},
{
"name": "Countries"
},
{
"name": "Delivery Issues"
},
{
"name": "Email Marketing"
},
{
"name": "Email-to-SMS Allowed Address"
},
{
"name": "Email-to-SMS Stripped Strings"
},
{
"description": "# Supported File Types\n\n- Supported file types are listed below. If you need to convert a file to a supported format, it can be first passed to our uploads endpoint: `/uploads?convert=fax`\n\n- This will return a URL to the converted pdf file that can be used in the /fax/send endpoint.\n\n- Contact us to add support for any other file type.\n\n## Documents\n\n| File type | Required to be passed to uploads endpoint first? |\n|---|---|\n| pdf | No |\n| docx | Yes |\n| doc | Yes |\n| rtf | Yes |",
"name": "Fax"
},
{
"name": "Forgot Account"
},
{
"description": "# What is it?\n\nGeolocation allows you to send an SMS to a handset with a URL in the message. When the user taps on the URL, it sends you their location. You will receive the following information:\n\n- Latitude\n\n- Longitude\n\n- Their full address\n\n- A URL to a Google map with the location marked\n\n# How to use it\n\nTo use Geolocation, simply insert the placeholder `(Geolocation)` (including the parenthesis) into an SMS or Email message, and that's it. Our system will handle the placeholder and insert the correct information required to allow geolocation tracking via message.\n\nFor more information, see our [help article](https://help.clicksend.com/geolocation/how-does-geolocation-work).",
"name": "Geolocation"
},
{
"description": "# How many messages can I send?\n\n## Send MMS Endpoint\n\nYou can post **up to 1000 messages** with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains a status and details for each recipient.\n\nRefer to [**Application Status Codes**](#introduction/application-status-codes) for the possible response message status strings.\n\n# How many characters can I send in a message?\n\n## Standard MMS Message\n\n1500 characters\n\n## Unicode MMS Message\n\n500 characters\n\nIf a message is longer the allowed number of characters it will be truncated. If a message contains any characters that aren't in the GSM 03.38 character set, the message type will be treated as unicode. (`https://en.wikipedia.org/wiki/GSM_03.38`)\n\n# Maximum File Size\n\nYou can send a single attachment with a size of up to 250 kB. Some older devices can only accept attachments with up to 30 kB.\n\n# Supported File Types\n\n- Supported file types are listed below. If you need to convert a file to a supported format, it can be first passed to our uploads endpoint: `/uploads?convert=mms`\n\n- This will return a URL to the converted image file that can be used in the /mms/send endpoint.\n\n- Contact us to add support for any other file type.\n\n## Images\n\n| File type | Required to be passed to uploads endpoint first? |\n|---|---|\n| jpg | No |\n| gif | No |\n| jpeg | Yes |\n| png | Yes |\n| bmp | Yes |",
"name": "MMS"
},
{
"name": "Numbers"
},
{
"name": "Pricing"
},
{
"name": "Post Address Detection"
},
{
"name": "Post Direct Mail"
},
{
"name": "Post Letter"
},
{
"name": "Postcards"
},
{
"name": "Referral Accounts"
},
{
"name": "Reseller"
},
{
"name": "Reseller Accounts"
},
{
"name": "SDK"
},
{
"name": "Search"
},
{
"description": "# How many messages can I send?\n\n## Send SMS Endpoint\n\nYou can post **up to 1000 messages** with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains a status and details for each recipient.\n\nRefer to [**Application Status Codes**](#introduction/application-status-codes) for the possible response message status strings.\n\n## SMS Campaign Endpoint\n\nYou can post to a list with **up to 20000 recipients** with each API call. You can only send to a single list containing up to 20,000 recipients. The response is far less detailed than the normal Send SMS endpoint.\n\n# How many characters can I send in a message?\n\nA standard SMS message has a maximum of 160 characters. Longer messages are definitely possible, however please be aware that exceeding 160 characters will constitute a ‘second’ message. The end user will see this as 1 long message on their handset.\nWhen a message is longer than 160 characters, this is referred to as a multi-part message as it contains multiple messages (or multiple-parts). The total SMS limit then becomes 153 characters per ‘part’ as the 7 characters are used up by invisible headers and footers which denote which part of the message is being sent (i.e. Part 1 of 2). For example:\nIf a message is longer than 6 message parts, it will be truncated (see below). If a message contains any characters that aren't in the GSM 03.38 character set, the message type will be treated as unicode. (`https://en.wikipedia.org/wiki/GSM_03.38`)\n\n## Standard English Characters:\n\n| Number of Characters | Message Credits |\n|---|---|\n| 1 - 160 | 1 |\n| 161 - 306 | 2 |\n| 307 - 459 | 3 |\n| 460 - 612 | 4 |\n| 613 - 765 | 5 |\n| 766 - 918 | 6 |\n| 919 - 1071 | 7 |\n| 1072 - 1224 | 8 |\n\n## Non-GSM (Unicode) characters:\n\n| Number of Characters | Message Credits |\n|---|---|\n|1 - 70 | 1 |\n|71 - 134 | 2 |\n|135 - 201 | 3 |\n|202 - 268 | 4 |\n|269 - 335 | 5 |\n|336 - 402 | 6 |\n|403 - 469 | 7 |\n|470 - 536 | 8 |",
"name": "SMS"
},
{
"name": "SMS Campaigns"
},
{
"name": "SMS Templates"
},
{
"name": "Statistics"
},
{
"name": "Subaccounts"
},
{
"name": "Timezones"
},
{
"name": "Transactional Email"
},
{
"name": "Uploads"
},
{
"description": "Send TTS (Text-to-speech) voice calls\n\n# How many messages can I send?\n\nYou can post **up to 1000 messages** with each API call. You can send to a mix of contacts and contact lists, as long as the total number of recipients is up to 1000. The response contains a status and details for each recipient.\n\n# How many characters can I send in a message?\n\nIf a message is longer than 4 message parts, it will be truncated (see below). If a message contains any characters that aren't in the GSM 03.38 character set, the message type will be treated as unicode. (`https://en.wikipedia.org/wiki/GSM_03.38`)\n\n## Standard English Characters:\n\n| Number of Characters | Message Credits |\n|---|---|\n| 1 - 300 | 1 |\n| 301 - 600 | 2 |\n| 601 - 900 | 3 |\n| 901 - 1200 | 4 |\n\n## Non-GSM (Unicode) characters:\n\n| Number of Characters | Message Credits |\n|---|---|\n|1 - 150 | 1 |\n|151 - 300 | 2 |\n|301 - 450 | 3 |\n|451 - 600 | 4 |\n\n# Allowed Languages\n\n| Language, Locale | lang | voice |\n|---|---|---|\n| `English`, US | en-us | female (default) / male|\n| `English`, Australia | en-au | female (default) / male|\n| `English`, UK | en-gb | female (default) / male|\n| `English`, India | en-in | female|\n| `English`, Wales | en-gb-wls | female (default) / male|\n| `Celtic`, Wales | cy-gb-wls | female (default) / male|\n| `German`, Germany | de-de | female (default) / male|\n| `Spanish`, Spain | es-es | female (default) / male|\n| `Spanish`, US | es-us | female (default) / male|\n| `French`, Canada | fr-ca | female|\n| `French`, France | fr-fr | female (default) / male|\n| `Icelandic`, Iceland | is-is | female (default) / male|\n| `Italian`, Italy | it-it | female (default) / male|\n| `Danish`, Denmark | da-dk | female (default) / male|\n| `Dutch`, Netherlands | nl-nl | female (default) / male|\n| `Norwegian`, Norway | nb-no | female|\n| `Polish`, Poland | pl-pl | female (default) / male|\n| `Portuguese`, Portugal | pt-pt | male|\n| `Portuguese`, Brazil | pt-br | female (default) / male|\n| `Romanian`, Romania | ro-ro | female|\n| `Russian`, Russia | ru-ru | female (default) / male|\n| `Swedish`, Sweden | sv-se | female|\n| `Turkish`, Turkey | tr-tr | female|\n\n# Tips\n\nTo introduce a small delay between words or digits you can use a comma (,).\n\nFor example:\n`Please enter your activation code 9, 0, 9, 0, in the next 20 minutes.`",
"name": "Voice"
}
],
"paths": {
"/account": {
"get": {
"description": "",
"operationId": "Get account",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_mms": 1,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "IJVEGTCF-VOHU-GSVF-KNKK-XHTARJXMQTXK",
"api_username": "KCIHOYEYGM",
"email": "ICMGR@VBSPT.com",
"first_name": "Firstname40710",
"last_name": "Lastname3672",
"notes": null,
"phone_number": "+61433333333",
"share_campaigns": 1,
"subaccount_id": 1716
},
"account": 0,
"account_billing_email": "XDVXC@SJRJU.com",
"account_billing_mobile": "+61433333888",
"account_name": "FTHCQ~!@#$ %^&*()XQMPO",
"active": 1,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "1117.461060",
"balance_commission": "2.330130",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"fax_quality": 0,
"low_credit_amount": "0.00",
"old_dashboard": 0,
"private_uploads": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_hide_business_name": 1,
"setting_sms_hide_your_number": 0,
"setting_sms_message_char_limit": 8,
"setting_unicode_sms": 0,
"timezone": "Australia/Melbourne",
"user_email": "PNUMB@VAPXX.com",
"user_first_name": "fffff",
"user_id": 3819,
"user_last_name": "llll",
"user_phone": "+61433333888",
"username": "ULXHP"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here's your account"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get account",
"tags": [
"Account"
]
},
"post": {
"description": "**Note:** *Authentication isn't required to create a new account.*",
"operationId": "Create a new account",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"account_name": "The Awesome Company",
"country": "US",
"password": "pass",
"user_email": "johndoe1@awesome.com",
"user_first_name": "John",
"user_last_name": "Doe",
"user_phone": "518-481-1001",
"username": "johndoe1"
},
"properties": {
"account_name": {
"description": "Your delivery to value.",
"type": "string"
},
"country": {
"description": "Your country.",
"type": "string"
},
"password": {
"description": "Your password.",
"type": "string"
},
"user_email": {
"description": "Your email.",
"type": "string"
},
"user_first_name": {
"description": "Your first name.",
"type": "string"
},
"user_last_name": {
"description": "Your last name.",
"type": "string"
},
"user_phone": {
"description": "Your phone number in E.164 format.",
"type": "string"
},
"username": {
"description": "Your username.",
"type": "string"
}
},
"required": [
"username",
"password",
"user_email",
"user_phone",
"user_first_name",
"user_last_name",
"account_name",
"country"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "F3702045-EB2C-0091-C211-7728048DCAE2",
"api_username": "johndoe1",
"email": "johndoe1@awesome.com",
"first_name": "John",
"last_name": "Doe",
"notes": null,
"phone_number": "+15184811001",
"share_campaigns": 0,
"subaccount_id": 126
},
"account": 0,
"account_billing_email": "johndoe1@awesome.com",
"account_billing_mobile": "+15184811001",
"account_name": "The Awesome Company",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "4.998000",
"balance_commission": "0.299954",
"banned": 0,
"country": "US",
"default_country_sms": "US",
"delivery_to": null,
"low_credit_amount": "0.00",
"old_dashboard": 0,
"reply_to": "originalemail",
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 6,
"setting_unicode_sms": 0,
"timezone": "Australia/Melbourne",
"user_email": "johndoe1@awesome.com",
"user_first_name": "John",
"user_id": 116,
"user_last_name": "Doe",
"user_phone": "+15184811001",
"username": "johndoe1"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Successfully created an account."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a new account",
"tags": [
"Account"
]
},
"put": {
"description": "",
"operationId": "Update Account",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"account_name": "The Awesome Company",
"country": "AU",
"password": "pass",
"private_uploads": 1,
"setting_sms_hide_business_name": 1,
"setting_sms_hide_your_number": 0,
"timezone": "Australia/Melbourne",
"user_email": "johndoe@awesome.com",
"user_first_name": "John",
"user_last_name": "Doe",
"user_phone": "518-481-1002",
"username": "johndoe"
},
"properties": {
"account_name": {
"description": "Your delivery to value.",
"type": "string"
},
"country": {
"description": "Your country.",
"type": "string"
},
"password": {
"description": "Your password.",
"type": "string"
},
"private_uploads": {
"description": "Set the private uploads flag. 0 or 1 only.",
"type": "number"
},
"setting_sms_hide_business_name": {
"description": "Set the private uploads flag. 0 or 1 only.",
"type": "number"
},
"setting_sms_hide_your_number": {
"description": "Set the private uploads flag. 0 or 1 only.",
"type": "number"
},
"timezone": {
"description": "Timezone.",
"type": "string"
},
"user_email": {
"description": "Your email.",
"type": "string"
},
"user_first_name": {
"description": "Your first name.",
"type": "string"
},
"user_last_name": {
"description": "Your last name.",
"type": "string"
},
"user_phone": {
"description": "Your phone number in E.164 format.",
"type": "string"
},
"username": {
"description": "Your username.",
"type": "string"
}
},
"required": [
"username",
"password",
"user_email",
"user_phone",
"user_first_name",
"user_last_name",
"account_name",
"country",
"timezone"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": null,
"account": 0,
"account_billing_email": "1@test.com",
"account_billing_mobile": "+19171234591",
"account_name": "The Awesome Company",
"active": 1,
"auto_recharge": 1,
"auto_recharge_amount": "20.00",
"balance": "0.592200",
"balance_commission": "0.299954",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "1@test.com",
"fax_quality": 0,
"low_credit_amount": "200.00",
"old_dashboard": 1,
"private_uploads": 0,
"reply_to": "11@test.com",
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 1,
"setting_sms_hide_business_name": 1,
"setting_sms_hide_your_number": 0,
"setting_sms_message_char_limit": 8,
"setting_unicode_sms": 0,
"timezone": "Australia/Melbourne",
"user_email": "johndoe@awesome.com",
"user_first_name": "John",
"user_id": 1,
"user_last_name": "Doe",
"user_phone": "518-481-1003",
"username": "johndoe"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your account has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update Account",
"tags": [
"Account"
]
}
},
"/account-verify/send": {
"put": {
"description": "",
"operationId": "Send account activation token",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"country": "US",
"type": "sms",
"user_phone": "352-394-4199"
},
"properties": {
"country": {
"type": "string"
},
"type": {
"type": "string"
},
"user_phone": {
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"activation_token": "547850",
"country": "US",
"type": "sms",
"user_phone": "+13523944199"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Verification sent."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Send account activation token",
"tags": [
"Account"
]
}
},
"/account-verify/verify/{activation_token}": {
"put": {
"description": "",
"operationId": "Verify new account",
"parameters": [
{
"description": "The ActivationToken to be used to verify an account.",
"example": "1827364",
"in": "path",
"name": "activation_token",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_reporting": 1,
"access_settings": 1,
"access_smpp": 0,
"access_users": 1,
"api_key": "FD3259F9D0A35548682ACEA84A6FF26A",
"api_username": "1",
"email": "1@test.com",
"first_name": "John",
"last_name": "Doe",
"mobile": "+639171234501",
"sms_deidentify_message": 0,
"subaccount_id": 1,
"user_id": 1
},
"account": 1,
"account_billing_email": "1@test.com",
"account_billing_mobile": null,
"account_name": null,
"active": 1,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "4.041500",
"banned": 0,
"country": "US",
"default_country_sms": "US",
"delivery_to": null,
"low_credit_amount": "1.50",
"reply_to": "1@test.com",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 1,
"setting_unicode_sms": 0,
"unsubscribe_mail": 0,
"user_email": "1@test.com",
"user_first_name": "John",
"user_id": 1,
"user_last_name": "Doe",
"user_phone": "+13523944199",
"username": "1"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "You're account has been verified."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Verify new account",
"tags": [
"Account"
]
}
},
"/account/usage/{year}/{month}/{type}": {
"get": {
"description": "",
"operationId": "Account Usage",
"parameters": [
{
"description": "Your account usage year.",
"example": "2016",
"in": "path",
"name": "year",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Your account usage month.",
"example": "4",
"in": "path",
"name": "month",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "The account type. Value can only be either email or subaccount.",
"example": "subaccount",
"in": "path",
"name": "type",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"email": [
{
"subaccount_id": 1039,
"total_count": 3992,
"total_price": "9.0020",
"username": "user1"
},
{
"subaccount_id": 1047,
"total_count": 998,
"total_price": "0.0000",
"username": "user5"
}
],
"email_total": {
"count": 4990,
"price": "9.0020"
},
"fax": [
{
"subaccount_id": 1039,
"total_count": "3.00",
"total_price": "0.6943",
"username": "user1"
},
{
"subaccount_id": 1047,
"total_count": "1.00",
"total_price": "0.2314",
"username": "user5"
}
],
"fax_total": {
"count": 4,
"price": "0.9257"
},
"post": [
{
"subaccount_id": 1039,
"total_count": "10",
"total_price": "8.5624",
"username": "user1"
},
{
"subaccount_id": 1047,
"total_count": "3",
"total_price": "2.5586",
"username": "user5"
}
],
"post_total": {
"count": 13,
"price": "11.1210"
},
"sms": [
{
"subaccount_id": 1039,
"total_count": "29.00",
"total_price": "2.1337",
"username": "gerald"
},
{
"subaccount_id": 1047,
"total_count": "4.00",
"total_price": "0.3080",
"username": "user5"
}
],
"sms_total": {
"count": 33,
"price": "2.4417"
},
"voice": [
{
"subaccount_id": 1039,
"total_count": "6.00",
"total_price": "0.1980",
"username": "user1"
},
{
"subaccount_id": 1047,
"total_count": "1.00",
"total_price": "0.0330",
"username": "user5"
}
],
"voice_total": {
"count": 7,
"price": "0.2310"
}
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your usage for this month."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Account Usage",
"tags": [
"Account"
]
}
},
"/automations/email/receipt": {
"get": {
"description": "",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 1,
"rule_name": "Email Test Rule"
},
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 2,
"rule_name": "test"
},
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 6,
"rule_name": "test"
},
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 7,
"rule_name": "test"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 4,
"total": 4
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List Rules",
"tags": [
"Automation Rules"
]
},
"post": {
"description": "",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"rule_name": "My Rule"
},
"properties": {
"action": {
"description": "Action.",
"type": "string"
},
"action_address": {
"description": "Action Address.",
"type": "string"
},
"enabled": {
"description": "Enabled.",
"type": "number"
},
"match_type": {
"description": "Match Type. 0=All reports.",
"type": "number"
},
"rule_name": {
"description": "Rule Name.",
"type": "string"
}
},
"required": [
"rule_name",
"match_type",
"action",
"action_address",
"enabled"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 8,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Automation email receipt rule has been created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a New Rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/email/receipt/{rule_id}": {
"delete": {
"description": "",
"parameters": [
{
"description": "The email receipt rule id you want to delete.",
"example": "8",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": true,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Automation email receipt rule has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a Rule",
"tags": [
"Automation Rules"
]
},
"get": {
"description": "",
"parameters": [
{
"description": "The rule id you want to access.",
"example": "5",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 1,
"rule_name": "Email Test Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a Specific Rule",
"tags": [
"Automation Rules"
]
},
"put": {
"description": "",
"parameters": [
{
"description": "The email receipt rule id you want to access.",
"example": "8",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"rule_name": "My Rule"
},
"properties": {
"action": {
"description": "Action.",
"type": "string"
},
"action_address": {
"description": "Action Address.",
"type": "string"
},
"enabled": {
"description": "Enabled.",
"type": "number"
},
"match_type": {
"description": "Match Type. 0=All reports.",
"type": "number"
},
"rule_name": {
"description": "Rule Name.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 8,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Automation email receipt rule has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update a Rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/fax/inbound": {
"get": {
"description": "",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"action": "EMAIL_FIXED",
"action_address": "test@test.com",
"dedicated_number": "19",
"enabled": 1,
"inbound_rule_id": 1,
"rule_name": "Email",
"user_id": 1
},
{
"action": "URL",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 2,
"rule_name": "URL",
"user_id": 1
},
{
"action": "POLL",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 3,
"rule_name": "POLL",
"user_id": 1
},
{
"action": "EMAIL_FIXED",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 4,
"rule_name": "POLL",
"user_id": 1
},
{
"action": "NOTHING",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 6,
"rule_name": "POLL",
"user_id": 1
},
{
"action": "NOTHING",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 7,
"rule_name": "POLL",
"user_id": 1
},
{
"action": "NOTHING",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 8,
"rule_name": "POLL",
"user_id": 1
},
{
"action": "NOTHING",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 9,
"rule_name": "POLL",
"user_id": 1
},
{
"action": "POLL",
"action_address": "http://yourdomain.com",
"dedicated_number": "19",
"enabled": 0,
"inbound_rule_id": 10,
"rule_name": "POLL",
"user_id": 1
},
{
"action": "EMAIL_FIXED",
"action_address": "",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 12,
"rule_name": "Rule Name",
"user_id": 1
},
{
"action": "EMAIL_FIXED",
"action_address": "",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 13,
"rule_name": "Rule Name",
"user_id": 1
},
{
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 14,
"rule_name": "Rule Name",
"user_id": 1
},
{
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 15,
"rule_name": "Rule Name",
"user_id": 1
},
{
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 16,
"rule_name": "Rule Name",
"user_id": 1
},
{
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 17,
"rule_name": "Rule Name",
"user_id": 1
}
],
"from": 1,
"last_page": 2,
"next_page_url": "https://rest.clicksend.com/v3/automations/fax/inbound?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 20
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your inbound fax."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List rules",
"tags": [
"Automation Rules"
]
},
"post": {
"description": "",
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_new_ruleBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 24,
"rule_name": "My Rule",
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New rule has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a new rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/fax/inbound/{inbound_rule_id}": {
"delete": {
"description": "",
"parameters": [
{
"description": "Fax inbound rule id",
"example": "14",
"in": "path",
"name": "inbound_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your fax inbound rule has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a rule",
"tags": [
"Automation Rules"
]
},
"get": {
"description": "",
"parameters": [
{
"description": "Fax inbound rule id",
"example": "14",
"in": "path",
"name": "inbound_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 14,
"rule_name": "Rule Name",
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your inbound fax."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific rule",
"tags": [
"Automation Rules"
]
},
"put": {
"description": "",
"parameters": [
{
"description": "Fax inbound rule id",
"example": "14",
"in": "path",
"name": "inbound_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_new_ruleBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 14,
"rule_name": "Rule Name",
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your inbound fax."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update a rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/fax/receipts": {
"get": {
"description": "",
"operationId": "List Rules",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 1,
"rule_name": "Email Test Rule"
},
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 2,
"rule_name": "test"
},
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 6,
"rule_name": "test"
},
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 7,
"rule_name": "test"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 4,
"total": 4
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List Rules",
"tags": [
"Automation Rules"
]
},
"post": {
"description": "",
"operationId": "Create a New Rule",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 2,
"rule_name": "My Rule"
},
"properties": {
"action": {
"description": "Action.",
"type": "string"
},
"action_address": {
"description": "Action Address.",
"type": "string"
},
"enabled": {
"description": "Enabled.",
"type": "number"
},
"match_type": {
"description": "Match Type. 0=All reports.",
"type": "number"
},
"rule_name": {
"description": "Rule Name.",
"type": "string"
}
},
"required": [
"rule_name",
"match_type",
"action",
"action_address",
"enabled"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 2,
"receipt_rule_id": 4,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your new Fax receipt has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a New Rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/fax/receipts/{rule_id}": {
"delete": {
"description": "",
"operationId": "Delete a Rule",
"parameters": [
{
"description": "The email receipt rule id you want to delete.",
"example": "4",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": null,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming fax receipt has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a Rule",
"tags": [
"Automation Rules"
]
},
"get": {
"description": "",
"operationId": "Get a Specific Rule",
"parameters": [
{
"description": "The rule id you want to access.",
"example": "4",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 2,
"receipt_rule_id": 4,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming fax receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a Specific Rule",
"tags": [
"Automation Rules"
]
},
"put": {
"description": "",
"operationId": "Update a Rule",
"parameters": [
{
"description": "The email receipt rule id you want to access.",
"example": "4",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 1,
"rule_name": "My Rule"
},
"properties": {
"action": {
"description": "Action.",
"type": "string"
},
"action_address": {
"description": "Action Address.",
"type": "string"
},
"enabled": {
"description": "Enabled.",
"type": "number"
},
"match_type": {
"description": "Match Type. 0=All reports.",
"type": "number"
},
"rule_name": {
"description": "Rule Name.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 1,
"receipt_rule_id": 4,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming fax receipt has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update a Rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/sms/inbound": {
"get": {
"description": "",
"operationId": "List rules",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"action": "CREATE_CONTACT_PLUS_EMAIL",
"action_address": "430",
"body": "test@test.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 10,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 10"
},
{
"action": "CREATE_CONTACT",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 9,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 9"
},
{
"action": "MOVE_CONTACT",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 8,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 8"
},
{
"action": "GROUP_SMS",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 7,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 7"
},
{
"action": "POLL",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 6,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 6"
},
{
"action": "SMS",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 5,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 5"
},
{
"action": "URL",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 4,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 4"
},
{
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 3,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 3"
},
{
"action": "EMAIL_USER",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 2,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule 2"
},
{
"action": "AUTO_REPLY",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 1,
"message_search_term": null,
"message_search_type": 3,
"rule_name": "My Rule 1"
},
{
"action": "CREATE_CONTACT_PLUS_NAME",
"action_address": 534,
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 1,
"message_search_term": null,
"message_search_type": 3,
"rule_name": "My Rule 1"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 10,
"total": 10
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your list of inbound rules."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List rules",
"tags": [
"Automation Rules"
]
}
},
"/automations/sms/inbound/": {
"post": {
"description": "",
"operationId": "Create a new rule",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule"
},
"properties": {
"action": {
"description": "Action.",
"type": "string"
},
"action_address": {
"description": "Action Address.",
"type": "string"
},
"dedicated_number": {
"description": "Dedicated Number.",
"type": "number"
},
"enabled": {
"description": "Enabled.",
"type": "number"
},
"message_search_term": {
"description": "Message Search Term.",
"type": "string"
},
"message_search_type": {
"description": "Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.",
"type": "number"
},
"rule_name": {
"description": "Rule Name.",
"type": "string"
}
},
"required": [
"dedicated_number",
"rule_name",
"message_search_type",
"message_search_term",
"action",
"action_address",
"enabled"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 11,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your record has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a new rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/sms/inbound/{inbound_rule_id}": {
"delete": {
"description": "",
"operationId": "Delete a rule",
"parameters": [
{
"description": "Inbound Rule ID.",
"example": "1",
"in": "path",
"name": "inbound_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your record has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a rule",
"tags": [
"Automation Rules"
]
},
"get": {
"description": "",
"operationId": "Get a specific rule",
"parameters": [
{
"description": "Inbound Rule ID.",
"example": "1",
"in": "path",
"name": "inbound_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 1,
"message_search_term": null,
"message_search_type": 3,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your inbound rule."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific rule",
"tags": [
"Automation Rules"
]
},
"put": {
"description": "",
"operationId": "Update a rule",
"parameters": [
{
"description": "Inbound Rule ID.",
"example": "1",
"in": "path",
"name": "inbound_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"message_search_term": "My Search Term",
"message_search_type": 3,
"rule_name": "My Rule"
},
"properties": {
"action": {
"description": "Action.",
"type": "string"
},
"action_address": {
"description": "Action Address.",
"type": "string"
},
"dedicated_number": {
"description": "Dedicated Number",
"type": "string"
},
"enabled": {
"description": "Enabled.",
"type": "number"
},
"message_search_term": {
"description": "Message Search Term.",
"type": "string"
},
"message_search_type": {
"description": "Message Search Type: 0=Any message, 1=starts with, 2=contains, 3=does not contain.",
"type": "number"
}
},
"required": [
"dedicated_number",
"message_search_type",
"message_search_term",
"action",
"action_address",
"enabled"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"body": null,
"dedicated_number": "+61298441484",
"enabled": 1,
"inbound_rule_id": 1,
"message_search_term": null,
"message_search_type": 3,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your record has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update a rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/sms/receipts": {
"get": {
"description": "",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 0,
"match_type": 0,
"receipt_rule_id": 5,
"rule_name": "My Rule"
},
{
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 6,
"rule_name": "My Rule"
},
{
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 7,
"rule_name": "My Rule"
},
{
"action": "SMS",
"action_address": "+61298441484",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 8,
"rule_name": "My Rule"
},
{
"action": "URL",
"action_address": "+61298441485",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 9,
"rule_name": "My Rule"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 5,
"total": 5
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your list of rule incoming sms receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List rules",
"tags": [
"Automation Rules"
]
},
"post": {
"description": "",
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_new_ruleBody2"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 3,
"receipt_rule_id": 10,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your new SMS receipt has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a new rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/sms/receipts/{receipt_rule_id}": {
"delete": {
"description": "",
"parameters": [
{
"description": "Receipt Rule ID.",
"example": "7",
"in": "path",
"name": "receipt_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming sms receipt has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a rule",
"tags": [
"Automation Rules"
]
},
"get": {
"description": "",
"parameters": [
{
"description": "Receipt Rule ID.",
"example": "2",
"in": "path",
"name": "receipt_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 6,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming voice receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific rule",
"tags": [
"Automation Rules"
]
},
"put": {
"description": "",
"parameters": [
{
"description": "Receipt Rule ID.",
"example": "7",
"in": "path",
"name": "receipt_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_new_ruleBody2"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 0,
"receipt_rule_id": 7,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming sms receipt has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update a rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/voice/receipts": {
"get": {
"description": "",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 3,
"receipt_rule_id": 2,
"rule_name": "My Rule 2"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your voice receipts."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List rules",
"tags": [
"Automation Rules"
]
},
"post": {
"description": "",
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_new_ruleBody2"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 3,
"receipt_rule_id": 3,
"rule_name": "My Rule"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your new voice receipt has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a new rule",
"tags": [
"Automation Rules"
]
}
},
"/automations/voice/receipts/{receipt_rule_id}": {
"delete": {
"description": "",
"parameters": [
{
"description": "Receipt Rule ID.",
"example": "2",
"in": "path",
"name": "receipt_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule voice receipt has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a rule",
"tags": [
"Automation Rules"
]
},
"get": {
"description": "",
"parameters": [
{
"description": "Receipt Rule ID.",
"example": "2",
"in": "path",
"name": "receipt_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 3,
"receipt_rule_id": 2,
"rule_name": "My Rule 2"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming voice receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific rule",
"tags": [
"Automation Rules"
]
},
"put": {
"description": "",
"parameters": [
{
"description": "Receipt Rule ID.",
"example": "2",
"in": "path",
"name": "receipt_rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_new_ruleBody2"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"action": "URL",
"action_address": "http://yourdomain.com",
"enabled": 1,
"match_type": 3,
"receipt_rule_id": 2,
"rule_name": "My Rule 2"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your rule incoming voice receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update a rule",
"tags": [
"Automation Rules"
]
}
},
"/contact-suggestions": {
"get": {
"description": "",
"operationId": "List Contact Suggestions",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 4,
"custom_1": "Custom A 1",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 5,
"custom_1": "Custom A 2",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 6,
"custom_1": "Custom A 3",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 7,
"custom_1": "Custom A 4",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 8,
"custom_1": "Custom A 5",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 9,
"custom_1": "Custom A 6",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 10,
"custom_1": "Custom A 7",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": "Altavista",
"address_country": "AU",
"address_line_1": "3842",
"address_line_2": "Worley Avenue",
"address_postal_code": "24517",
"address_state": "VA",
"contact_id": 11,
"custom_1": "Custom A 8",
"custom_2": "Custom B 1",
"custom_3": "Custom C 1",
"custom_4": "Custom D 1",
"date_added": "1462856443",
"email": "johndoe1@gmail.com",
"fax_number": "+61298444214",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Organization 1",
"phone_number": "+61298444214"
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your results."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List Contact Suggestions",
"tags": [
"Contact Suggestions"
]
}
},
"/countries": {
"get": {
"description": "",
"operationId": "Get all Countries",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"code": "AF",
"value": "Afghanistan"
},
{
"code": "AU",
"value": "Australia"
},
{
"code": "FI",
"value": "Finland"
},
{
"code": "FR",
"value": "France"
},
{
"code": "AE",
"value": "United Arab Emirates"
},
{
"code": "GB",
"value": "United Kingdom"
},
{
"code": "US",
"value": "United States of America"
},
{
"code": "ZW",
"value": "Zimbabwe"
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of Countries."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Countries",
"tags": [
"Countries"
]
}
},
"/delivery-issues": {
"get": {
"description": "",
"operationId": "Get Delivery Issues",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"client_comments": null,
"date_added": 1481610495,
"description": "this is a test.",
"email_address": "test@user.com",
"issue_id": 1,
"message_id": "B388828B-AD46-4366-8AD3-0305FF5E3FE5",
"resolved": 0,
"status": null,
"support_comments": null,
"type": "sms",
"user_id": 3820
},
{
"client_comments": null,
"date_added": 1481610523,
"description": "this is a test.",
"email_address": "test@user.com",
"issue_id": 2,
"message_id": "90396A38-146B-46C4-A455-675F620C2E05",
"resolved": 0,
"status": null,
"support_comments": null,
"type": "sms",
"user_id": 3820
},
{
"client_comments": null,
"date_added": 1481611389,
"description": "this is a test.",
"email_address": "test@user.com",
"issue_id": 3,
"message_id": "4ECFB6CB-0300-45EC-96E1-5AB189432AF5",
"resolved": 0,
"status": null,
"support_comments": null,
"type": "sms",
"user_id": 3820
},
{
"client_comments": null,
"date_added": 1481611467,
"description": "this is a test.",
"email_address": "test@user.com",
"issue_id": 4,
"message_id": "test",
"resolved": 0,
"status": null,
"support_comments": null,
"type": "sms",
"user_id": 3820
},
{
"client_comments": null,
"date_added": 1481614516,
"description": "this is a test.",
"email_address": "test@user.com",
"issue_id": 5,
"message_id": "test",
"resolved": 0,
"status": null,
"support_comments": null,
"type": "SMS",
"user_id": 3820
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 7,
"total": 5
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Delivery Issues",
"tags": [
"Delivery Issues"
]
},
"post": {
"description": "",
"operationId": "Create Delivery Issue",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"client_comments": "test",
"description": "This is a test",
"email_address": "john_doe@user.com",
"message_id": "B388828B-AD46-4366-8AD3-0305FF5E3FE5",
"type": "SMS"
},
"properties": {
"client_comments": {
"description": "The user's comments.",
"type": "string"
},
"description": {
"description": "The description of the message.",
"type": "string"
},
"email_address": {
"description": "The user's email address.",
"type": "string"
},
"message_id": {
"description": "The message id of the message.",
"type": "string"
},
"type": {
"description": "The type of message, must be one of the following values: `SMS`, `MMS`, `VOICE`, `EMAIL_MARKETING`, `EMAIL_TRANSACTIONAL`, `FAX`, `POST`.",
"type": "string"
}
},
"required": [
"message_id",
"type",
"description",
"email_address"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"date_added": 1481617579,
"description": "this is a test.",
"email_address": "john_doe@user.com",
"issue_id": 9,
"message_id": "B388828B-AD46-4366-8AD3-0305FF5E3FE5",
"type": "SMS",
"user_id": 3820
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Delivery issue has been created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create Delivery Issue",
"tags": [
"Delivery Issues"
]
}
},
"/email-campaigns": {
"get": {
"description": "",
"operationId": "Get All Email Campaigns",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"abuse_count": 0,
"click_count": 0,
"custom_string": "",
"date_added": "1455586793",
"email_campaign_id": 64,
"from_email_address_id": 2,
"from_name": "Test name",
"hard_bounce_count": 0,
"list_id": 443,
"name": "test email",
"open_count": 5,
"schedule": "",
"send_count": 0,
"soft_bounce_count": 0,
"status": "Sent",
"subaccount_id": 1038,
"subject": "My test subject",
"template_id": 24,
"unsubscribe_count": 0,
"user_id": 1201
},
{
"abuse_count": 0,
"click_count": 0,
"custom_string": "",
"date_added": "1455586848",
"email_campaign_id": 65,
"from_email_address_id": 2,
"from_name": "Test name",
"hard_bounce_count": 0,
"list_id": 443,
"name": "test email",
"open_count": 0,
"schedule": "",
"send_count": 0,
"soft_bounce_count": 0,
"status": "Queued",
"subaccount_id": 1038,
"subject": "My test subject",
"template_id": 24,
"unsubscribe_count": 0,
"user_id": 1201
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 5,
"total": 5
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your email campaigns"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get All Email Campaigns",
"tags": [
"Email Marketing"
]
}
},
"/email-campaigns/price": {
"post": {
"description": "",
"operationId": "Calculate Price",
"requestBody": {
"$ref": "#/components/requestBodies/Create_Email_CampaignBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"data": {
"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
},
"queued_count": 2,
"total_count": 6,
"total_price": "0.0066"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Total price for email campaign."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Calculate Price",
"tags": [
"Email Marketing"
]
}
},
"/email-campaigns/send": {
"post": {
"description": "",
"operationId": "Create Email Campaign",
"requestBody": {
"$ref": "#/components/requestBodies/Create_Email_CampaignBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"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."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create Email Campaign",
"tags": [
"Email Marketing"
]
}
},
"/email-campaigns/{campaign_id}/history": {
"get": {
"description": "",
"operationId": "Get Specific Email Campaign History",
"parameters": [
{
"description": "The email campaign id you want to access.",
"example": "77",
"in": "path",
"name": "campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"click_count": 0,
"contact_id": 669105,
"email_campaign_id": 77,
"from_address": "4",
"from_name": "test name",
"hard_bounce_count": 13,
"message_id": "7CB3227C-7F8C-4A72-A0CB-36283236D99F",
"open_count": 0,
"processed_at": null,
"soft_bounce_count": 1,
"status": "SpamReport",
"subject": "tet subject",
"to_address": "test2@test.com",
"to_name": "test2@test.com"
},
{
"click_count": 0,
"contact_id": 669104,
"email_campaign_id": 77,
"from_address": "4",
"from_name": "test name",
"hard_bounce_count": 0,
"message_id": "603C5349-5A24-40B4-89ED-F7619F7CC8A3",
"open_count": 0,
"processed_at": null,
"soft_bounce_count": 0,
"status": null,
"subject": "tet subject",
"to_address": "test@test.com",
"to_name": "test@test.com"
},
{
"click_count": 0,
"contact_id": 669105,
"email_campaign_id": 77,
"from_address": "4",
"from_name": "test name",
"hard_bounce_count": 0,
"message_id": "5C5C0918-B263-42AA-8B5D-9E8ACECC0C64",
"open_count": 0,
"processed_at": null,
"soft_bounce_count": 0,
"status": null,
"subject": "tet subject",
"to_address": "test2@test.com",
"to_name": "test2@test.com"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 3,
"total": 3
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Email Campaign History",
"tags": [
"Email Marketing"
]
}
},
"/email-campaigns/{email_campaign_id}": {
"get": {
"description": "",
"operationId": "Get Specific Email Campaign",
"parameters": [
{
"description": "The email campaign id you want to access.",
"example": "1",
"in": "path",
"name": "email_campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"abuse_count": 0,
"body": "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">\n<html><body><p>This is a test</p></body></html>\n",
"body_plain_text": "This is a test",
"click_count": 0,
"custom_string": "",
"date_added": "1455586793",
"email_campaign_id": 64,
"from_email_address_id": 2,
"from_name": "Test name",
"hard_bounce_count": 0,
"list_id": 443,
"name": "test email",
"open_count": 5,
"schedule": "",
"send_count": 0,
"soft_bounce_count": 0,
"status": "Sent",
"subaccount_id": 1038,
"subject": "My test subject",
"template_id": 24,
"unsubscribe_count": 0,
"user_id": 1201
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your email campaign."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Email Campaign",
"tags": [
"Email Marketing"
]
},
"put": {
"description": "",
"operationId": "Update Email Campaign",
"parameters": [
{
"description": "The email campaign id you want to access.",
"example": "1",
"in": "path",
"name": "email_campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"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
},
"properties": {
"from_email_address_id": {
"description": "The allowed email address id.",
"type": "number"
},
"from_name": {
"description": "The name that will appear on the email.",
"type": "string"
},
"list_id": {
"description": "The list id you want to access.",
"type": "number"
},
"name": {
"description": "The name of the sender.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Will replace existing schedule (even if left blank). Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"subject": {
"description": "The subject of the email campaign.",
"type": "string"
},
"template_id": {
"description": "The template id you want to use.",
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"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": "13213213212",
"send_count": 0,
"soft_bounce_count": 0,
"status": "Scheduled",
"subaccount_id": 1038,
"subject": "Lorem Ipsum",
"template_id": 31,
"unsubscribe_count": 0,
"user_id": 1201
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Email campaign has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update Email Campaign",
"tags": [
"Email Marketing"
]
}
},
"/email-campaigns/{email_campaign_id}/cancel": {
"put": {
"description": "",
"operationId": "Cancel Email Campaign",
"parameters": [
{
"description": "The email campaign id you want to cancel.",
"example": "1",
"in": "path",
"name": "email_campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"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": "13213213212",
"send_count": 0,
"soft_bounce_count": 0,
"status": "Cancelled",
"subaccount_id": 1038,
"subject": "Lorem Ipsum",
"template_id": 31,
"unsubscribe_count": 0,
"user_id": 1201
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Email campaign has been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel Email Campaign",
"tags": [
"Email Marketing"
]
}
},
"/email/address-verify/{email_address_id}/send": {
"put": {
"description": "",
"operationId": "Send Verification Token",
"parameters": [
{
"description": "The email addess id you want to access.",
"example": "1",
"in": "path",
"name": "email_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": null,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Verification email has been sent."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Send Verification Token",
"tags": [
"Email Marketing"
]
}
},
"/email/address-verify/{email_address_id}/verify/{activation_token}": {
"put": {
"description": "",
"operationId": "Verify Allowed Email Address",
"parameters": [
{
"description": "The email address id you want to access.",
"example": "5",
"in": "path",
"name": "email_address_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "6E8B-4FDB-99A7-7ED08DF97BCC (required, string) - Your activation token.",
"example": "3BD73304",
"in": "path",
"name": "activation_token",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"date_added": "1458009394",
"email_address": "test222@user.com",
"email_address_id": 5,
"verified": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Email address verified."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Verify Allowed Email Address",
"tags": [
"Email Marketing"
]
}
},
"/email/addresses": {
"get": {
"description": "",
"operationId": "Get All Allowed Email Addresses",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"date_added": "1447736880",
"email_address": "test@user.com",
"email_address_id": 2,
"verified": 1
},
{
"date_added": "1449042967",
"email_address": "test2@user.com",
"email_address_id": 3,
"verified": 0
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your email addresses"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get All Allowed Email Addresses",
"tags": [
"Email Marketing"
]
},
"post": {
"description": "",
"operationId": "Create Allowed Email Address",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"Body": "",
"email_address": "johndoe1@user.com"
},
"properties": {
"Body": {
"description": "{\n \"email_address\" : \"test222@user.com\"\n}",
"type": "string"
},
"email_address": {
"description": "Your email.",
"type": "string"
}
},
"required": [
"email_address"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"date_added": "1458009394",
"email_address": "test222@user.com",
"email_address_id": 5,
"verified": 0
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Email address has been created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create Allowed Email Address",
"tags": [
"Email Marketing"
]
}
},
"/email/addresses/{email_address_id}": {
"delete": {
"description": "",
"operationId": "Delete Allowed Email Address",
"parameters": [
{
"description": "The email address you want to access.",
"example": "5",
"in": "path",
"name": "email_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": null,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Email address deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete Allowed Email Address",
"tags": [
"Email Marketing"
]
},
"get": {
"description": "",
"operationId": "Get Specific Allowed Email Address",
"parameters": [
{
"description": "The email address you want to access.",
"example": "4",
"in": "path",
"name": "email_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"date_added": "1449043066",
"email_address": "test3@user.com",
"email_address_id": 4,
"verified": 0
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your email address."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Allowed Email Address",
"tags": [
"Email Marketing"
]
}
},
"/email/history": {
"get": {
"description": "",
"operationId": "Email History",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_attachments": [],
"_currency": {
"currency_name_long": "Philippine Peso",
"currency_name_short": "PHP",
"currency_prefix_c": "c",
"currency_prefix_d": "?"
},
"bcc": null,
"body": "This is a test content <img src=\"cid:7c65ccc4a134a809db09a839df9b75f055afcb62@click-send.com\" />",
"body_plain_text": "This is a test content <img src=\"cid:7c65ccc4a134a809db09a839df9b75f055afcb62@click-send.com\" />",
"cc": null,
"custom_string": null,
"date_added": "1469001354",
"from_email_address_id": 2,
"from_name": "test",
"hard_bounce_count": 0,
"message_id": "BCEBC89E-6993-4F13-B485-942440C62915",
"price": "0.0000",
"schedule": "1469001353",
"soft_bounce_count": 0,
"status": "Sent",
"status_text": "Email added to outgoing mail queue for delivery",
"subaccount_id": 1039,
"subject": "test email transaction",
"to": [
{
"email": "test1@user.com"
}
],
"user_id": 1201
},
{
"_attachments": [
{
"_attachment_file_url": "https://rest.clicksend.com/files/B5664FA5-CEBD-40B0-BED1-5CFF0CA027BD.jpg",
"content_disposition": "attachment",
"content_id": "<cid:PHP-CID-5b3eb73f50a7cf7f423dc97070bb3b5280312308>",
"content_type": "image/jpeg",
"file_name": "test.jpg"
}
],
"_currency": {
"currency_name_long": "Philippine Peso",
"currency_name_short": "PHP",
"currency_prefix_c": "c",
"currency_prefix_d": "?"
},
"bcc": null,
"body": "This is a test content",
"body_plain_text": "This is a test content",
"cc": null,
"custom_string": null,
"date_added": "1469002942",
"from_email_address_id": 2,
"from_name": "test",
"hard_bounce_count": 0,
"message_id": "988067DE-9318-448F-B225-7A5A695B23D1",
"price": "0.0822",
"schedule": "1469002942",
"soft_bounce_count": 0,
"status": "Queued:WaitSend",
"status_text": null,
"subaccount_id": 1039,
"subject": "test email transaction",
"to": [
{
"email": "test1@user.com"
}
],
"user_id": 1201
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Email History",
"tags": [
"Transactional Email"
]
}
},
"/email/history/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export History",
"parameters": [
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export History",
"tags": [
"Transactional Email"
]
}
},
"/email/master-templates": {
"get": {
"description": "",
"operationId": "Get All Master Email Templates",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"date_added": "1458182912",
"template_id_master": 57,
"template_name": "Basic 2",
"thumbnail": {
"large": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/basic2/thumb-large.jpg",
"small": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/basic2/thumb-small.jpg"
}
},
{
"date_added": "1445848821",
"template_id_master": 1,
"template_name": "Minty",
"thumbnail": {
"large": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/minty/thumb-large.jpg",
"small": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/minty/thumb-small.jpg"
}
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of Email Master Templates"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get All Master Email Templates",
"tags": [
"Email Marketing"
]
}
},
"/email/master-templates-categories": {
"get": {
"description": "",
"operationId": "Get All Master Template Categories",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"category_id": 2,
"name": "Alerts/Notificartions"
},
{
"category_id": 3,
"name": "Art"
},
{
"category_id": 4,
"name": "Birthday"
},
{
"category_id": 23,
"name": "Blank Template"
},
{
"category_id": 5,
"name": "Coupons"
},
{
"category_id": 6,
"name": "eCommerce"
},
{
"category_id": 7,
"name": "Education"
},
{
"category_id": 8,
"name": "Events/Reminders"
},
{
"category_id": 1,
"name": "Featured"
},
{
"category_id": 9,
"name": "Fitness"
},
{
"category_id": 11,
"name": "Holiday/Travel"
},
{
"category_id": 12,
"name": "Inspirational"
},
{
"category_id": 13,
"name": "Kids"
},
{
"category_id": 14,
"name": "Music"
},
{
"category_id": 15,
"name": "Newsletters"
},
{
"category_id": 16,
"name": "Non-profit"
},
{
"category_id": 17,
"name": "Photography"
},
{
"category_id": 18,
"name": "Real Estate"
},
{
"category_id": 10,
"name": "Restaurant/Food"
},
{
"category_id": 21,
"name": "Sports"
},
{
"category_id": 22,
"name": "Stationery"
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of Email Categories"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get All Master Template Categories",
"tags": [
"Email Marketing"
]
}
},
"/email/master-templates-categories/{category_id}": {
"get": {
"description": "",
"operationId": "Get Specific Email Template Category",
"parameters": [
{
"description": "Your category id.",
"example": "25",
"in": "path",
"name": "category_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"category_id": 4,
"name": "Birthday"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of Email Categories"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Email Template Category",
"tags": [
"Email Marketing"
]
}
},
"/email/master-templates-categories/{category_id}/master-templates": {
"get": {
"description": "",
"operationId": "Get All Templates For Category",
"parameters": [
{
"description": "Your category id.",
"example": "1",
"in": "path",
"name": "category_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"body": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" ...\n </tr>\n </tbody>\n </table>\n </td>\n </tr>\n </tbody>\n </table>\n</body>\n</html>",
"category_id": 1,
"date_added": "1445848821",
"template_id_master": 1,
"template_name": "Minty",
"thumbnail": {
"large": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/minty/thumb-large.jpg",
"small": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/minty/thumb-small.jpg"
}
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of Email Templates By Category"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get All Templates For Category",
"tags": [
"Email Marketing"
]
}
},
"/email/master-templates/{template_id}": {
"get": {
"description": "",
"operationId": "Get Specific Master Template",
"parameters": [
{
"description": "Your template id.",
"example": "25",
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"date_added": "1458182912",
"template_id_master": 57,
"template_name": "Basic 2",
"thumbnail": {
"large": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/basic2/thumb-large.jpg",
"small": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-master/basic2/thumb-small.jpg"
}
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your email template"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Master Template",
"tags": [
"Email Marketing"
]
}
},
"/email/price": {
"post": {
"description": "",
"operationId": "Email Price",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"attachments": [
{
"content": "<string>",
"content_id": "<string>",
"disposition": "<string>",
"filename": "<string>",
"type": "<string>"
}
],
"bcc": [
{
"email": "<string>",
"name": "<string>"
}
],
"body": "<string>|required",
"cc": [
{
"email": "<string>",
"name": "<string>"
}
],
"from": {
"email_address_id": "<integer>|required",
"name": "<string>"
},
"schedule": "<integer>",
"subject": "<string>|required",
"to": [
{
"email": "<string>|required",
"name": "<string>"
}
]
},
"properties": {
"attachments": {
"description": "The attachments of the email. See sample request for more details.",
"items": {},
"type": "array"
},
"bcc": {
"description": "The bcc of the email. See sample request for more details.",
"items": {},
"type": "array"
},
"body": {
"description": "The content of the email.",
"type": "string"
},
"cc": {
"description": "The cc of the email. See sample request for more details.",
"items": {},
"type": "array"
},
"from.email_address_id": {
"description": "The sender's email address id.",
"type": "number"
},
"from.name": {
"description": "The sender's name.",
"type": "string"
},
"subject": {
"description": "The subject of the email.",
"type": "string"
},
"to": {
"description": "The recipients of the email. See sample request for more details.",
"items": {},
"type": "array"
}
},
"required": [
"to",
"subject",
"from.email_address_id",
"body",
"attachments"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"bcc_array": null,
"body": "This is a test <img src='cid:test'/>",
"cc_array": [
{
"email": "user1@test.com",
"name": "cc1"
}
],
"price": 0.002,
"subject": "test subject",
"to_array": [
{
"email": "test@user",
"name": "user1"
}
]
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here's the email price."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Email Price",
"tags": [
"Transactional Email"
]
}
},
"/email/receipts": {
"post": {
"description": "",
"requestBody": {
"$ref": "#/components/requestBodies/Add_a_Test_Delivery_ReceiptBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"email": "john_doe@user.com",
"message_id": "73A80623-CFC3-4E7F-856A-880B289242D7@clicksend.com",
"status": "Delivered",
"timestamp": 1476870832
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Receipt has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Add a Test Delivery Receipt",
"tags": [
"Transactional Email"
]
}
},
"/email/send": {
"post": {
"description": "",
"operationId": "Email Send",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"attachments": [
{
"content": "ZmlsZSBjb250ZW50cw==",
"content_id": "text",
"disposition": "attachment",
"filename": "text.txt",
"type": "text/plain"
}
],
"bcc": [
{
"email": "test3@clicksend.com",
"name": "Joseph Doe"
}
],
"body": "Lorem ipsum",
"cc": [
{
"email": "test2@clicksend.com",
"name": "Jane Doe"
}
],
"from": {
"email_address_id": 1,
"name": "Joanne Doe"
},
"subject": "Test subject",
"to": [
{
"email": "test@clicksend.com",
"name": "John Doe"
}
]
},
"properties": {
"attachments": {
"description": "The attachments of the email.",
"items": {},
"type": "array"
},
"bcc": {
"description": "The bcc of the email. Follows the same structure as `to`.",
"items": {},
"type": "array"
},
"body": {
"description": "The content of the email.",
"type": "string"
},
"cc": {
"description": "The cc of the email. Follows the same structure as `to`.",
"items": {},
"type": "array"
},
"from.email_address_id": {
"description": "The sender's email address ID.",
"type": "number"
},
"from.name": {
"description": "The sender's name.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"to": {
"description": "The recipients of the email.",
"items": {},
"type": "array"
}
},
"required": [
"to",
"from.email_address_id",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_attachments": [
{
"_attachment_file_url": "https://rest.clicksend.com/files/3C2284DC-7C37-47BA-8C95-3F12A4B987B7.txt",
"content_disposition": "attachment",
"content_id": "text",
"content_type": "text/plain",
"file_name": "text.txt"
}
],
"_currency": {
"currency_name_long": "British Pounds",
"currency_name_short": "GBP",
"currency_prefix_c": "p",
"currency_prefix_d": "£"
},
"bcc": [
{
"email": "test3@clicksend.com",
"name": "Joseph Doe"
}
],
"body": "Lorem ipsum",
"body_plain_text": "Lorem ipsum",
"cc": [
{
"email": "test2@clicksend.com",
"name": "Jane Doe"
}
],
"custom_string": null,
"date_added": 1507018182,
"from_email_address_id": 1,
"from_name": "Joanne Doe",
"hard_bounce_count": 0,
"message_id": "21C632C1-3FCC-4EFF-8191-6079244F0142",
"price": "0.0050",
"schedule": 1507018182,
"soft_bounce_count": 0,
"status": "WaitApproval",
"status_text": "Accepted for delivery",
"subaccount_id": 1,
"subject": "Test subject",
"to": [
{
"email": "test@clicksend.com",
"name": "John Doe"
}
],
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Transactional email queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Email Send",
"tags": [
"Transactional Email"
]
}
},
"/email/templates": {
"get": {
"description": "",
"operationId": "Get All Email Templates",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"template_id": 281,
"template_name": "Test"
},
{
"template_id": 290,
"template_name": "Minions"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your email templates."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get All Email Templates",
"tags": [
"Email Marketing"
]
},
"post": {
"description": "",
"operationId": "Create New Email Template from Master Template",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"template_id_master": 57,
"template_name": "Minions"
},
"properties": {
"template_id_master": {
"description": "The ID of the master template you want to base on.",
"type": "number"
},
"template_name": {
"description": "The intended name for the new template.",
"type": "string"
}
},
"required": [
"template_name",
"template_id_master"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "<div id=\"nb_wrapper\"><!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"...",
"template_id": 292,
"template_id_master": 57,
"template_name": "new minion template!"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New email template has been saved."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create New Email Template from Master Template",
"tags": [
"Email Marketing"
]
}
},
"/email/templates-images/{template_id}": {
"post": {
"description": "",
"operationId": "Upload Image to Specific Template",
"parameters": [
{
"description": "Your template id.",
"example": "1",
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"image": "image.png",
"url": "http://yourdomain.com/image.png"
},
"properties": {
"image": {
"description": "Uploads your selected image file.",
"type": "string"
},
"url": {
"description": "Uploads the image from the supplied URL.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_email-marketing/_templates-user/BEC51696-E923-4998-9249-C9B49DB7571A/2056F933-9C64-4E57-AB19-01F65EBB7C0A.png",
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your uploaded image."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Upload Image to Specific Template",
"tags": [
"Email Marketing"
]
}
},
"/email/templates/{template_id}": {
"delete": {
"description": "",
"operationId": "Delete Email Template",
"parameters": [
{
"description": "Your template id.",
"example": "25",
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your email template has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete Email Template",
"tags": [
"Email Marketing"
]
},
"get": {
"description": "",
"operationId": "Get Specific Email Template",
"parameters": [
{
"description": "The email template id.",
"example": "291",
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "<div id=\"nb_wrapper\"><!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"> \n<html xmlns:v=\"urn:schemas-microsoft-com:vml\">\n<head>\n\n <!-- Define Charset -->\n ...",
"template_id": 281,
"template_id_master": 11,
"template_name": "Test"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your email template."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Email Template",
"tags": [
"Email Marketing"
]
},
"put": {
"description": "",
"operationId": "Update an Email Template",
"parameters": [
{
"description": "The id of the template to be updated.",
"example": "291",
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"body": {
"description": "Your template body.",
"type": "string"
},
"template_name": {
"description": "The intended name for the new template.",
"type": "string"
}
},
"required": [
"template_name",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "This is the new body of your template",
"template_id": 281,
"template_id_master": 11,
"template_name": "NewTemplate"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your email template has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Update an Email Template",
"tags": [
"Email Marketing"
]
}
},
"/fax/history/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export Fax History",
"parameters": [
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export Fax History",
"tags": [
"Fax"
]
}
},
"/fax/history?date_from={date_from}&date_to={date_to}&q={q}&order_by={order_by}": {
"get": {
"description": "Get a list of Fax History.",
"operationId": "Get Fax History",
"parameters": [
{
"description": "Customize result by setting from date (timestsamp)",
"example": "1457572619",
"in": "path",
"name": "date_from",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Customize result by setting to date (timestamp)",
"example": "1457573000",
"in": "path",
"name": "date_to",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Custom query",
"example": "status:Sent,status_code:201",
"in": "path",
"name": "q",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Order result by",
"example": "subject:desc",
"in": "path",
"name": "order_by",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_api_username": "username",
"_file_url": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/document.pdf",
"carrier": "",
"country": "AU",
"custom_string": "custom_string",
"date": null,
"date_added": 1457572619,
"from": "+61267132168",
"from_email": null,
"list_id": null,
"message_id": "2FDA7622-FC6E-4D21-B335-32FF860D7E19",
"message_pages": "6.00",
"message_price": "13.2000",
"schedule": "1436874701",
"status": "Sent",
"status_code": "201",
"status_text": "Sent",
"subaccount_id": 1,
"to": "+61261111115",
"user_id": 1
},
{
"_api_username": "username",
"_file_url": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/document.pdf",
"carrier": "",
"country": "AU",
"custom_string": "custom_string",
"date": null,
"date_added": 1457586514,
"from": "+61267132168",
"from_email": null,
"list_id": null,
"message_id": "A6A20382-8211-46B9-8F09-E7337AE6626D",
"message_pages": "6.00",
"message_price": "13.2000",
"schedule": "1436874701",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61261111115",
"user_id": 1
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your history."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Fax History",
"tags": [
"Fax"
]
}
},
"/fax/price": {
"post": {
"description": "",
"requestBody": {
"$ref": "#/components/requestBodies/Send_FaxBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"messages": [
{
"carrier": "",
"country": "AU",
"custom_string": "custom_string",
"date_added": 1457504350,
"from": "+61298441484",
"from_email": "will@smith.com",
"list_id": null,
"message_id": "5106363A-AF38-4FB9-AF0E-B5FD38F62BDC",
"message_pages": 0,
"message_price": "0.0000",
"schedule": "1436874701",
"status": "SUCCESS",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61261111111",
"user_id": 1
},
{
"carrier": "",
"country": "AU",
"custom_string": "custom_string",
"date_added": 1457504350,
"from": "+61298441484",
"from_email": "john@doe.com",
"list_id": null,
"message_id": "6BBEB11E-CAA6-4B04-8537-63619F3D6B37",
"message_pages": 6,
"message_price": "13.2000",
"schedule": "1436874701",
"status": "SUCCESS",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61261111122",
"user_id": 1
}
],
"queued_count": 2,
"total_count": 2,
"total_price": 13.2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Fax queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Calculate Price",
"tags": [
"Fax"
]
}
},
"/fax/receipts": {
"get": {
"description": "",
"operationId": "List of Fax Delivery Receipts",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"custom_string": "",
"error_code": "",
"error_text": "",
"message_id": "88AB118E-EB1B-478C-98CE-6C73ABA23F67",
"message_type": "fax",
"status_code": "Completed",
"status_text": "",
"subaccount_id": 1,
"timestamp": "1451200622",
"timestamp_send": "1450854013"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your delivery receipts."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List of Fax Delivery Receipts",
"tags": [
"Fax"
]
},
"post": {
"description": "",
"operationId": "Add a Test Delivery Receipt",
"requestBody": {
"$ref": "#/components/requestBodies/Add_a_Test_Delivery_ReceiptBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"custom_string": null,
"error_code": null,
"error_text": null,
"message_id": "493FFB41-9733-4641-985F-BD79A067B58F",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"timestamp": "1441958441"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Receipt has been added"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Add a Test Delivery Receipt",
"tags": [
"Fax"
]
}
},
"/fax/receipts-read": {
"put": {
"description": "",
"operationId": "Mark Fax Delivery Receipts as read",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"date_before": 1441958441
},
"properties": {
"date_before": {
"description": "An optional [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp) - mark all as read before this timestamp. If not given, all receipts will be marked as read.",
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Receipts has been marked as read."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Mark Fax Delivery Receipts as read",
"tags": [
"Fax"
]
}
},
"/fax/receipts/{message_id}": {
"get": {
"description": "",
"operationId": "Get a Specific Fax Delivery Receipt",
"parameters": [
{
"description": "D2AF-479B-8955-6395D561DEF4\" (required, number) - Message ID.",
"example": "\"3FAC74F1",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"carrier": "",
"country": "AU",
"custom_string": "custom_string",
"date_added": 1454394659,
"from": "+61267132168",
"list_id": null,
"message_id": "3FAC74F1-D2AF-479B-8955-6395D561DEF4",
"message_pages": "1.00",
"message_price": "1.000000",
"schedule": "1436874701",
"status": "WaitApproval",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61267132168",
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your fax receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a Specific Fax Delivery Receipt",
"tags": [
"Fax"
]
}
},
"/fax/send": {
"post": {
"description": "**Letter File Options**\n\n**Use existing URL**\n\nWith this option, you can use an existing URL to a PDF document. For example, you might generate the pdf on your server.\n\n**Upload File to Our Server**\n\nWith this option, you can use the `/uploads` endpoint to upload the document. The `/uploads` endpoint returns a URL that can be used in the `/fax/send` endpoint.",
"operationId": "Send Fax",
"requestBody": {
"$ref": "#/components/requestBodies/Send_FaxBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"messages": [
{
"carrier": "",
"country": "AU",
"custom_string": "custom_string",
"date_added": 1457504350,
"from": "+61298441484",
"from_email": "will@smith.com",
"list_id": null,
"message_id": "5106363A-AF38-4FB9-AF0E-B5FD38F62BDC",
"message_pages": 0,
"message_price": "0.0000",
"schedule": "1436874701",
"status": "SUCCESS",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61261111111",
"user_id": 1
},
{
"carrier": "",
"country": "AU",
"custom_string": "custom_string",
"date_added": 1457504350,
"from": "+61298441484",
"from_email": "john@doe.com",
"list_id": null,
"message_id": "6BBEB11E-CAA6-4B04-8537-63619F3D6B37",
"message_pages": 6,
"message_price": "13.2000",
"schedule": "1436874701",
"status": "SUCCESS",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61261111122",
"user_id": 1
}
],
"queued_count": 2,
"total_count": 2,
"total_price": 13.2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Fax queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Send Fax",
"tags": [
"Fax"
]
}
},
"/forgot-password": {
"put": {
"description": "",
"operationId": "Forgot Password",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"username": "0F6pKiiuca"
},
"properties": {
"username": {
"description": "Your username.",
"type": "string"
}
},
"required": [
"username"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "An email notification has been sent."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Forgot Password",
"tags": [
"Forgot Account"
]
}
},
"/forgot-password/verify": {
"put": {
"description": "",
"operationId": "Verify Forgot Password",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"activation_token": "9C648BAD-EB7F-4E7E-96BC-B433140C4F1F",
"password": "0F6pKiiuca",
"subaccount_id": 54
},
"properties": {
"activation_token": {
"description": "Your email activation token.",
"type": "string"
},
"password": {
"description": "Your new password.",
"type": "string"
},
"subaccount_id": {
"description": "Your subaccount id.",
"type": "number"
}
},
"required": [
"subaccount_id",
"activation_token",
"password"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your password has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Verify Forgot Password",
"tags": [
"Forgot Account"
]
}
},
"/forgot-username": {
"put": {
"description": "",
"operationId": "Forgot Username",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"country": "US",
"phone_number": "3108147982"
},
"properties": {
"country": {
"description": "Your country. Used to format phone number. This is required if phone_number is not in international-format.",
"type": "string"
},
"email": {
"description": "Your email. This is required if phone_number is not present.",
"type": "string"
},
"phone_number": {
"description": "Your phone number. This is required if email is not present.",
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "An email notification has been sent."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Forgot Username",
"tags": [
"Forgot Account"
]
}
},
"/lists": {
"get": {
"description": "",
"operationId": "Get all Contact Lists",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_contacts_count": 0,
"list_email_id": "GHPAJCCVGMTD9BLA",
"list_id": 428,
"list_name": "List-reFSsJkvRC"
},
{
"_contacts_count": 0,
"list_email_id": "IIEXAR72O9UAZ7WW",
"list_id": 429,
"list_name": "List6eaG4lGIc9"
},
{
"_contacts_count": 0,
"list_email_id": "HSA3VWFEFCZIF2WT",
"list_id": 430,
"list_name": "ListwM4kJrQ7Db"
},
{
"_contacts_count": 0,
"list_email_id": "HSA3VWFEFCZIF2WT",
"list_id": 431,
"list_name": "ListzH6Qs6Uqh5"
},
{
"_contacts_count": 0,
"list_email_id": "3TCFYRPSW8OXRBK7",
"list_id": 432,
"list_name": "ListJaDZPg7SOy"
},
{
"_contacts_count": 0,
"list_email_id": "BCT20YT185AHVVNI",
"list_id": 433,
"list_name": "ListxseEIVS4d5"
},
{
"_contacts_count": 0,
"list_email_id": "NODYGVDCEVV9Q0CG",
"list_id": 434,
"list_name": "ListqX62zF5kan"
},
{
"_contacts_count": 0,
"list_email_id": "VCYXAZSXNZCVJIPB",
"list_id": 435,
"list_name": "ListklPbrd232Z"
},
{
"_contacts_count": 0,
"list_email_id": "KCDKIEBYPBIYQXJQ",
"list_id": 436,
"list_name": "ListFfD3OIiTwJ"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 9,
"total": 9
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Contact Lists",
"tags": [
"Contact Lists"
]
},
"post": {
"description": "",
"operationId": "Create a new contact list",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"list_name": "ListCT3QrVL4od"
},
"properties": {
"list_name": {
"description": "Your contact list name.",
"type": "string"
}
},
"required": [
"list_name"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_contacts_count": 0,
"list_email_id": "KB0LHD6WXFVHZWTR",
"list_id": 437,
"list_name": "ListCT3QrVL4od"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New list has been created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Create a new contact list",
"tags": [
"Contact Lists"
]
}
},
"/lists/{from_list_id}/contacts/{contact_id}/{to_list_id}": {
"put": {
"description": "Transfers a specific contact to another list.",
"operationId": "Transfer a Contact",
"parameters": [
{
"description": "From list id.",
"example": "428",
"in": "path",
"name": "from_list_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Contact ID.",
"example": "1",
"in": "path",
"name": "contact_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "To list id.",
"example": "429",
"in": "path",
"name": "to_list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_list_name": "List6eaG4lGIc9",
"address_city": "Nashville",
"address_country": "US",
"address_line_1": "1554 Buffalo Creek Road",
"address_line_2": null,
"address_postal_code": "37214",
"address_state": "TN",
"contact_id": 1,
"custom_1": "Custom 1",
"custom_2": "Custom 2",
"custom_3": "Custom 3",
"custom_4": "Custom 4",
"date_added": "1456721694",
"email": "john@doe.com",
"fax_number": "+61477141888",
"first_name": "John",
"last_name": "Doe",
"list_id": 429,
"organization_name": "Awesome Company",
"phone_number": "+61477141888"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Contact #1 has been transferred to List #429"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Transfer a Contact",
"tags": [
"Contacts"
]
}
},
"/lists/{list_id}": {
"delete": {
"description": "",
"operationId": "Delete a specific contact list",
"parameters": [
{
"description": "Your contact list id you want to access.",
"example": "442",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List #442 has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a specific contact list",
"tags": [
"Contact Lists"
]
},
"get": {
"description": "",
"operationId": "Get a specific contact list",
"parameters": [
{
"description": "Your contact list id you want to access.",
"example": "437",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_contacts_count": 0,
"list_email_id": "KB0LHD6WXFVHZWTR",
"list_id": 437,
"list_name": "ListCT3QrVL4od"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific contact list",
"tags": [
"Contact Lists"
]
},
"put": {
"description": "",
"operationId": "Update a specific contact list",
"parameters": [
{
"description": "Your contact list id you want to access.",
"example": "439",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"list_name": "ListlPJf33ksjP"
},
"properties": {
"list_name": {
"description": "Your new contact list name.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_contacts_count": 0,
"list_email_id": "LINDW2NHNPKHEJB6",
"list_id": 439,
"list_name": "ListlPJf33ksjP"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List #439 has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Update a specific contact list",
"tags": [
"Contact Lists"
]
}
},
"/lists/{list_id}/contacts": {
"get": {
"description": "",
"operationId": "Get all Contacts in a List",
"parameters": [
{
"description": "Your contact list id where your contacts belong.",
"example": "428",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_list_name": "List6eaG4lGIc9",
"address_city": null,
"address_country": null,
"address_line_1": null,
"address_line_2": null,
"address_postal_code": null,
"address_state": null,
"contact_id": 552786,
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"date_added": "1436157486",
"email": null,
"fax_number": null,
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": null,
"phone_number": "+16783270696"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": null,
"address_country": null,
"address_line_1": null,
"address_line_2": null,
"address_postal_code": null,
"address_state": null,
"contact_id": 552787,
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"date_added": "1436157925",
"email": null,
"fax_number": null,
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": null,
"phone_number": "+16783270697"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": null,
"address_country": null,
"address_line_1": null,
"address_line_2": null,
"address_postal_code": null,
"address_state": null,
"contact_id": 552790,
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"date_added": "1436158227",
"email": null,
"fax_number": null,
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": null,
"phone_number": "+16783271811"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": null,
"address_country": null,
"address_line_1": null,
"address_line_2": null,
"address_postal_code": null,
"address_state": null,
"contact_id": 552791,
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"date_added": "1436158297",
"email": null,
"fax_number": null,
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": null,
"phone_number": "+16783271975"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": null,
"address_country": null,
"address_line_1": null,
"address_line_2": null,
"address_postal_code": null,
"address_state": null,
"contact_id": 552789,
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"date_added": "1436158143",
"email": null,
"fax_number": null,
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": null,
"phone_number": "+16783272925"
},
{
"_list_name": "List6eaG4lGIc9",
"address_city": null,
"address_country": null,
"address_line_1": null,
"address_line_2": null,
"address_postal_code": null,
"address_state": null,
"contact_id": 552788,
"custom_1": "",
"custom_2": "",
"custom_3": "",
"custom_4": "",
"date_added": "1436158047",
"email": null,
"fax_number": null,
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": null,
"phone_number": "+16783273589"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 6,
"total": 6
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Contacts in a List",
"tags": [
"Contacts"
]
},
"post": {
"description": "Note 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.",
"operationId": "Create a new contact",
"parameters": [
{
"description": "Your contact list id where your contact be associated.",
"example": "428",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"address_city": "Nevada",
"address_country": "US",
"address_line_1": "Block 2",
"address_line_2": "Cool Bldg.",
"address_postal_code": "36063",
"address_state": "Las Vegas",
"custom_1": "Custom 1",
"custom_2": "Custom 2",
"custom_3": "Custom 3",
"custom_4": "Custom 4",
"email": "ellen@diaz.com",
"fax_number": "+16783270696",
"first_name": "Ellen",
"last_name": "Diaz",
"organization_name": "Awesome Organization",
"phone_number": "+16783270696"
},
"properties": {
"address_city": {
"description": "Contact city.",
"type": "string"
},
"address_country": {
"description": "Contact two-letter country code defined in ISO 3166.",
"type": "string"
},
"address_line_1": {
"description": "Contact address line 1.",
"type": "string"
},
"address_line_2": {
"description": "Contact address line 2.",
"type": "string"
},
"address_postal_code": {
"description": "Contact postal code.",
"type": "string"
},
"address_state": {
"description": "Contact state.",
"type": "string"
},
"custom_1": {
"description": "Contact custom 1 text.",
"type": "string"
},
"custom_2": {
"description": "Contact custom 2 text.",
"type": "string"
},
"custom_3": {
"description": "Contact custom 3 text.",
"type": "string"
},
"custom_4": {
"description": "Contact custom 4 text.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"fax_number": {
"description": "Contact fax number.",
"type": "string"
},
"first_name": {
"description": "Contact firstname.",
"type": "string"
},
"last_name": {
"description": "Contact lastname.",
"type": "string"
},
"organization_name": {
"description": "Your organization name.",
"type": "string"
},
"phone_number": {
"description": "Contact phone number in E.164 format.",
"type": "string"
}
},
"required": [
"phone_number"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_list_name": "List6eaG4lGIc9",
"address_city": "Nevada",
"address_country": "US",
"address_line_1": "Block 2",
"address_line_2": "Cool Bldg.",
"address_postal_code": "36063",
"address_state": "Las Vegas",
"contact_id": 552802,
"custom_1": "Custom 1",
"custom_2": "Custom 2",
"custom_3": "Custom 3",
"custom_4": "Custom 4",
"date_added": "1436160803",
"email": "ellen@diaz.com",
"fax_number": "+16783270696",
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": "Awesome Organization",
"phone_number": "+16783270696"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New contact has been created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Create a new contact",
"tags": [
"Contacts"
]
}
},
"/lists/{list_id}/contacts/{contact_id}": {
"delete": {
"description": "",
"operationId": "Delete a specific contact",
"parameters": [
{
"description": "Your contact list id you want to access.",
"example": "428",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Your contact id you want to access.",
"example": "552807",
"in": "path",
"name": "contact_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Contact #552807 has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a specific contact",
"tags": [
"Contacts"
]
},
"get": {
"description": "",
"operationId": "Get a specific contact",
"parameters": [
{
"description": "Your contact list id you want to access.",
"example": "428",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Your contact id you want to access.",
"example": "552802",
"in": "path",
"name": "contact_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_list_name": "List6eaG4lGIc9",
"address_city": "Nevada",
"address_country": "US",
"address_line_1": "Block 2",
"address_line_2": "Cool Bldg.",
"address_postal_code": "36063",
"address_state": "Las Vegas",
"contact_id": 552802,
"custom_1": "Custom 1",
"custom_2": "Custom 2",
"custom_3": "Custom 3",
"custom_4": "Custom 4",
"date_added": "1436160803",
"email": "ellen@diaz.com",
"fax_number": "+16783270696",
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": "Awesome Organization",
"phone_number": "+16783270696"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific contact",
"tags": [
"Contacts"
]
},
"put": {
"description": "",
"operationId": "Update a specific contact",
"parameters": [
{
"description": "Contact list id you want to access.",
"example": "428",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Contact id you want to access.",
"example": "552802",
"in": "path",
"name": "contact_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"address_city": "Nevada",
"address_country": "US",
"address_line_1": "Block 6",
"address_line_2": "Cool Bldg.",
"address_postal_code": "36063",
"address_state": "Las Vegas",
"custom_1": "Custom S72oJ9Teba",
"custom_2": "Custom NvrRJrKWeq",
"custom_3": "Custom 2ws94p1Dop",
"custom_4": "Custom Ku0AaIS5xb",
"email": "ellen@diaz.com",
"fax_number": "+16783276356",
"first_name": "Ellen",
"last_name": "Diaz",
"organization_name": "Awesome Organization",
"phone_number": "+16783275492"
},
"properties": {
"address_city": {
"description": "Contact city.",
"type": "string"
},
"address_country": {
"description": "Contact two-letter country code defined in ISO 3166.",
"type": "string"
},
"address_line_1": {
"description": "Contact address line 1.",
"type": "string"
},
"address_line_2": {
"description": "Contact address line 2.",
"type": "string"
},
"address_postal_code": {
"description": "Contact postal code.",
"type": "string"
},
"address_state": {
"description": "Contact state.",
"type": "string"
},
"custom_1": {
"description": "Contact custom 1 text.",
"type": "string"
},
"custom_2": {
"description": "Contact custom 2 text.",
"type": "string"
},
"custom_3": {
"description": "Contact custom 3 text.",
"type": "string"
},
"custom_4": {
"description": "Contact custom 4 text.",
"type": "string"
},
"email": {
"description": "Contact email.",
"type": "string"
},
"fax_number": {
"description": "Contact fax number.",
"type": "string"
},
"first_name": {
"description": "Contact firstname.",
"type": "string"
},
"last_name": {
"description": "Contact lastname.",
"type": "string"
},
"organization_name": {
"description": "Contact organization name.",
"type": "string"
},
"phone_number": {
"description": "Contact phone number in E.164 format.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_list_name": "List6eaG4lGIc9",
"address_city": "Nevada",
"address_country": "US",
"address_line_1": "Block 6",
"address_line_2": "Cool Bldg.",
"address_postal_code": "36063",
"address_state": "Las Vegas",
"contact_id": 552807,
"custom_1": "Custom S72oJ9Teba",
"custom_2": "Custom NvrRJrKWeq",
"custom_3": "Custom 2ws94p1Dop",
"custom_4": "Custom Ku0AaIS5xb",
"date_added": "1436161955",
"email": "ellen@diaz.com",
"fax_number": "+16783276356",
"first_name": "Ellen",
"last_name": "Diaz",
"list_id": 428,
"organization_name": "Awesome Organization",
"phone_number": "+16783275492"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Contact #552807 has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Update a specific contact",
"tags": [
"Contacts"
]
}
},
"/lists/{list_id}/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export Contacts List",
"parameters": [
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Automatically added",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export Contacts List",
"tags": [
"Contact Lists"
]
}
},
"/lists/{list_id}/import": {
"post": {
"description": "",
"operationId": "Import Contacts to List",
"parameters": [
{
"description": "Your contact list id you want to access.",
"example": "437",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"field_order": [
"phone",
"first_name",
"last_name",
"custom1",
"custom2",
"custom3",
"custom4",
"fax_number",
"organization_name",
"email",
"address_line_1",
"address_line_2",
"address_city",
"address_state",
"address_postal_code",
"address_country"
],
"file_url": "http://yourdomain.com/import.csv"
},
"properties": {
"field_order": {
"description": "Your field order for your contact import file.",
"items": {},
"type": "array"
},
"file_url": {
"description": "Path to your CSV import file.",
"type": "string"
}
},
"required": [
"file_url",
"field_order"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"id": "6254358460638066203",
"ids": [
"6254358460638066203"
],
"msg": "Messages put on queue."
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your file is now queued."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Import Contacts to List",
"tags": [
"Contact Lists"
]
}
},
"/lists/{list_id}/import-csv-preview": {
"post": {
"description": "Show first row of the csv import file.",
"operationId": "Show CSV Import File Preview",
"parameters": [
{
"description": "Your contact list id.",
"example": "439",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"file_url": "http://yourdomain.com/5485EA6144/79E8/import.csv"
},
"properties": {
"file_url": {
"description": "Path to your CSV import file.",
"type": "string"
}
},
"required": [
"file_url"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"row": [
"61298444214",
"John",
"Doe 1",
"Custom A 1",
"Custom B 1",
"Custom C 1",
"Custom D 1",
"61298444214",
"Organization 1",
"johndoe1@gmail.com",
"3842",
"Worley Avenue",
"Altavista",
"VA",
"24517",
"PH"
]
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your file preview."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Show CSV Import File Preview",
"tags": [
"Contact Lists"
]
}
},
"/lists/{list_id}/import-fields": {
"get": {
"description": "",
"operationId": "Get List of Acceptable Import Fields",
"parameters": [
{
"description": "Automatically added",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"field": "phone",
"label": "Phone"
},
{
"field": "first_name",
"label": "First Name"
},
{
"field": "last_name",
"label": "Last Name"
},
{
"field": "custom1",
"label": "Custom String 1"
},
{
"field": "custom2",
"label": "Custom String 2"
},
{
"field": "custom3",
"label": "Custom String 3"
},
{
"field": "custom4",
"label": "Custom String 4"
},
{
"field": "fax_number",
"label": "Fax Number"
},
{
"field": "organization_name",
"label": "Organization Name"
},
{
"field": "email",
"label": "Email"
},
{
"field": "address_line_1",
"label": "Address Line 1"
},
{
"field": "address_line_2",
"label": "Address Line 2"
},
{
"field": "address_city",
"label": "City"
},
{
"field": "address_state",
"label": "State"
},
{
"field": "address_postal_code",
"label": "Postal Code"
},
{
"field": "address_country",
"label": "Country"
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of acceptable import fields."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get List of Acceptable Import Fields",
"tags": [
"Contact Lists"
]
}
},
"/lists/{list_id}/remove-duplicates": {
"put": {
"description": "",
"operationId": "Remove Duplicate Contacts",
"parameters": [
{
"description": "Your contact list id.",
"example": "439",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"fields": [
"phone_number",
"first_name",
"last_name",
"fax_number",
"address_country"
]
},
"properties": {
"fields": {
"description": "List of Contact's fields to be used for checking.",
"items": {},
"type": "array"
}
},
"required": [
"fields"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"deleted": 6
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your list duplicate contacts has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Remove Duplicate Contacts",
"tags": [
"Contact Lists"
]
}
},
"/lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id}": {
"put": {
"description": "",
"operationId": "Remove Opted Out Contacts",
"parameters": [
{
"description": "Your contact list id.",
"example": "439",
"in": "path",
"name": "list_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Your opt out list id.",
"example": "512",
"in": "path",
"name": "opt_out_list_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"deleted": 6
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Optout contacts has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Remove Opted Out Contacts",
"tags": [
"Contacts"
]
}
},
"/mms/cancel-all": {
"put": {
"description": "",
"operationId": "Cancel All MMS",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"count": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "2 MMS have been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel All MMS",
"tags": [
"MMS"
]
}
},
"/mms/history/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export MMS History",
"parameters": [
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export MMS History",
"tags": [
"MMS"
]
}
},
"/mms/history?q={q}&order_by={order_by}&date_from={date_from}&date_to={date_to}": {
"get": {
"description": "",
"operationId": "Get MMS History",
"parameters": [
{
"description": "A custom query.",
"example": "list_id:429,direction:out",
"in": "path",
"name": "q",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Sort records by.",
"example": "subject:desc",
"in": "path",
"name": "order_by",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "[Unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp) (from) used to show records by date.",
"example": "1443501617",
"in": "path",
"name": "date_from",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "[Unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp) (to) used to show records by date.",
"example": "1443501727",
"in": "path",
"name": "date_to",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 7,
"country": "AU",
"custom_string": "",
"date_added": 1467356623,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "2453E085-C1F8-47EC-AD35-B793960B1313",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467356623",
"status": "Failed",
"status_code": "301",
"status_text": "Unable to process your MMS for sending.",
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 8,
"country": "AU",
"custom_string": "",
"date_added": 1467356623,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "54889DC7-A840-4A21-A977-EBE8C51FC2F8",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467356623",
"status": "Queued:WaitSend",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 9,
"country": "AU",
"custom_string": "",
"date_added": 1467356623,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "F2E75443-35A4-4300-9D12-E67682E762DB",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467356623",
"status": "Queued:WaitSend",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 10,
"country": "AU",
"custom_string": "",
"date_added": 1467356623,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "26B77CD6-5C98-46C7-A6DF-F76F29B7E09F",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467356623",
"status": "Queued:WaitSend",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 11,
"country": "AU",
"custom_string": "",
"date_added": 1467356623,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "70BAB69D-8EA5-417C-A8EA-7F0D843E30F3",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467356623",
"status": "Sent",
"status_code": "200",
"status_text": "Sent",
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 4,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "42E3C025-FD9D-4C9F-B374-C7DF5337F6AF",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 5,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "218D5034-89A0-4C6C-B8F9-006BEF50B92B",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 6,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "EFCF9FAA-1BCA-4C58-884A-257C0D87124E",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 7,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "3E0DC217-7D0F-4C20-A3F2-E3362B938CAF",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 8,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "7827223E-0D73-49A1-95D0-8B85C3F5CC71",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 9,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "0D902342-3873-4EE9-A86A-CA1B0B755BBA",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 10,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "0549ADFD-9D70-4B1A-B62F-875A05B481D9",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 11,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "1327677D-D2EF-4442-A0F3-B480C7E94359",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/C755FD73-AD7A-4EB8-A521-FC10BB37F3B7.gif",
"body": "This is a test message.",
"carrier": "Telstra",
"contact_id": null,
"country": "AU",
"custom_string": "",
"date_added": 1467363093,
"direction": "out",
"from": "",
"from_email": null,
"list_id": null,
"message_id": "42ABDB50-3DAE-41B5-8F48-6F227F38DB2E",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467363093",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61437887633",
"user_id": 1
},
{
"_api_username": "my_api_username",
"_media_file_url": "http://yourdomain.com/_mms/2289C892-7518-4FBB-9A1C-7C34A93F6328.gif",
"body": "This is a test message.",
"carrier": "Telstra",
"contact_id": null,
"country": "AU",
"custom_string": "",
"date_added": 1467363210,
"direction": "out",
"from": "",
"from_email": null,
"list_id": null,
"message_id": "53271F40-EEB2-4DE9-A525-F0620211A4C9",
"message_parts": "1.00",
"message_price": "2.4200",
"priority": 10,
"schedule": "1467363210",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61437887633",
"user_id": 1
}
],
"from": 1,
"last_page": 3,
"next_page_url": "/?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 31
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your history."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get MMS History",
"tags": [
"MMS"
]
}
},
"/mms/price": {
"post": {
"description": "",
"operationId": "Get Price",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"media_file": "http://yourdomain.com/tpLaX6A.gif",
"messages": [
{
"body": "This is a test body with special character: 英",
"country": "AU",
"from": "test",
"source": "php",
"subject": "This is a subject",
"to": "+61437111222"
}
]
},
"properties": {
"body": {
"description": "Your message.",
"type": "string"
},
"country": {
"description": "Recipient country.",
"type": "string"
},
"custom_string": {
"description": "Your reference. Will be passed back with all replies and delivery reports.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
},
"from_email": {
"description": "An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS.",
"type": "string"
},
"list_id": {
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'.",
"type": "number"
},
"media_file": {
"description": "Media file you want to send.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
},
"subject": {
"description": "Subject line. Maximum 20 characters.",
"type": "string"
},
"to": {
"description": "Recipient number in E.164 format or local format ([more info](https://help.clicksend.com/SMS/what-format-does-the-recipient-phone-number-need-to-be-in)).",
"type": "string"
}
},
"required": [
"media_file",
"to",
"subject",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"messages": [
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 4,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "2E7EFEC7-70FE-4E29-8F80-31A2F59003E8",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 5,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "773DE8EE-DF60-46F5-ADCB-1E28AF5B1FED",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 6,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "52774EFE-4310-4202-AE19-71FDD0086B15",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 7,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "97E06BA5-C106-40ED-ABD1-7B6CF4673278",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 8,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "5FB49B3E-FE94-4556-B5C2-5F874211A04E",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 9,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "AFAC3FCA-B05F-43E5-967F-9F78E206C2C7",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 10,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "E7C11ECB-FC96-42C1-83F9-3AA106D1A183",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/_mms/279FDB02-DC5A-449C-869A-AFB5F0E632B4.gif",
"body": "John This is a test message.",
"contact_id": 11,
"country": "AU",
"custom_string": "",
"from": "test",
"list_id": 429,
"message_id": "D84AD2E9-DE92-46E0-8A9B-14509496E644",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
}
],
"queued_count": 8,
"total_count": 8,
"total_price": 19.36
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Messages queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Get Price",
"tags": [
"MMS"
]
}
},
"/mms/receipts": {
"get": {
"description": "",
"operationId": "Get all Delivery Receipts",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"custom_string": "",
"error_code": "",
"error_text": "",
"message_id": "88AB118E-EB1B-478C-98CE-6C73ABA23F67",
"message_type": "mms",
"status_code": "Completed",
"status_text": "",
"subaccount_id": 1,
"timestamp": "1451200622",
"timestamp_send": "1450854013"
},
{
"custom_string": "",
"error_code": "",
"error_text": "",
"message_id": "88AB118E-EB1B-478C-98CE-6C73ABA23F67",
"message_type": "mms",
"status_code": "Completed",
"status_text": "",
"subaccount_id": 1,
"timestamp": "1451200622",
"timestamp_send": "1450854013"
},
{
"custom_string": "",
"error_code": "",
"error_text": "",
"message_id": "88AB118E-EB1B-478C-98CE-6C73ABA23F67",
"message_type": "mms",
"status_code": "Completed",
"status_text": "",
"subaccount_id": 1,
"timestamp": "1451200622",
"timestamp_send": "1450854013"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 3,
"total": 3
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your delivery receipts."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Delivery Receipts",
"tags": [
"MMS"
]
}
},
"/mms/receipts-read": {
"put": {
"description": "",
"operationId": "Mark Receipts As Read",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": null,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Receipts has been marked as read."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Mark Receipts As Read",
"tags": [
"MMS"
]
}
},
"/mms/receipts/{message_id}": {
"get": {
"description": "",
"operationId": "Get Delivery Receipt",
"parameters": [
{
"description": "Message ID.",
"example": "3E0DC217-7D0F-4C20-A3F2-E3362B938CAF",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
"body": "John This is a test message.",
"carrier": "",
"contact_id": 7,
"country": "AU",
"custom_string": "",
"date_added": 1467358732,
"direction": "out",
"from": "+61298444213",
"from_email": null,
"list_id": 429,
"message_id": "3E0DC217-7D0F-4C20-A3F2-E3362B938CAF",
"message_parts": "1.00",
"message_price": "2.420000",
"priority": 10,
"schedule": "1467358732",
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"subject": "This is a subject",
"to": "+61298444214",
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your MMS receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Delivery Receipt",
"tags": [
"MMS"
]
}
},
"/mms/send": {
"post": {
"description": "",
"operationId": "Send MMS",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"media_file": "http://yourdomain.com/tpLaX6A.gif",
"messages": [
{
"body": "This is a test body with special character: 英",
"country": "AU",
"from": "test",
"source": "php",
"subject": "This is a subject",
"to": "+61437111222"
}
]
},
"properties": {
"body": {
"description": "Your message.",
"type": "string"
},
"country": {
"description": "Recipient country.",
"type": "string"
},
"custom_string": {
"description": "Your reference. Will be passed back with all replies and delivery reports.",
"type": "string"
},
"from": {
"description": "The number to send from. Either leave blank or use a ClickSend number only.",
"type": "string"
},
"from_email": {
"description": "An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS.",
"type": "string"
},
"list_id": {
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'.",
"type": "number"
},
"media_file": {
"description": "Media file you want to send.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
},
"subject": {
"description": "Subject line. Maximum 20 characters.",
"type": "string"
},
"to": {
"description": "Recipient number in E.164 format or local format ([more info](https://help.clicksend.com/SMS/what-format-does-the-recipient-phone-number-need-to-be-in)).",
"type": "string"
}
},
"required": [
"media_file",
"to",
"subject",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"messages": [
{
"_media_file_url": "https://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 4,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "D7A79BF1-4806-43F8-8339-6B9F8385D9A4",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 5,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "73034A6D-4F90-4DE3-9F9B-64F228A30195",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 6,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "A1E139C1-3CB0-42C8-A8EC-070BE5FE2D06",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 7,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "D202B823-C4ED-40F8-8F6E-08BF3EAE24D2",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 8,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "50469507-2C91-4EB0-A628-DEF8A921D53C",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 9,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "AFF1D0A3-1BDC-4A4F-8290-1A112579AB88",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 10,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "81C3CB6D-FD6C-44BF-9542-46FACFC423FB",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
},
{
"_media_file_url": "http://yourdomain.com/tpLaX6A.gif",
"body": "John This is a test message.",
"contact_id": 11,
"country": "AU",
"custom_string": "",
"from": "+61298444213",
"list_id": 429,
"message_id": "55B901D2-38BD-4A3F-839C-E647FC0B4BAB",
"message_parts": 1,
"message_price": "2.4200",
"schedule": "",
"status": "SUCCESS",
"subject": "This is a subject",
"to": "+61298444214"
}
],
"queued_count": 8,
"total_count": 8,
"total_price": 19.36
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Messages queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Send MMS",
"tags": [
"MMS"
]
}
},
"/mms/{message_id}/cancel": {
"put": {
"description": "",
"operationId": "Cancel MMS",
"parameters": [
{
"description": "Message ID.",
"example": "52E3C025-FD9D-4C9F-B374-C7DF5337F6AF",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": null,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "MMS has been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel MMS",
"tags": [
"MMS"
]
}
},
"/numbers": {
"get": {
"description": "",
"operationId": "Get all Dedicated Numbers",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"current_page": 1,
"data": [
{
"_country_name": "Australia",
"country": "AU",
"dedicated_number": "+61481070206",
"price": "18.59"
},
{
"_country_name": "Australia",
"country": "AU",
"dedicated_number": "+61437887639",
"price": "18.59"
},
{
"_country_name": "Australia",
"country": "AU",
"dedicated_number": "+61481070206",
"price": "18.59"
},
{
"_country_name": "Australia",
"country": "AU",
"dedicated_number": "+61287265298",
"price": "18.59"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+19403944918",
"price": "26.94"
},
{
"_country_name": "Australia",
"country": "AU",
"dedicated_number": "+61287265842",
"price": "26.94"
},
{
"_country_name": "Australia",
"country": "AU",
"dedicated_number": "+61287265371",
"price": "26.94"
},
{
"_country_name": "Australia",
"country": "AU",
"dedicated_number": "+61287265372",
"price": "26.94"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+16062191029",
"price": "26.94"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+12282060588",
"price": "26.94"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+12282060587",
"price": "26.94"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+12282060586",
"price": "26.94"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+12282060585",
"price": "26.94"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+12282060584",
"price": "26.94"
},
{
"_country_name": "United States of America",
"country": "US",
"dedicated_number": "+12282060583",
"price": "26.94"
}
],
"from": 1,
"last_page": 2,
"next_page_url": "https://rest.clicksend.com/v3/numbers/?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 22
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are you dedicated numbers."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Dedicated Numbers",
"tags": [
"Numbers"
]
}
},
"/numbers/buy/{dedicated_number}": {
"post": {
"description": "",
"operationId": "Buy dedicated number",
"parameters": [
{
"description": "Your phone number in E.164 format.",
"example": "+12282060576",
"in": "path",
"name": "dedicated_number",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"_price_monthly": "11.11",
"_price_setup": "22.22",
"country": "US",
"dedicated_number": "+12282060576",
"price_total": "8.98"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your new number."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Buy dedicated number",
"tags": [
"Numbers"
]
}
},
"/numbers/search/{country}?{search}=1&{search_type}=2": {
"get": {
"description": "",
"operationId": "Search Dedicated Numbers by Country",
"parameters": [
{
"description": "Your preferred country.",
"example": "US",
"in": "path",
"name": "country",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Your search pattern or query.",
"example": "88",
"in": "path",
"name": "search",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with.",
"example": "1",
"in": "path",
"name": "search_type",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+12132633745",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+12134657532",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+12134657538",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777962",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777963",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777965",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777967",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777968",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777971",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777973",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777974",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777975",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777976",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777978",
"price": "26.94"
},
{
"country": "US",
"country_name": "United States of America",
"currency": "USD",
"dedicated_number": "+13235777979",
"price": "26.94"
}
],
"from": 1,
"last_page": 1490,
"next_page_url": "/?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 22346
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Search Dedicated Numbers by Country",
"tags": [
"Numbers"
]
}
},
"/post/direct-mail/campaigns": {
"get": {
"description": "Get list of direct mail campaigns.",
"operationId": "List Direct Mail Campaigns",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 3,
"data": [
{
"_areas": [
{
"campaign_id": 34,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 34,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 34,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 34,
"custom_string": null,
"date_added": 1477040355,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 35,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 35,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 35,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 35,
"custom_string": null,
"date_added": 1477040625,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [],
"_total_quantity": 0,
"campaign_id": 37,
"custom_string": null,
"date_added": 1477040829,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 38,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 38,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 38,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 38,
"custom_string": null,
"date_added": 1477040843,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 39,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 39,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 39,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 39,
"custom_string": null,
"date_added": 1477275714,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 40,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 40,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 40,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 40,
"custom_string": "Custom String",
"date_added": 1477275760,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 42,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 42,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 42,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 42,
"custom_string": "Custom String",
"date_added": 1477276756,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 43,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 43,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 43,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 43,
"custom_string": "Custom String",
"date_added": 1477276830,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 49,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 49,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 49,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 49,
"custom_string": "Custom String",
"date_added": 1477279662,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 51,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 51,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 51,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 51,
"custom_string": "Custom String",
"date_added": 1477279949,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 52,
"location_id": 1,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 52,
"location_id": 2,
"price": null,
"quantity": 100,
"status": null
},
{
"campaign_id": 52,
"location_id": 3,
"price": null,
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 52,
"custom_string": "Custom String",
"date_added": 1477280021,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 53,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 53,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 53,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 53,
"custom_string": "Custom String",
"date_added": 1477280780,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 54,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 54,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": null
},
{
"campaign_id": 54,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": null
}
],
"_total_quantity": "250",
"campaign_id": 54,
"custom_string": "Custom String",
"date_added": 1477281977,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": null,
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 55,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": "Queued"
},
{
"campaign_id": 55,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": "Queued"
},
{
"campaign_id": 55,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": "Queued"
}
],
"_total_quantity": "250",
"campaign_id": 55,
"custom_string": "Custom String",
"date_added": 1477284216,
"message_id": null,
"name": "My Campaign",
"schedule": 1477032023,
"status": "Queued",
"user_id": 1
},
{
"_areas": [
{
"campaign_id": 56,
"location_id": 1,
"price": "222.00",
"quantity": 100,
"status": "Scheduled"
},
{
"campaign_id": 56,
"location_id": 2,
"price": "222.00",
"quantity": 100,
"status": "Scheduled"
},
{
"campaign_id": 56,
"location_id": 3,
"price": "111.00",
"quantity": 50,
"status": "Scheduled"
}
],
"_total_quantity": "250",
"campaign_id": 56,
"custom_string": "Custom String",
"date_added": 1477284517,
"message_id": null,
"name": "My Campaign",
"schedule": 1477384503,
"status": "Scheduled",
"user_id": 1
}
],
"from": 31,
"last_page": 5,
"next_page_url": "https://rest.clicksend.com/v3/post/direct-mail/campaigns?page=4",
"per_page": 15,
"prev_page_url": "https://rest.clicksend.com/v3/post/direct-mail/campaigns?page=2",
"to": 45,
"total": 69
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your results."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List Direct Mail Campaigns",
"tags": [
"Post Direct Mail"
]
}
},
"/post/direct-mail/campaigns/price": {
"post": {
"description": "Calculate direct mail campaign price.",
"operationId": "Calculate Direct Mail Campaign Price",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"areas": [
{
"location_id": 22,
"quantity": 12
},
{
"location_id": 21,
"quantity": 10
},
{
"location_id": 21,
"quantity": 10
}
],
"custom_string": "Custom String",
"file_urls": [
"https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_front.pdf",
"https://rest.clicksend.com/files/F3CA1167-381B-47FE-A146-3DF87BE7EEC2.pdf"
],
"name": "My Campaign",
"schedule": 1477384503,
"size": "A5",
"source": "My Source"
},
"properties": {
"areas": {
"description": "List of location where you want to send your campaign, and the quantity per location.",
"items": {},
"type": "array"
},
"file_urls": {
"description": "Campaign file urls. You can submit max 2 file urls.",
"items": {},
"type": "array"
},
"name": {
"description": "Campaign name.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"size": {
"description": "Campaign file size. It can be A5 or DL.",
"type": "string"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
}
},
"required": [
"name",
"size",
"file_urls"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "British Pounds",
"currency_name_short": "GBP",
"currency_prefix_c": "p",
"currency_prefix_d": "£"
},
"data": {
"_areas": [
{
"campaign_id": null,
"country_code": "AU",
"country_name": "Australia",
"location_id": 22,
"place_name": "AUSTRALIA",
"postal_code": "1234",
"price": 133.2,
"quantity": 12,
"status": "Queued"
},
{
"campaign_id": null,
"country_code": "GB",
"country_name": "United Kingdom",
"location_id": 21,
"place_name": "CANDELARIA",
"postal_code": "1234",
"price": 11.1,
"quantity": 10,
"status": "Queued"
},
{
"campaign_id": null,
"country_code": "GB",
"country_name": "United Kingdom",
"location_id": 21,
"place_name": "CANDELARIA",
"postal_code": "1234",
"price": 11.1,
"quantity": 10,
"status": "Queued"
}
],
"custom_string": "Custom String",
"date_added": 1478141522,
"file_name": "79483D26-D9E3-4051-93BB-2B9AFC612F52.pdf",
"message_id": "C45638E1-62A9-4A31-AABF-E30957151BC5",
"name": "My Campaign",
"schedule": 1478141522,
"size": "A5",
"source": "My Source.rest.v3",
"status": "Queued",
"user_id": 1
},
"total_price": 155.4,
"total_quantity": 32
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New direct mail campaign created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Calculate Direct Mail Campaign Price",
"tags": [
"Post Direct Mail"
]
}
},
"/post/direct-mail/campaigns/send": {
"post": {
"description": "Create new direct mail campaign.",
"operationId": "Create New Campaign",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"areas": [
{
"location_id": 1,
"quantity": 100
},
{
"location_id": 2,
"quantity": 100
},
{
"location_id": 3,
"quantity": 50
}
],
"file_urls": [
"https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_front.pdf",
"https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_back.pdf"
],
"name": "My Campaign",
"schedule": 1477032023,
"size": "A5",
"source": "wordpress"
},
"properties": {
"areas": {
"description": "List of location where you want to send your campaign, and the quantity per location.",
"items": {},
"type": "array"
},
"file_urls": {
"description": "Campaign file urls. You can submit max 2 file urls.",
"items": {},
"type": "array"
},
"name": {
"description": "Campaign name.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"size": {
"description": "Campaign file size. It can be A5 or DL.",
"type": "string"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
}
},
"required": [
"name",
"size",
"file_urls"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "British Pounds",
"currency_name_short": "GBP",
"currency_prefix_c": "p",
"currency_prefix_d": "£"
},
"data": {
"_areas": [
{
"campaign_id": 80,
"location_id": 22,
"price": "222.00",
"status": "Scheduled"
},
{
"campaign_id": 80,
"location_id": 21,
"price": "22.20",
"status": "Scheduled"
},
{
"campaign_id": 80,
"location_id": 21,
"price": "22.20",
"status": "Scheduled"
}
],
"campaign_id": 80,
"custom_string": "Custom String",
"date_added": 1477291825,
"name": "My Campaign",
"schedule": 1477384503,
"status": "Scheduled",
"user_id": 1
},
"total_price": 266.4,
"total_quantity": 30
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New direct mail campaign created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create New Campaign",
"tags": [
"Post Direct Mail"
]
}
},
"/post/direct-mail/locations/search/{country}/?q={query}": {
"get": {
"description": "",
"operationId": "Search Locations",
"parameters": [
{
"description": "Country code.",
"example": "AD",
"in": "path",
"name": "country",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A postal code or place name.",
"example": "AD100",
"in": "path",
"name": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"accuracy": 6,
"admin_code1": "",
"admin_code2": "",
"admin_code3": "",
"admin_name1": "",
"admin_name2": "",
"admin_name3": "",
"country_code": "AD",
"latitude": "42.583300",
"location_id": 1,
"longitude": "1.666700",
"place_name": "Canillo",
"postal_code": "AD100"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here's your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Search Locations",
"tags": [
"Post Direct Mail"
]
}
},
"/post/letters/detect-address": {
"post": {
"description": "The `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 PDF should be in standard address format, having the recipient's name and address listed at the top.\n\nThe endpoint accepts two types of data:\n1. A PDF file in `base64` encoding. In this case, submit the `base64`-encoded PDF file contents in the `content` field of the request body.\n2. An address string. In this case, submit the address in a string using the `address` field of the request body.",
"operationId": "Detect Address",
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"example": {
"content": "Q29udGVudHMgb2YgZmlsZQ=="
},
"properties": {
"content": {
"description": "Your file contents encoded in `base64`.",
"type": "string"
}
},
"required": [
"content"
],
"type": "object"
},
{
"example": {
"address": "John Doe, 123 Main Street, Perth WA 6000"
},
"properties": {
"address": {
"description": "Your file contents encoded in `base64`.",
"type": "string"
}
},
"required": [
"address"
],
"type": "object"
}
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Main Street",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Detect Address",
"tags": [
"Post Address Detection"
]
}
},
"/post/letters/history": {
"get": {
"description": "",
"operationId": "Get Post Letter History",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"address_city": "DENVER",
"address_country": "AU",
"address_line_1": "130 Scheuvront Drive",
"address_line_2": null,
"address_name": "John Smith",
"address_postal_code": "80202",
"address_state": "CO",
"colour": 0,
"custom_string": null,
"date_added": 1447642486,
"duplex": 0,
"list_id": null,
"message_id": "7C0CF79F-F6E0-471D-8CC8-D7AB34A4D423",
"post_pages": 1,
"post_price": "1.100000",
"return_address_id": 4,
"schedule": null,
"source": null,
"status": "Queued:Stamped",
"status_code": "",
"status_text": "",
"subaccount_id": 1,
"user_id": 1
},
{
"address_city": "DENVER",
"address_country": "AU",
"address_line_1": "130 Scheuvront Drive",
"address_line_2": null,
"address_name": "John Smith",
"address_postal_code": "80202",
"address_state": "CO",
"colour": 0,
"custom_string": null,
"date_added": 1447645676,
"duplex": 0,
"list_id": null,
"message_id": "D7E64413-EE22-4E75-9D7D-1653AE5625CB",
"post_pages": 1,
"post_price": "1.100000",
"return_address_id": 4,
"schedule": null,
"source": null,
"status": "Queued:Stamped",
"status_code": "",
"status_text": "",
"subaccount_id": 1,
"user_id": 1
},
{
"address_city": "DENVER",
"address_country": "AU",
"address_line_1": "130 Scheuvront Drive",
"address_line_2": null,
"address_name": "John Smith",
"address_postal_code": "80202",
"address_state": "CO",
"colour": 0,
"custom_string": null,
"date_added": 1447742914,
"duplex": 0,
"list_id": null,
"message_id": "0AE161A5-8054-4E4C-B4CC-82E1CAE25D92",
"post_pages": 1,
"post_price": "1.100000",
"return_address_id": 4,
"schedule": null,
"source": null,
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"user_id": 1
},
{
"address_city": "DENVER",
"address_country": "AU",
"address_line_1": "130 Scheuvront Drive",
"address_line_2": null,
"address_name": "John Smith",
"address_postal_code": "80202",
"address_state": "CO",
"colour": 0,
"custom_string": null,
"date_added": 1447745108,
"duplex": 0,
"list_id": null,
"message_id": "F18B4ECD-7508-4694-814C-BC87028A8AAE",
"post_pages": 1,
"post_price": "1.100000",
"return_address_id": 4,
"schedule": null,
"source": null,
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"user_id": 1
},
{
"address_city": "DENVER",
"address_country": "AU",
"address_line_1": "130 Scheuvront Drive",
"address_line_2": null,
"address_name": "John Smith",
"address_postal_code": "80202",
"address_state": "CO",
"colour": 0,
"custom_string": null,
"date_added": 1447745144,
"duplex": 0,
"list_id": null,
"message_id": "8849F629-F9DB-499E-B084-5088399A51E9",
"post_pages": 1,
"post_price": "1.100000",
"return_address_id": 4,
"schedule": null,
"source": null,
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"user_id": 1
},
{
"address_city": "DENVER",
"address_country": "AU",
"address_line_1": "130 Scheuvront Drive",
"address_line_2": null,
"address_name": "John Smith",
"address_postal_code": "80202",
"address_state": "CO",
"colour": 0,
"custom_string": null,
"date_added": 1447745652,
"duplex": 0,
"list_id": null,
"message_id": "3095F46F-8ED2-49A2-B4CC-DC20786A6209",
"post_pages": 1,
"post_price": "1.100000",
"return_address_id": 4,
"schedule": null,
"source": null,
"status": "Queued",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"user_id": 1
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 6,
"total": 6
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your history."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Post Letter History",
"tags": [
"Post Letter"
]
}
},
"/post/letters/history/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export Post Letter History",
"parameters": [
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export Post Letter History",
"tags": [
"Post Letter"
]
}
},
"/post/letters/price": {
"post": {
"description": "",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"colour": 1,
"duplex": 0,
"file_url": "http://yourdomain.com/file.pdf",
"priority_post": 0,
"recipients": [
{
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "Address 2",
"address_name": "My Home Address",
"address_postal_code": 123456,
"address_state": "State",
"custom_string": "Custom kn0ChLhwn6",
"return_address_id": 1,
"schedule": 1449573604
}
],
"template_used": 1
},
"properties": {
"colour": {
"description": "Is it in colored?",
"type": "number"
},
"duplex": {
"description": "Is it in duplex?",
"type": "number"
},
"file_url": {
"description": "Your URL to your PDF file.",
"type": "string"
},
"priority_post": {
"description": "Is it priority? 0 = Not Priority, 1 = Priority.",
"type": "number"
},
"recipients": {
"description": "Your recipients.",
"items": {},
"type": "array"
},
"template_used": {
"description": "Whether you used our template or not ([More Info](http://help.clicksend.com/13996-Post/post-letter-template)).",
"type": "number"
}
},
"required": [
"file_url"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"recipients": [
{
"address_city": "DENVER",
"address_country": "AU",
"address_line_1": "131",
"address_line_2": "Scheuvront Drive",
"address_name": "John Smith",
"address_postal_code": "80202",
"address_state": "CO",
"date_added": 1449662203,
"message_id": "06FAD39C-78FD-4D2F-B606-9846D1979F35",
"post_pages": 3,
"post_price": "1.8700",
"priority_post": 0,
"return_address_id": 1,
"schedule": 1449573604,
"status": "SUCCESS",
"subaccount_id": 1,
"user_id": 1
}
],
"total_cost": 1,
"total_price": 1.87
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are some results."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Calculate Price",
"tags": [
"Post Letter"
]
}
},
"/post/letters/send": {
"post": {
"description": "**Supported File Types**\nWe 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 convert the file first using our uploads endpoint with the querystring parameter `convert=post` e.g. `POST /uploads?convert=post`. This will return a URL to the converted pdf file that can be used in the `/post/letters/send` endpoint.\n\n**Letter File Options**\n\n**Use existing URL**\n\nWith this option, you can use an existing URL to a `pdf` document. For example, you might generate the `pdf` on your server.\n\n**Upload File to Our Server**\n\nWith this option, you can use the `/uploads` endpoint to upload the document. The `/uploads` endpoint returns a URL that can be used in the `/post/letters/send` endpoint.",
"operationId": "Send Post Letter",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"colour": 1,
"duplex": 0,
"file_url": "http://yourdomain.com/file.pdf",
"priority_post": 0,
"recipients": [
{
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "Address 2",
"address_name": "My Home Address",
"address_postal_code": 123456,
"address_state": "State",
"custom_string": "Custom kn0ChLhwn6",
"return_address_id": 1,
"schedule": 1449573604
}
],
"template_used": 1
},
"properties": {
"colour": {
"description": "Is it in colour? 0 = Black and White, 1 = Colour.",
"type": "number"
},
"duplex": {
"description": "Is it in duplex? 0 = Simplex, 1 = Duplex.",
"type": "number"
},
"file_url": {
"description": "Your URL to your PDF file.",
"type": "string"
},
"priority_post": {
"description": "Is it priority? 0 = Not Priority, 1 = Priority.",
"type": "number"
},
"recipients": {
"description": "Your recipients.",
"items": {},
"type": "array"
},
"template_used": {
"description": "Whether you used our template or not ([More Info](http://help.clicksend.com/13996-Post/post-letter-template)).",
"type": "number"
}
},
"required": [
"file_url"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"queued_count": 1,
"recipients": [
{
"_api_username": "my_api_username",
"_file_url": "http://yourdomain.com/file.pdf",
"_return_address": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"colour": 1,
"custom_string": "kn0ChLhwn6",
"date_added": 1459131623,
"duplex": 0,
"message_id": "A00A1066-BBAE-432B-9B2D-E88969B12C46",
"post_pages": 7,
"post_price": "13.4200",
"priority_post": 0,
"return_address_id": 1,
"schedule": 1449573604,
"source": ".rest.v3",
"status": "SUCCESS",
"subaccount_id": 1,
"user_id": 1
}
],
"total_count": 1,
"total_price": 13.42
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Letters queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Send Post Letter",
"tags": [
"Post Letter"
]
}
},
"/post/postcards/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export Postcard History",
"parameters": [
{
"description": "Filename for the export file.",
"example": "myexport.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/705F80D0-D044-4F85-8617-081988B398E5?filename=myexport.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export Postcard History",
"tags": [
"Postcards"
]
}
},
"/post/postcards/history": {
"get": {
"description": "",
"operationId": "Get Postcard History",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/65889986-E306-4309-B229-FD9215EE1013A.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482308357,
"ip_address": "127.0.0.1",
"letter_file_name": "65889986-E306-4309-B229-FD9215EE1013A.pdf",
"list_id": null,
"message_id": "909D6F4F-FC88-4BB8-AD96-D2F4B3139301",
"message_id_supplier": "2RXWRVFFG3G8D6TB6V6P6VX7RHR7",
"post_price": "1.710000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482308357",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/2B306DC3-FD44-488B-92B2-D895934289FCA.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482308357,
"ip_address": "127.0.0.1",
"letter_file_name": "2B306DC3-FD44-488B-92B2-D895934289FCA.pdf",
"list_id": null,
"message_id": "E4FBBB5F-9E05-45D8-93AF-2C1A3BFD5284",
"message_id_supplier": "3HKQX79D2CT6DXDRQVRHPW7GDTM6",
"post_price": "1.710000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482308357",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/81D66A74-E41A-4C9B-AD51-CC932051F486A.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482308357,
"ip_address": "127.0.0.1",
"letter_file_name": "81D66A74-E41A-4C9B-AD51-CC932051F486A.pdf",
"list_id": null,
"message_id": "550CB11B-2D75-4851-8E2C-798F67A0BF9D",
"message_id_supplier": "B3YCJJRHQ2WD3CJFXKWB4BTFVYW8",
"post_price": "1.710000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482308357",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/80686068-68A5-42C6-8CD3-DE2FF5914D81A.pdf",
"_return_address": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 2,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482308357,
"ip_address": "127.0.0.1",
"letter_file_name": "80686068-68A5-42C6-8CD3-DE2FF5914D81A.pdf",
"list_id": null,
"message_id": "65C65D93-C327-45BD-BD6D-3C9682C88533",
"message_id_supplier": "R8CR92RVJH2Y8JC9JJCGT8RWH8B2",
"post_price": "1.710000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 2,
"schedule": "1482308357",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/DD750F79-A44F-4729-AC35-9267FE5AB2EFA.pdf",
"_return_address": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 2,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482308357,
"ip_address": "127.0.0.1",
"letter_file_name": "DD750F79-A44F-4729-AC35-9267FE5AB2EFA.pdf",
"list_id": null,
"message_id": "B4E256A5-1D25-45D7-9DB5-EEC17761372A",
"message_id_supplier": "V88MF93C9TVG2VF83T6K2GQVD6DJ",
"post_price": "1.710000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 2,
"schedule": "1482308357",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/BB141DB5-57DF-4FA5-A9E4-A13E5AC716E7A.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482311889,
"ip_address": "127.0.0.1",
"letter_file_name": "BB141DB5-57DF-4FA5-A9E4-A13E5AC716E7A.pdf",
"list_id": null,
"message_id": "4BF01D93-8BE5-42E4-AEAF-C9D1B27DCA23",
"message_id_supplier": "CQK8KTHP3J2B2WG2DW86C2DDH6WW",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482311889",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/BF430552-0581-42DD-BA00-B2228E7FE34BA.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482311889,
"ip_address": "127.0.0.1",
"letter_file_name": "BF430552-0581-42DD-BA00-B2228E7FE34BA.pdf",
"list_id": null,
"message_id": "BBA4C1F0-5C7C-4A58-9B93-C48FAB2DA649",
"message_id_supplier": "X9FBM27WHPJJW9JWT2XVJTYXVDY2",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482311889",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/13BB1876-E421-4B5A-8017-81E7F9598FE5AA.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482311889,
"ip_address": "127.0.0.1",
"letter_file_name": "13BB1876-E421-4B5A-8017-81E7F9598FE5A.pdf",
"list_id": null,
"message_id": "5BC692D1-EC43-4C4F-9E83-8543B52F8B7B",
"message_id_supplier": "7VW44YDFPJB7WWDRTXPKK9F7Q4RJ",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482311889",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/77A18FEA-8935-430E-B14A-7EBF5E1E19C8AA.pdf",
"_return_address": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 2,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482311889,
"ip_address": "127.0.0.1",
"letter_file_name": "77A18FEA-8935-430E-B14A-7EBF5E1E19C8AA.pdf",
"list_id": null,
"message_id": "CD2C87AA-D352-4998-BE7F-5EBDF089AF61",
"message_id_supplier": "GQ8MJ4DBRGQFPQ9K9M239CBVKDP2",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 2,
"schedule": "1482311889",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/21837EDA-1167-4104-A4D3-4A22FA0585E4A.pdf",
"_return_address": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 2,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482311889,
"ip_address": "127.0.0.1",
"letter_file_name": "21837EDA-1167-4104-A4D3-4A22FA0585E4AA.pdf",
"list_id": null,
"message_id": "17CD0519-4E91-4EC0-B9AF-F1BE3BC7A485",
"message_id_supplier": "GFJKTT8CJBCYR3DFFMPPBDQJQP32",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 2,
"schedule": "1482311889",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/C738FB89-750F-45E4-9E0A-EBD19A8B2884A.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482313126,
"ip_address": "127.0.0.1",
"letter_file_name": "C738FB89-750F-45E4-9E0A-EBD19A8B2884A.pdf",
"list_id": null,
"message_id": "8A2DAFE7-130F-4F9A-820B-85D79F874E05",
"message_id_supplier": "4F2JH87CP3PX22WRRYWVK8JJKXR2",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482313126",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/5089F9FC-0179-44E8-AC5E-225932FE9500A.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482313126,
"ip_address": "127.0.0.1",
"letter_file_name": "5089F9FC-0179-44E8-AC5E-225932FE9500A.pdf",
"list_id": null,
"message_id": "047CDB95-6C9D-4485-962F-EA28FFD7C0D9",
"message_id_supplier": "MHPDXPKFJFR9H677TQM8PH4YDMHP",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482313126",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/E17C7CE6-C2C9-476D-8886-E2B8CA6C30E3A.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482313126,
"ip_address": "127.0.0.1",
"letter_file_name": "E17C7CE6-C2C9-476D-8886-E2B8CA6C30E3A.pdf",
"list_id": null,
"message_id": "653C5ED0-5AAD-4946-8E72-8152E23A6AA5",
"message_id_supplier": "JYPVGC83PH68XX64QYBHQXRD4V2G",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 1,
"schedule": "1482313126",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/252678EE-C597-4D20-B1DE-F21629E77831A.pdf",
"_return_address": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 2,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482313126,
"ip_address": "127.0.0.1",
"letter_file_name": "252678EE-C597-4D20-B1DE-F21629E77831A.pdf",
"list_id": null,
"message_id": "EF4177A7-AE6D-4035-9052-10B2C9DF4564",
"message_id_supplier": "68TC768BG42TK6Q83VBFVKY87D99",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 2,
"schedule": "1482313126",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
},
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/8B2A85E1-D092-47DC-B70B-983B10AD83D6A.pdf",
"_return_address": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 2,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": null,
"date_added": 1482313126,
"ip_address": "127.0.0.1",
"letter_file_name": "8B2A85E1-D092-47DC-B70B-983B10AD83D6A.pdf",
"list_id": null,
"message_id": "E196E8B4-1233-4EF4-8689-C296D55B9DAE",
"message_id_supplier": "8BF2H8CCDJMHCMCKR3THJ6XDDJ9K",
"post_price": "1.370000",
"post_price_supplier": "0.000000",
"priority": 32,
"return_address_id": 2,
"schedule": "1482313126",
"source": ".rest.v3",
"status": "Sent",
"subaccount_id": 13,
"user_id": 1
}
],
"from": 1,
"last_page": 3,
"next_page_url": "https://rest.clicksend.com/v3/post/postcards/history?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 32
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your history."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Postcard History",
"tags": [
"Postcards"
]
}
},
"/post/postcards/price": {
"post": {
"description": "For `file_urls` field. You can attach at least 1 and max of 2 PDF file urls.\n\n- Supply a single pdf with 2 pages (front and back)\n\n- Supply 2 urls to seperate PDFs",
"operationId": "Calculate Pricing",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"file_urls": [
"https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_front.pdf",
"https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_back.pdf"
],
"recipients": [
{
"address_city": "City",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": "Custom abc123",
"return_address_id": 1
}
]
},
"properties": {
"file_urls": {
"description": "Postcard file urls. You can submit max 2 file urls.",
"items": {},
"type": "array"
},
"recipients": {
"description": "Your recipients.",
"items": {},
"type": "array"
}
},
"required": [
"file_urls",
"recipients"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"queued_count": 1,
"recipients": [
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/6A559A74-486D-4012-84D7-F3FE11904CB1.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"date_added": 1482473172,
"ip_address": "127.0.0.1",
"letter_file_name": "6A559A74-486D-4012-84D7-F3FE11904CB1.pdf",
"message_id": "C8CAA97A-905A-4A31-99CB-A92C7BA05A97",
"post_price": 11,
"priority": 32,
"return_address_id": 1,
"schedule": 1482473172,
"source": ".rest.v3",
"status": "SUCCESS",
"subaccount_id": 13,
"user_id": 1
}
],
"total_count": 1,
"total_price": 11
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Postcard queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Calculate Pricing",
"tags": [
"Postcards"
]
}
},
"/post/postcards/send": {
"post": {
"description": "**Supported File Types**\nWe 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 convert the file first using our uploads endpoint with the querystring parameter ?convert=post. e.g. POST /uploads?convert=post. This will return a URL to the converted pdf file that can be used in the /post/postcards/send endpoint.\n\n**Postcard File Options**\n\n**Use existing URL**\n\nWith this option, you can use an existing URL to a PDF document. For example, you might generate the pdf on your server.\n\nFor `file_urls` field. You can attach at least 1 and max of 2 PDF file urls.\n\n- Supply a single pdf with 2 pages (front and back)\n\n- Supply 2 urls to seperate PDFs\n\n**Upload File to Our Server**\n\nWith this option, you can use the `/uploads` endpoint to upload the document. The `/uploads` endpoint returns a URL that can be used in the `/post/postcards/send` endpoint.",
"operationId": "Send Postcard",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"file_urls": [
"https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_front.pdf",
"https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/a5_back.pdf"
],
"recipients": [
{
"address_city": "City",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"custom_string": "Custom abc123",
"return_address_id": 1
}
]
},
"properties": {
"file_urls": {
"description": "Postcard file urls. You can submit max 2 file urls.",
"items": {},
"type": "array"
},
"recipients": {
"description": "Your recipients.",
"items": {},
"type": "array"
}
},
"required": [
"file_urls",
"recipients"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"queued_count": 1,
"recipients": [
{
"_api_username": "johndoe",
"_file_url": "https://rest.clicksend.com/files/6A559A74-486D-4012-84D7-F3FE11904CB1.pdf",
"_return_address": {
"address_city": "Perth",
"address_country": "AU",
"address_line_1": "123 Test St",
"address_line_2": "",
"address_name": "John Doe",
"address_postal_code": "6000",
"address_state": "WA",
"return_address_id": 1,
"user_id": 1
},
"address_city": "CITY",
"address_country": "AU",
"address_line_1": "Address 1",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "123456",
"address_state": "State",
"date_added": 1482473172,
"ip_address": "127.0.0.1",
"letter_file_name": "6A559A74-486D-4012-84D7-F3FE11904CB1.pdf",
"message_id": "C8CAA97A-905A-4A31-99CB-A92C7BA05A97",
"post_price": 11,
"priority": 32,
"return_address_id": 1,
"schedule": 1482473172,
"source": ".rest.v3",
"status": "SUCCESS",
"subaccount_id": 13,
"user_id": 1
}
],
"total_count": 1,
"total_price": 11
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Postcard queued for delivery."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Send Postcard",
"tags": [
"Postcards"
]
}
},
"/post/return-addresses": {
"get": {
"description": "",
"operationId": "Get List of Post Return Addresses",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 4,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 5,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 6,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 7,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 8,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 9,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 10,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 11,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "My Address",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 12,
"user_id": 1
},
{
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 14,
"user_id": 1
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 10,
"total": 10
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your records."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get List of Post Return Addresses",
"tags": [
"Post Letter"
]
},
"post": {
"description": "",
"operationId": "Create a Post Return Address",
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_Post_Return_AddressBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 14,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New return address has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create a Post Return Address",
"tags": [
"Post Letter"
]
}
},
"/post/return-addresses/{return_address_id}": {
"delete": {
"description": "",
"operationId": "Delete Post Return Address",
"parameters": [
{
"description": "Your return address id.",
"example": "12",
"in": "path",
"name": "return_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your return address has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete Post Return Address",
"tags": [
"Post Letter"
]
},
"get": {
"description": "",
"operationId": "Get Post Return Address",
"parameters": [
{
"description": "Your return address id.",
"example": "14",
"in": "path",
"name": "return_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": "6302",
"address_state": "WA",
"return_address_id": 14,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Post Return Address",
"tags": [
"Post Letter"
]
},
"put": {
"description": "",
"operationId": "Update Post Return Address",
"parameters": [
{
"description": "Your return address id.",
"example": "14",
"in": "path",
"name": "return_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Create_a_Post_Return_AddressBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": 6302,
"address_state": "WA",
"return_address_id": 14,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your return address has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update Post Return Address",
"tags": [
"Post Letter"
]
}
},
"/pricing/{country}?currency={currency}": {
"get": {
"description": "",
"operationId": "Get Country Pricing",
"parameters": [
{
"description": "Two-letter representation of the country.",
"example": "AU",
"in": "path",
"name": "country",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Three-letter representation of the currency.",
"example": "AUD",
"in": "path",
"name": "currency",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"country": "AU",
"email": {
"price_rate_0": "0.0100",
"price_rate_1": "0.0080",
"price_rate_2": "0.0040",
"price_rate_3": "0.0010"
},
"fax": {
"dedicated_number_monthly": "30.0000",
"dedicated_number_setup": "40.0000",
"price_fax": "0.2000"
},
"mms": {
"dedicated_number_monthly": "10.0000",
"dedicated_number_setup": "20.0000",
"price_mms": "0.4500"
},
"post": {
"direct_mail_min_quantity": 5000,
"price_direct_mail_a5": "0.1200",
"price_direct_mail_dl": "0.1200",
"price_letter_black": "1.2700",
"price_letter_colour": "1.4700",
"price_letter_large_surcharge": "1.5000",
"price_letter_large_surcharge_sheet": "0.0400",
"price_letter_page_black": "0.1000",
"price_letter_page_colour": "0.2400"
},
"postcard": {
"price_postcard": "10.0000"
},
"sms": {
"dedicated_number_monthly": "19.0000",
"dedicated_number_setup": "20.0000",
"dedicated_number_shortcode_monthly": "0.0000",
"dedicated_number_shortcode_setup": "0.0000",
"price_rate_0": "0.0700",
"price_rate_1": "0.0650",
"price_rate_2": "0.0600",
"price_rate_3": "0.0550"
},
"voice": {
"price_landline": "0.0530",
"price_mobile": "0.1730"
}
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Price Lists."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Country Pricing",
"tags": [
"Pricing"
]
}
},
"/recharge/credit-card": {
"get": {
"description": "",
"operationId": "Get Credit Card info",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"display_number": "XXXX-XXXX-XXXX-0000",
"expiry_month": 5,
"expiry_year": 2016,
"name": "Roland Robot"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Customer payment info."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Credit Card info",
"tags": [
"Account Recharge"
]
},
"put": {
"description": "",
"operationId": "Update Credit Card info",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"bank_name": "Robotic Banking",
"cvc": "123",
"expiry_month": "05",
"expiry_year": "2016",
"name": "Roland Robot",
"number": "5520000000000000"
},
"properties": {
"bank_name": {
"description": "Your bank's name that issued the credit card.",
"type": "string"
},
"cvc": {
"description": "Your CVC digits.",
"type": "number"
},
"expiry_month": {
"description": "Your credit card expiry month.",
"type": "number"
},
"expiry_year": {
"description": "Your credit card expiry year.",
"type": "number"
},
"name": {
"description": "Your name.",
"type": "string"
},
"number": {
"description": "Your credit card no.",
"type": "number"
}
},
"required": [
"expiry_month",
"cvc",
"name",
"bank_name"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"token": "cus_6Z3mHM9QvQQoJ28WsIWuLA"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your payment info has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update Credit Card info",
"tags": [
"Account Recharge"
]
}
},
"/recharge/packages?country={country}": {
"get": {
"description": "",
"operationId": "List of Packages",
"parameters": [
{
"description": "Your country.",
"example": "\"AU\"",
"in": "path",
"name": "country",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"packages": [
{
"email_price": 0.033,
"email_quantity": 606,
"fax_price": 0.198,
"fax_quantity": 101,
"package_id": 1,
"package_price": "20.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 13,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 10,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 1,
"sms_price": 0.099,
"sms_quantity": 202,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 343,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 202
},
{
"email_price": 0.033,
"email_quantity": 1515,
"fax_price": 0.198,
"fax_quantity": 252,
"package_id": 2,
"package_price": "50.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 33,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 26,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 4,
"sms_price": 0.099,
"sms_quantity": 505,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 857,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 505
},
{
"email_price": 0.033,
"email_quantity": 3030,
"fax_price": 0.198,
"fax_quantity": 505,
"package_id": 3,
"package_price": "100.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 66,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 53,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 9,
"sms_price": 0.099,
"sms_quantity": 1010,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 1715,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 1010
},
{
"email_price": 0.011,
"email_quantity": 18181,
"fax_price": 0.198,
"fax_quantity": 1010,
"package_id": 4,
"package_price": "200.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 132,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 106,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 18,
"sms_price": 0.088,
"sms_quantity": 2272,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 3430,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 2020
},
{
"email_price": 0.011,
"email_quantity": 45454,
"fax_price": 0.198,
"fax_quantity": 2525,
"package_id": 5,
"package_price": "500.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 331,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 265,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 45,
"sms_price": 0.088,
"sms_quantity": 5681,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 8576,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 5050
},
{
"email_price": 0.0055,
"email_quantity": 181818,
"fax_price": 0.198,
"fax_quantity": 5050,
"package_id": 6,
"package_price": "1000.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 663,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 531,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 90,
"sms_price": 0.077,
"sms_quantity": 12987,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 17152,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 10101
},
{
"email_price": 0.0055,
"email_quantity": 272727,
"fax_price": 0.198,
"fax_quantity": 7575,
"package_id": 7,
"package_price": "1500.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 995,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 797,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 136,
"sms_price": 0.077,
"sms_quantity": 19480,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 25728,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 15151
},
{
"email_price": 0.0055,
"email_quantity": 363636,
"fax_price": 0.198,
"fax_quantity": 10101,
"package_id": 8,
"package_price": "2000.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 1327,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 1063,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 181,
"sms_price": 0.077,
"sms_quantity": 25974,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 34305,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 20202
},
{
"email_price": 0.0055,
"email_quantity": 545454,
"fax_price": 0.198,
"fax_quantity": 15151,
"package_id": 9,
"package_price": "3000.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 1990,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 1594,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 272,
"sms_price": 0.077,
"sms_quantity": 38961,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 51457,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 30303
},
{
"email_price": 0.0044,
"email_quantity": 1250000,
"fax_price": 0.198,
"fax_quantity": 27777,
"package_id": 10,
"package_price": "5500.00",
"post_direct_mail_a5_price": 0.66,
"post_direct_mail_dl_price": 0.44,
"post_direct_mail_min_quantity": 5000,
"post_letter_black_price": 1.397,
"post_letter_black_quantity": 3649,
"post_letter_colour_price": 1.617,
"post_letter_colour_quantity": 2923,
"post_page_black_price": 0.11,
"post_page_colour_price": 0.264,
"postcard_price": 11,
"postcard_quantity": 500,
"sms_price": 0.066,
"sms_quantity": 83333,
"voice_landline_price": 0.0583,
"voice_landline_quantity": 94339,
"voice_mobile_price": 0.099,
"voice_mobile_quantity": 55555
}
]
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of Packages."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List of Packages",
"tags": [
"Account Recharge"
]
}
},
"/recharge/purchase/{package_id}": {
"put": {
"description": "",
"operationId": "Purchase a Package",
"parameters": [
{
"description": "Your package id.",
"example": "1",
"in": "path",
"name": "package_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"amount": "50.00",
"amount_aud": "61.86",
"currency": "USD",
"date": 1442216451,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Successfully purchased a package #1"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Purchase a Package",
"tags": [
"Account Recharge"
]
}
},
"/recharge/transactions": {
"get": {
"description": "",
"operationId": "Get Transactions",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"amount": "20.00",
"currency": "AUD",
"date": 1443420196,
"invoice_number": "cb726c65-1c65-47fa-aea2-3ded9ed57557"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1443420094,
"invoice_number": "13d35606-5f10-4d31-9de4-065b025aa5b8"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1443418982,
"invoice_number": "4e9fc8af-f514-45b1-86c2-fc85630bb14d"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1443403590,
"invoice_number": "65c0bfe0-168c-4b46-9dbd-6120a18b5efa"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1443149774,
"invoice_number": "902e78dc-9a70-417b-8426-6967f0efc6eb"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1443148806,
"invoice_number": "21571831-ae8f-4605-ac3e-3efe424a2a39"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1443147864,
"invoice_number": "b978f05b-3de0-4d17-9796-a852eb82d820"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1443146363,
"invoice_number": "180999f7-1928-4137-a7c3-754420fc1235"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1442907133,
"invoice_number": "3d527e8f-03e1-460b-9f7d-5fce9fc2997e"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1442902821,
"invoice_number": "cdee6647-7b82-49b5-b26e-033eadb2a485"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1442902477,
"invoice_number": "0b6c4073-e214-439d-9821-8f0b69ea61f8"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1442902394,
"invoice_number": "e9d48b44-fad1-4d47-94bb-5d11d88f01f4"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1442902192,
"invoice_number": "1ea56734-a540-4ab6-8b10-fc364065c046"
},
{
"amount": "20.00",
"currency": "AUD",
"date": 1442896724,
"invoice_number": "b5031e92-0ca3-47a1-9f66-b14a7eaac9b1"
},
{
"amount": "50.00",
"currency": "USD",
"date": 1442216451,
"invoice_number": "aeb4bff3-ea08-40ba-9f84-3ff000aa9283"
}
],
"from": 1,
"last_page": 2,
"next_page_url": "https://rest.clicksend.com/v3/recharge/transactions/?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 16
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your transactions."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Transactions",
"tags": [
"Account Recharge"
]
}
},
"/recharge/transactions/{transaction_id}": {
"get": {
"description": "",
"operationId": "Get a specific transaction",
"parameters": [
{
"description": "1c65-47fa-aea2-3ded9ed57557 (number, required) - Your transction id.",
"example": "cb726c65",
"in": "path",
"name": "transaction_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/pdf": {
"examples": {
"response": {
"value": "{\n}\n"
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific transaction",
"tags": [
"Account Recharge"
]
}
},
"/referral/accounts": {
"get": {
"description": "",
"operationId": "Get List of Referral Accounts",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"date_referred": 1438260940,
"percentage_referral": 5,
"refered_user_id": 24,
"referral_rule_id": 1
},
{
"date_referred": 1438260989,
"percentage_referral": 5,
"refered_user_id": 25,
"referral_rule_id": 2
},
{
"date_referred": 1438260992,
"percentage_referral": 5,
"refered_user_id": 26,
"referral_rule_id": 3
},
{
"date_referred": 1438260994,
"percentage_referral": 5,
"refered_user_id": 27,
"referral_rule_id": 4
},
{
"date_referred": 1438260997,
"percentage_referral": 5,
"refered_user_id": 28,
"referral_rule_id": 5
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 5,
"total": 5
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your referrals."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get List of Referral Accounts",
"tags": [
"Referral Accounts"
]
}
},
"/reseller": {
"get": {
"description": "Get reseller setting.",
"operationId": "Get Reseller Setting",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"allow_public_signups": 1,
"colour_navigation": "#9999FF",
"default_margin": 10,
"default_margin_numbers": 20,
"logo_url": "http://yourdomain.com",
"reseller_user_id": 1,
"subdomain": "subdomain",
"trial_balance": "500.00"
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Reseller Setting",
"tags": [
"Reseller"
]
},
"put": {
"description": "Update a specific reseller setting.",
"operationId": "Update Reseller Setting",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"allow_public_signups": 1,
"colour_navigation": "#9999FF",
"company_name": "MyCompany",
"default_margin": 100,
"default_margin_numbers": 150,
"logo_url_dark": "http://yourdomain.com/dark",
"logo_url_light": "http://yourdomain.com/light",
"subdomain": "subdomain",
"trial_balance": 50
},
"properties": {
"allow_public_signups": {
"description": "Allow public signups.",
"type": "number"
},
"colour_navigation": {
"description": "Colour navigation.",
"type": "string"
},
"company_name": {
"description": "Company name.",
"type": "string"
},
"default_margin": {
"description": "Default margin.",
"type": "number"
},
"default_margin_numbers": {
"description": "Default margin numbers.",
"type": "number"
},
"logo_url_dark": {
"description": "Logo URL (dark)",
"type": "string"
},
"logo_url_light": {
"description": "Logo URL (light)",
"type": "string"
},
"subdomain": {
"description": "Subdomain.",
"type": "string"
},
"trial_balance": {
"description": "Trial balance.",
"type": "number"
}
},
"required": [
"allow_public_signups",
"default_margin",
"default_margin_numbers",
"trial_balance",
"subdomain",
"colour_navigation",
"logo_url_light",
"logo_url_dark",
"company_name"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"allow_public_signups": 1,
"colour_navigation": "#9999FF",
"company_name": "MyCompany",
"default_margin": 100,
"default_margin_numbers": 150,
"logo_url_dark": "http://yourdomain.com/dark",
"logo_url_light": "http://yourdomain.com/light",
"reseller_user_id": 1,
"subdomain": "subdomain",
"trial_balance": 50
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your setting has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update Reseller Setting",
"tags": [
"Reseller"
]
}
},
"/reseller/accounts": {
"get": {
"description": "Get list of Reseller Accounts",
"operationId": "List of Reseller Accounts",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 0,
"api_key": "D683D2C1-8AAE-881A-78FF-E8577D7BED2D",
"api_username": "Y3c5zm7z97",
"email": "oNEDu5ffl8@BP8lY.com",
"first_name": "JohnNyZWy",
"last_name": "Doe8ozHX",
"phone_number": "+61353787526",
"subaccount_id": 54
},
"account": 0,
"account_billing_email": "AIYkwXgB2c@CzrJB.com",
"account_billing_mobile": "+61353787961",
"account_name": "Johnn99YH",
"active": 1,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261086832",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 1,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 26979,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 1,
"unsubscribe_mail": 1,
"user_email": "email86363@gmail.com",
"user_first_name": "Firstname30529",
"user_id": 24,
"user_last_name": "Lastname83402",
"user_phone": "+61261063776",
"username": "username75897"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "C9B4AFBA-BDBA-E343-950B-2C63BF6E7901",
"api_username": "a4CQgqG4lS",
"email": "fZpbUQfzE0@NQ9Nt.com",
"first_name": "John19k46",
"last_name": "DoexkI6a",
"phone_number": "+61353787898",
"subaccount_id": 70
},
"account": 0,
"account_billing_email": "fZpbUQfzE0@NQ9Nt.com",
"account_billing_mobile": "+61353787898",
"account_name": "JohnkMJLv",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "2273.435000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "I1hq9xrvmcNO24sf",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 0,
"unsubscribe_mail": 0,
"user_email": "MEynjL6C3A@2YtIn.com",
"user_first_name": "JohnjRk3I",
"user_id": 60,
"user_last_name": "Doe1uWR5",
"user_phone": "+61353787971",
"username": "FHJatAkKXD"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "2E829F76-FB67-D2D6-637E-7DB511D98A85",
"api_username": "zOgiEZ1TK7",
"email": "alKdHhfzXI@MvAvZ.com",
"first_name": "JohnufkdZ",
"last_name": "DoevmQ93",
"phone_number": "+61353787282",
"subaccount_id": 71
},
"account": 0,
"account_billing_email": "alKdHhfzXI@MvAvZ.com",
"account_billing_mobile": "+61353787282",
"account_name": "JohnwjvLq",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "iBX9lNMRLM1Dp5QN",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 0,
"unsubscribe_mail": 0,
"user_email": "eThbkhkjwi@El2xE.com",
"user_first_name": "JohnTW9sV",
"user_id": 61,
"user_last_name": "DoeBQhRS",
"user_phone": "+61353787600",
"username": "e10GrL9GUw"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "E0D3BF7C-F51A-95BF-F80C-A90C546A3AF7",
"api_username": "lDcRBjpvzc",
"email": "Y6Q8mpg5PM@DxhTZ.com",
"first_name": "JohnpIh23",
"last_name": "Doen7y2c",
"phone_number": "+61353787685",
"subaccount_id": 72
},
"account": 0,
"account_billing_email": "Y6Q8mpg5PM@DxhTZ.com",
"account_billing_mobile": "+61353787685",
"account_name": "JohnCEUiT",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "WrDhMU4CAwsGvoBn",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 8,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 0,
"unsubscribe_mail": 0,
"user_email": "J6tOUnclVo@vmAV6.com",
"user_first_name": "JohnsIbLF",
"user_id": 62,
"user_last_name": "DoeWhrkh",
"user_phone": "+61353787970",
"username": "FYuLNmYf8K"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "DD87E68D-73B9-91AF-8EEE-F1D3C8FA40F5",
"api_username": "username_62220",
"email": "email_96752@gmail.com",
"first_name": "Firstname6663",
"last_name": "Lastname95048",
"phone_number": "+61261061361",
"subaccount_id": 80
},
"account": 0,
"account_billing_email": "email_96752@gmail.com",
"account_billing_mobile": "+61261061361",
"account_name": "Company 99550",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": null,
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 2147483647,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 0,
"unsubscribe_mail": 0,
"user_email": "email_96752@gmail.com",
"user_first_name": "Firstname6663",
"user_id": 70,
"user_last_name": "Lastname95048",
"user_phone": "+61261061361",
"username": "username_62220"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "1219277F-5111-C884-DEE1-7C16681A3655",
"api_username": "username_38270",
"email": "email_66764@gmail.com",
"first_name": "Firstname1371",
"last_name": "Lastname50417",
"phone_number": "+61261063404",
"subaccount_id": 81
},
"account": 0,
"account_billing_email": "email_66764@gmail.com",
"account_billing_mobile": "+61261063404",
"account_name": "Company 50249",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261089282",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 1,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 2147483647,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 1,
"unsubscribe_mail": 0,
"user_email": "email_66764@gmail.com",
"user_first_name": "Firstname1371",
"user_id": 71,
"user_last_name": "Lastname50417",
"user_phone": "+61261063404",
"username": "username_38270"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "631D0E3C-CA0A-E224-BF1B-0070FDACF775",
"api_username": "username_39016",
"email": "email_67772@gmail.com",
"first_name": "Firstname26535",
"last_name": "Lastname36882",
"phone_number": "+61261061316",
"subaccount_id": 82
},
"account": 0,
"account_billing_email": "email_67772@gmail.com",
"account_billing_mobile": "+61261061316",
"account_name": "Company 26794",
"active": 1,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261087712",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 1,
"setting_fix_sender_id": 87404,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 0,
"unsubscribe_mail": 0,
"user_email": "email_67772@gmail.com",
"user_first_name": "Firstname26535",
"user_id": 72,
"user_last_name": "Lastname36882",
"user_phone": "+61261061316",
"username": "username_39016"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "E236FDFF-4730-F719-85B9-2AC0D4D192F5",
"api_username": "username_10832",
"email": "email_28172@gmail.com",
"first_name": "Firstname10383",
"last_name": "Lastname11110",
"phone_number": "+61261064026",
"subaccount_id": 83
},
"account": 0,
"account_billing_email": "email_28172@gmail.com",
"account_billing_mobile": "+61261064026",
"account_name": "Company 28247",
"active": 1,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261088320",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 1,
"setting_fix_sender_id": 67684,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 1,
"unsubscribe_mail": 0,
"user_email": "email_28172@gmail.com",
"user_first_name": "Firstname10383",
"user_id": 73,
"user_last_name": "Lastname11110",
"user_phone": "+61261064026",
"username": "username_10832"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "98AE5B58-141B-1310-AC66-45D34D56CA4C",
"api_username": "username65302",
"email": "email1024@gmail.com",
"first_name": "Firstname42348",
"last_name": "Lastname45055",
"phone_number": "+61261067753",
"subaccount_id": 84
},
"account": 0,
"account_billing_email": "email1024@gmail.com",
"account_billing_mobile": "+61261067753",
"account_name": "Company88867",
"active": 1,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261087647",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 1,
"setting_fix_sender_id": 93951,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 1,
"unsubscribe_mail": 1,
"user_email": "email1024@gmail.com",
"user_first_name": "Firstname42348",
"user_id": 74,
"user_last_name": "Lastname45055",
"user_phone": "+61261067753",
"username": "username65302"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "C9E22A8E-88B2-0077-3445-F95A5D501FEA",
"api_username": "username67428",
"email": "email13820@gmail.com",
"first_name": "Firstname70051",
"last_name": "Lastname35293",
"phone_number": "+61261062260",
"subaccount_id": 85
},
"account": 0,
"account_billing_email": "email13820@gmail.com",
"account_billing_mobile": "+61261062260",
"account_name": "Company13805",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261088951",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 35625,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 0,
"unsubscribe_mail": 1,
"user_email": "email13820@gmail.com",
"user_first_name": "Firstname70051",
"user_id": 75,
"user_last_name": "Lastname35293",
"user_phone": "+61261062260",
"username": "username67428"
},
{
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "BBD918C1-DD00-FFFB-CF53-4C3AB9E15F5C",
"api_username": "username59",
"email": "email52313@gmail.com",
"first_name": "Firstname49996",
"last_name": "Lastname22152",
"phone_number": "+61261069962",
"subaccount_id": 86
},
"account": 0,
"account_billing_email": "email52313@gmail.com",
"account_billing_mobile": "+61261069962",
"account_name": "Company23060",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261083784",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 44842,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 1,
"unsubscribe_mail": 1,
"user_email": "email52313@gmail.com",
"user_first_name": "Firstname49996",
"user_id": 76,
"user_last_name": "Lastname22152",
"user_phone": "+61261069962",
"username": "username59"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 11,
"total": 11
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are you data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List of Reseller Accounts",
"tags": [
"Reseller Accounts"
]
},
"post": {
"description": "",
"operationId": "Create Reseller Account",
"requestBody": {
"$ref": "#/components/requestBodies/Create_Reseller_AccountBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "A724C6A4-1D1A-93E8-5FB8-62DC1D153CE4",
"api_username": "johndoe2",
"email": "johndoe2@awesome.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": "+15184811002",
"subaccount_id": 127
},
"account": 0,
"account_billing_email": "johndoe2@awesome.com",
"account_billing_mobile": "+15184811002",
"account_name": "The Awesome Company",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "0.000000",
"balance_commission": "0.299954",
"banned": 0,
"country": "US",
"default_country_sms": "US",
"delivery_to": null,
"low_credit_amount": "0.00",
"old_dashboard": 0,
"reply_to": "originalemail",
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 6,
"setting_unicode_sms": 0,
"timezone": "Australia/Melbourne",
"user_email": "johndoe2@awesome.com",
"user_first_name": "John",
"user_id": 117,
"user_last_name": "Doe",
"user_phone": "+15184811002",
"username": "johndoe2"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New reseller has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create Reseller Account",
"tags": [
"Reseller Accounts"
]
}
},
"/reseller/accounts-public": {
"post": {
"description": "",
"operationId": "Create Reseller Account - Public",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"account_name": "The Awesome Company",
"country": "AU",
"password": "pass",
"reseller_user_id": 1,
"user_email": "johnis@awesome.com",
"user_first_name": "John",
"user_last_name": "Awesome",
"user_phone": "+61261063270",
"username": "john_awesome"
},
"properties": {
"account_name": {
"description": "Your delivery to value.",
"type": "string"
},
"country": {
"description": "Client country.",
"type": "string"
},
"password": {
"description": "Your password.",
"type": "string"
},
"reseller_user_id": {
"description": "Reseller User ID.",
"type": "number"
},
"user_email": {
"description": "Your email.",
"type": "string"
},
"user_first_name": {
"description": "Your first name.",
"type": "string"
},
"user_last_name": {
"description": "Your last name.",
"type": "string"
},
"user_phone": {
"description": "Your phone number in E.164 format.",
"type": "string"
},
"username": {
"description": "Your username.",
"type": "string"
}
},
"required": [
"reseller_user_id",
"username",
"password",
"user_email",
"user_phone",
"user_first_name",
"user_last_name",
"account_name",
"country"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "A144E6D3-3FF9-F3BF-4495-80AE75A0BF88",
"api_username": "john_awesome",
"email": "johnis@awesome.com",
"first_name": "John",
"last_name": "Awesome",
"notes": null,
"phone_number": "+61261063270",
"subaccount_id": 146
},
"account": 0,
"account_billing_email": "johnis@awesome.com",
"account_billing_mobile": "+61261063270",
"account_name": "The Awesome Company",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "0.000000",
"balance_commission": "0.299954",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": null,
"low_credit_amount": "0.00",
"old_dashboard": 0,
"reply_to": "originalemail",
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 8,
"setting_unicode_sms": 0,
"timezone": "Australia/Melbourne",
"user_email": "johnis@awesome.com",
"user_first_name": "John",
"user_id": 130,
"user_last_name": "Awesome",
"user_phone": "+61261063270",
"username": "john_awesome"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New reseller has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create Reseller Account - Public",
"tags": [
"Reseller Accounts"
]
}
},
"/reseller/accounts/{client_user_id}": {
"get": {
"description": "Get a specific reseller account.",
"operationId": "Get Reseller Account",
"parameters": [
{
"description": "The client user id.",
"example": "24",
"in": "path",
"name": "client_user_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 0,
"api_key": "D683D2C1-8AAE-881A-78FF-E8577D7BED2D",
"api_username": "Y3c5zm7z97",
"email": "oNEDu5ffl8@BP8lY.com",
"first_name": "JohnNyZWy",
"last_name": "Doe8ozHX",
"phone_number": "+61353787526",
"subaccount_id": 54
},
"account": 0,
"account_billing_email": "AIYkwXgB2c@CzrJB.com",
"account_billing_mobile": "+61353787961",
"account_name": "Johnn99YH",
"active": 1,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "115.000000",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "+61261086832",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 1,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 26979,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 1,
"unsubscribe_mail": 1,
"user_email": "email86363@gmail.com",
"user_first_name": "Firstname30529",
"user_id": 24,
"user_last_name": "Lastname83402",
"user_phone": "+61261063776",
"username": "username75897"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Reseller Account",
"tags": [
"Reseller Accounts"
]
},
"put": {
"description": "",
"operationId": "Update Reseller Account",
"parameters": [
{
"description": "Your client user id.",
"example": "24",
"in": "path",
"name": "client_user_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Create_Reseller_AccountBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"_subaccount": null,
"account": 0,
"account_billing_email": "johndoe2@awesome.com",
"account_billing_mobile": "+15184811002",
"account_name": "The Awesome Company",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "199.997000",
"balance_commission": "0.299954",
"banned": 0,
"country": "US",
"default_country_sms": "US",
"delivery_to": null,
"low_credit_amount": "0.00",
"old_dashboard": 0,
"reply_to": "originalemail",
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 6,
"setting_unicode_sms": 0,
"timezone": "Australia/Melbourne",
"user_email": "johndoe2@awesome.com",
"user_first_name": "John",
"user_id": 117,
"user_last_name": "Doe",
"user_phone": "518-481-1002",
"username": "johndoe2"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Reseller account has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update Reseller Account",
"tags": [
"Reseller Accounts"
]
}
},
"/reseller/transfer-credit": {
"put": {
"description": "",
"operationId": "Transfer Credit",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"balance": 12,
"client_user_id": 60,
"currency": "USD"
},
"properties": {
"balance": {
"description": "Your amount.",
"type": "number"
},
"client_user_id": {
"description": "Your client user id.",
"type": "string"
},
"currency": {
"description": "Your currency.",
"type": "string"
}
},
"required": [
"client_user_id",
"balance",
"currency"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"_subaccount": {
"access_billing": 1,
"access_contacts": 0,
"access_email": 0,
"access_fax": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "C9B4AFBA-BDBA-E343-950B-2C63BF6E7901",
"api_username": "a4CQgqG4lS",
"email": "fZpbUQfzE0@NQ9Nt.com",
"first_name": "John19k46",
"last_name": "DoexkI6a",
"phone_number": "+61353787898",
"subaccount_id": 70
},
"account": 0,
"account_billing_email": "fZpbUQfzE0@NQ9Nt.com",
"account_billing_mobile": "+61353787898",
"account_name": "JohnkMJLv",
"active": 0,
"auto_recharge": 0,
"auto_recharge_amount": "20.00",
"balance": "170.728701",
"banned": 0,
"country": "AU",
"default_country_sms": "AU",
"delivery_to": "I1hq9xrvmcNO24sf",
"low_credit_amount": "1.50",
"reply_to": "originalemail",
"setting_beta": 0,
"setting_email_sms_subject": 0,
"setting_fix_sender_id": 0,
"setting_sms_message_char_limit": 140,
"setting_unicode_sms": 0,
"unsubscribe_mail": 0,
"user_email": "MEynjL6C3A@2YtIn.com",
"user_first_name": "JohnjRk3I",
"user_id": 60,
"user_last_name": "Doe1uWR5",
"user_phone": "+61353787971",
"username": "FHJatAkKXD"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your balance has been successfully transferred."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Transfer Credit",
"tags": [
"Reseller Accounts"
]
}
},
"/reseller/{subdomain}": {
"get": {
"description": "Get reseller setting by subdomin.",
"operationId": "Reseller By Subdomain",
"parameters": [
{
"description": "Subdomain",
"example": "mysubdomain",
"in": "path",
"name": "subdomain",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"allow_public_signups": 1,
"colour_navigation": "#9999FF",
"company_name": "MyCompany",
"logo_url_dark": "http://yourdomain.com/dark",
"logo_url_light": "http://yourdomain.com/light",
"reseller_user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here's your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Reseller By Subdomain",
"tags": [
"Reseller"
]
}
},
"/sdk-download/{type}": {
"get": {
"description": "",
"operationId": "SDK Download",
"parameters": [
{
"description": "Supported types.",
"example": "cs, java, android, objectivec, angular, ruby, python, php, nodejs, go",
"in": "path",
"name": "type",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {}
}
},
"summary": "SDK Download",
"tags": [
"SDK"
]
}
},
"/search/contacts-lists?q={q}": {
"get": {
"description": "",
"operationId": "Search Contacts-Lists",
"parameters": [
{
"description": "Your keyword or query.",
"example": "Gorne",
"in": "path",
"name": "q",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"contact": "+16783270696",
"contacts_count": null,
"id": 552807,
"name": "Gorne",
"type": "contact"
},
{
"contact": "GHPAJCCVGMTD9BLA",
"contacts_count": 3,
"id": 428,
"name": "Gorne",
"type": "list"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are some search result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Search Contacts-Lists",
"tags": [
"Search"
]
}
},
"/sms-campaigns": {
"get": {
"description": "",
"operationId": "Get list of SMS Campaigns",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444962803",
"from": "+61353787447",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "This is my awesome campaign.",
"schedule": "1444821615",
"sms_campaign_id": 1,
"source": null,
"status": "Cancelled",
"subaccount_id": 1,
"user_id": 1
},
{
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444962630",
"from": "+61353787448",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 7,
"source": null,
"status": "Queued",
"subaccount_id": 1,
"user_id": 1
},
{
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444893067",
"from": "+61353787448",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 6,
"source": null,
"status": "Queued",
"subaccount_id": 1,
"user_id": 1
},
{
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444891837",
"from": "+61353787448",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 5,
"source": null,
"status": "Sent",
"subaccount_id": 1,
"user_id": 1
},
{
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444888498",
"from": "+61353787448",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 4,
"source": null,
"status": "Sent",
"subaccount_id": 1,
"user_id": 1
},
{
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444882130",
"from": "+61353787448",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 3,
"source": null,
"status": "Sent",
"subaccount_id": 1,
"user_id": 1
},
{
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444882068",
"from": "+61353787448",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 2,
"source": null,
"status": "Sent",
"subaccount_id": 1,
"user_id": 1
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 20,
"prev_page_url": null,
"to": 7,
"total": 7
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your SMS campaigns."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get list of SMS Campaigns",
"tags": [
"SMS Campaigns"
]
}
},
"/sms-campaigns/price": {
"post": {
"description": "",
"operationId": "Calculate Price for SMS Campaign",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"body": "(First Name), this is your new campaign message.",
"from": "+61353787448",
"list_id": 428,
"name": "My Campaign 1"
},
"properties": {
"body": {
"description": "Your campaign message.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
},
"list_id": {
"description": "Your list id.",
"type": "number"
},
"name": {
"description": "Your campaign name.",
"type": "string"
}
},
"required": [
"list_id",
"name",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "British Pounds",
"currency_name_short": "GBP",
"currency_prefix_c": "p",
"currency_prefix_d": "£"
},
"data": {
"body": "John, this is your new campaign message.",
"from": "+61353787448",
"schedule": 1444381346
},
"total_count": 1,
"total_price": "0.035"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your price for your SMS Campaign."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Calculate Price for SMS Campaign",
"tags": [
"SMS Campaigns"
]
}
},
"/sms-campaigns/send": {
"post": {
"description": "This is functionally identical to the **POST /sms-campaigns/send** endpoint, other than adding the `smsg.us/xxxxx` string to the message body additional `url_to_shorten` parameter.",
"operationId": "Use Short URL",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"body": "This is my new campaign message. Visit this url: smsg.us/xxxxx",
"from": "+61353787448",
"list_id": 428,
"name": "My Campaign 1",
"schedule": 1444821615,
"url_to_shorten": "http://yourdomain.com/"
},
"properties": {
"body": {
"description": "Your campaign message.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
},
"list_id": {
"description": "Your list id.",
"type": "number"
},
"name": {
"description": "Your campaign name.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"url_to_shorten": {
"description": "The URL you want to shorten (only required when using this feature). This must be only `http` or `https`.",
"type": "string"
}
},
"required": [
"list_id",
"name",
"body",
"url_to_shorten"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "This is my new campaign message. Visit this url: smsg.us/xxxxx",
"custom_string": null,
"date_added": "1444962630",
"from": "+61353787448",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 7,
"source": null,
"status": "Queued",
"subaccount_id": 1,
"url_to_shorten": "http://yourdomain.com/",
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your new campaign has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Use Short URL",
"tags": [
"SMS Campaigns"
]
}
},
"/sms-campaigns/{campaign_id}/link-export?filename={filename}": {
"get": {
"description": "Compile all link tracking for the specified campaign into a CSV for download.",
"operationId": "Link Tracking Export",
"parameters": [
{
"description": "Your campaign id.",
"example": "1",
"in": "path",
"name": "campaign_id",
"required": true,
"schema": {
"type": "number"
}
},
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/24C16065-FB6F-400A-B922-C814C6A32727?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Link Tracking Export",
"tags": [
"SMS Campaigns"
]
}
},
"/sms-campaigns/{campaign_id}/link-statistics": {
"get": {
"description": "Get 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 assume a value will always be specified.",
"operationId": "Link Statistics",
"parameters": [
{
"description": "Your campaign id.",
"example": "1",
"in": "path",
"name": "campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"browser": [
{
"count": 95,
"label": "Chrome"
},
{
"count": 3,
"label": "Opera"
},
{
"count": 10,
"label": "Safari"
}
],
"country": [
{
"count": 15,
"label": "Other"
},
{
"count": 1,
"label": "AF"
},
{
"count": 2,
"label": "AR"
},
{
"count": 1,
"label": "AU"
},
{
"count": 2,
"label": "BE"
},
{
"count": 4,
"label": "BR"
},
{
"count": 3,
"label": "CA"
},
{
"count": 1,
"label": "CH"
},
{
"count": 11,
"label": "CN"
},
{
"count": 1,
"label": "CZ"
},
{
"count": 4,
"label": "DE"
},
{
"count": 1,
"label": "DK"
},
{
"count": 1,
"label": "ES"
},
{
"count": 2,
"label": "FR"
},
{
"count": 1,
"label": "GB"
},
{
"count": 3,
"label": "IN"
},
{
"count": 1,
"label": "IR"
},
{
"count": 5,
"label": "JP"
},
{
"count": 3,
"label": "KR"
},
{
"count": 1,
"label": "MY"
},
{
"count": 2,
"label": "PK"
},
{
"count": 1,
"label": "PL"
},
{
"count": 3,
"label": "RU"
},
{
"count": 1,
"label": "SK"
},
{
"count": 2,
"label": "TW"
},
{
"count": 1,
"label": "UA"
},
{
"count": 34,
"label": "US"
},
{
"count": 1,
"label": "ZA"
}
],
"device": [
{
"count": 98,
"label": "Desktop"
},
{
"count": 10,
"label": "Mobile"
}
],
"links": {
"opened": 108,
"unopened": 1
},
"os": [
{
"count": 10,
"label": "IOS"
},
{
"count": 98,
"label": "OS X"
}
]
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Link Statistics",
"tags": [
"SMS Campaigns"
]
}
},
"/sms-campaigns/{campaign_id}/link-tracking": {
"get": {
"description": "This endpoint gives you a paginated overview of all the links in a particular campaign, and who has and hasn't visited them.",
"operationId": "Link Tracking",
"parameters": [
{
"description": "Your campaign id.",
"example": "1",
"in": "path",
"name": "campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"contact": {
"contact_id": 1,
"first_name": "John",
"last_name": "Smith",
"phone_number": "+61411111111"
},
"date_opened": null,
"open_count": 0,
"user_browser": null,
"user_device": null,
"user_geo_country": null,
"user_geo_region": null,
"user_os": null
},
{
"contact": {
"contact_id": 2,
"first_name": "Jane",
"last_name": "Doe",
"phone_number": "+61422222222"
},
"date_opened": 1508130356,
"open_count": 2,
"user_browser": "Chrome",
"user_device": "desktop",
"user_geo_country": "US",
"user_geo_region": "Illinois",
"user_os": "OS X"
},
{
"contact": {
"contact_id": 3,
"first_name": "Jill",
"last_name": "Smith",
"phone_number": "+61433333333"
},
"date_opened": 1508130333,
"open_count": 1,
"user_browser": "Safari",
"user_device": "phone",
"user_geo_country": "CA",
"user_geo_region": "Newfoundland and Labrador",
"user_os": "iOS"
}
],
"from": 1,
"last_page": 1,
"next_page_url": "https://rest.clicksend.com/v3/sms-campaigns/1/link-tracking?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 3,
"total": 3
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Link Tracking",
"tags": [
"SMS Campaigns"
]
}
},
"/sms-campaigns/{sms_campaign_id}": {
"get": {
"description": "",
"operationId": "Get SMS Campaign",
"parameters": [
{
"description": "Your SMS campaign id.",
"example": "1",
"in": "path",
"name": "sms_campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_total_count": 10,
"body": "This is my new campaign message.",
"custom_string": null,
"date_added": "1444882068",
"from": "+61353787448",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "My Campaign 1",
"schedule": "1444821615",
"sms_campaign_id": 2,
"source": null,
"status": "Sent",
"subaccount_id": 1,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your SMS Campaign."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get SMS Campaign",
"tags": [
"SMS Campaigns"
]
},
"put": {
"description": "",
"operationId": "Update an SMS Campaign",
"parameters": [
{
"description": "Your SMS Campaign id.",
"example": "1",
"in": "path",
"name": "sms_campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"body": "his is an awesome message.",
"from": "+61353787447",
"list_id": 428,
"name": "Awesome campaign.",
"schedule": 1444821615
},
"properties": {
"body": {
"description": "Your campaign message.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
},
"list_id": {
"description": "Your list id.",
"type": "number"
},
"name": {
"description": "Your campaign name.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Will replace existing schedule (even if left blank). Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
}
},
"required": [
"list_id",
"name",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "This is an awesome message.",
"custom_string": null,
"date_added": "1444962803",
"from": "+61353787447",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "Awesome campaign.",
"schedule": "1444821615",
"sms_campaign_id": 1,
"source": null,
"status": "Queued",
"subaccount_id": 1,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your SMS Campaign has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update an SMS Campaign",
"tags": [
"SMS Campaigns"
]
}
},
"/sms-campaigns/{sms_campaign_id}/cancel": {
"put": {
"description": "",
"operationId": "Cancel an SMS Campaign",
"parameters": [
{
"description": "Your SMS Campaign id.",
"example": "1",
"in": "path",
"name": "sms_campaign_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "This is an awesome message.",
"custom_string": null,
"date_added": "1444959876",
"from": "+61353787447",
"ip_address": "192.168.10.1",
"list_id": 428,
"name": "Awesome campaign.",
"schedule": "1444821615",
"sms_campaign_id": 1,
"source": null,
"status": "Cancelled",
"subaccount_id": 1,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your SMS Campaign has been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel an SMS Campaign",
"tags": [
"SMS Campaigns"
]
}
},
"/sms/cancel-all": {
"put": {
"description": "",
"operationId": "Cancel all Scheduled Messages",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"count": 5
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "5 messages has been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel all Scheduled Messages",
"tags": [
"SMS"
]
}
},
"/sms/email-sms": {
"get": {
"description": "Get list of allowed email addresses.",
"operationId": "List of Email-to-SMS Allowed Address",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"email_address": "my@email.com",
"email_address_id": 84,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 85,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 86,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 87,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 88,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 89,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 90,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 91,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 92,
"from": "+13523944199"
},
{
"email_address": "*@clickssend.com",
"email_address_id": 93,
"from": "+13523944199"
},
{
"email_address": "my@email.com.com",
"email_address_id": 94,
"from": "+13523944199"
},
{
"email_address": "my@email.com",
"email_address_id": 95,
"from": "+17128848693"
},
{
"email_address": "lOWAW@gmail.com",
"email_address_id": 96,
"from": "+17128848252"
},
{
"email_address": "munPM@gmail.com",
"email_address_id": 97,
"from": "+17128848867"
},
{
"email_address": "XZKK9@gmail.com",
"email_address_id": 98,
"from": "+17128847113"
}
],
"from": 1,
"last_page": 2,
"next_page_url": "https://rest.clicksend.com/v3/sms/email-sms/?page=2",
"per_page": 15,
"prev_page_url": null,
"to": 15,
"total": 25
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are some data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List of Email-to-SMS Allowed Address",
"tags": [
"Email-to-SMS Allowed Address"
]
},
"post": {
"description": "Create an allowed email address.",
"operationId": "Create Email to SMS Allowed Address",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"email_address": "Cv3p0@gmail.com",
"from": "+17128845887"
},
"properties": {
"email_address": {
"description": "Your email address.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
}
},
"required": [
"email_address"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"email_address": "Cv3p0@gmail.com",
"email_address_id": 107,
"from": "+17128845887"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New data has been saved."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Create Email to SMS Allowed Address",
"tags": [
"Email-to-SMS Allowed Address"
]
}
},
"/sms/email-sms-stripped-strings": {
"get": {
"description": "",
"operationId": "List Stripped Strings",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"rule_id": 18,
"strip_string": "This is a test1."
},
{
"rule_id": 19,
"strip_string": "This is a test2."
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List Stripped Strings",
"tags": [
"Email-to-SMS Stripped Strings"
]
},
"post": {
"description": "",
"operationId": "Create Stripped String",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"strip_string": "~~~test~~~"
},
"properties": {
"strip_string": {
"description": "The string that you want to strip from the body of email.",
"type": "string"
}
},
"required": [
"strip_string"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"rule_id": 20,
"strip_string": "~~~~test~~~~"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Strip string has been created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Create Stripped String",
"tags": [
"Email-to-SMS Stripped Strings"
]
}
},
"/sms/email-sms-stripped-strings/{rule_id}": {
"delete": {
"description": "",
"operationId": "Delete Stripped String",
"parameters": [
{
"description": "The rule id you want to access.",
"example": "20",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": true,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Strip string has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete Stripped String",
"tags": [
"Email-to-SMS Stripped Strings"
]
},
"get": {
"description": "",
"operationId": "Find Specific Stripped String",
"parameters": [
{
"description": "The rule id you want to access.",
"example": "18",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"rule_id": 18,
"strip_string": "You've received a reply from."
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Find Specific Stripped String",
"tags": [
"Email-to-SMS Stripped Strings"
]
},
"put": {
"description": "",
"operationId": "Update Stripped String",
"parameters": [
{
"description": "The rule id you want to access.",
"example": "20",
"in": "path",
"name": "rule_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"strip_string": "~~~test1~~~"
},
"properties": {
"strip_string": {
"description": "The string that you want to strip from the body of email.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"rule_id": 20,
"strip_string": "~~~~test1~~~~"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Strip string has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Update Stripped String",
"tags": [
"Email-to-SMS Stripped Strings"
]
}
},
"/sms/email-sms/{email_address_id}": {
"delete": {
"description": "Delete a specific allowed email address.",
"operationId": "Delete Email-to-SMS Allowed Address",
"parameters": [
{
"description": "Your email address id.",
"example": "107",
"in": "path",
"name": "email_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Allowed email address was deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete Email-to-SMS Allowed Address",
"tags": [
"Email-to-SMS Allowed Address"
]
},
"get": {
"description": "Get a specific allowed email address.",
"operationId": "Get specific Email-to-SMS Allowed Address",
"parameters": [
{
"description": "Your email address id.",
"example": "113",
"in": "path",
"name": "email_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"email_address": "RXcMn@gmail.com",
"email_address_id": 113,
"from": "+17128843729"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are some data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get specific Email-to-SMS Allowed Address",
"tags": [
"Email-to-SMS Allowed Address"
]
},
"put": {
"description": "Update a specific allowed email address.",
"operationId": "Update Email-to-SMS Allowed Address",
"parameters": [
{
"description": "Your email address id.",
"example": "107",
"in": "path",
"name": "email_address_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"email_address": "pfvRZ@gmail.com",
"from": "+17128842283"
},
"properties": {
"email_address": {
"description": "Your email address.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
}
},
"required": [
"email_address"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"email_address": "pfvRZ@gmail.com",
"email_address_id": 107,
"from": "+17128842283"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your data has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Update Email-to-SMS Allowed Address",
"tags": [
"Email-to-SMS Allowed Address"
]
}
},
"/sms/history/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export SMS History",
"parameters": [
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export SMS History",
"tags": [
"SMS"
]
}
},
"/sms/history?date_from={date_from}&date_to={date_to}": {
"get": {
"description": "**SMS Delivery Status**\n\n**Status (status field)**\n\n| Status | Description |\n|---|---|---|\n| `Completed` | Added to delivery queue. Waiting to be sent to the network.|\n| `Sent` | Message sent to the network.|\n| `Cancelled` | Message cancelled.|\n| `Scheduled` | Message scheduled.|\n| `WaitApproval` | Waiting approval by our team. This is temporary and will change to 'Sent' once approved. This only happens for a few messages that are flagged for approval by our automated spam-detection system.|\n\n**Status Codes (status_code field)**\n\n| Code | Text | Description |\n|---|---|---|\n| `200` | Sent by network| Temporary success|\n| `201` | Received on handset| Permanent success|\n| `300` | Delivery failure| Permanent failure|\n| `301` | Delivery failure| Permanent failure|\n| `302` | Delivery failure| Temporary failure - supplier routing issue|",
"operationId": "Get all History",
"parameters": [
{
"description": "Timestamp (from) used to show records by date.",
"example": "1449459940",
"in": "path",
"name": "date_from",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Timestamp (to) used to show recrods by date.",
"example": "1449659940",
"in": "path",
"name": "date_to",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_api_username": "johndoe",
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton 1iQByXxdLN.",
"carrier": "",
"contact_id": 0,
"country": "US",
"custom_string": "this is a test",
"date": "1436932432",
"direction": "out",
"error_code": null,
"error_text": null,
"first_name": "John",
"from": "sendlist",
"from_email": null,
"last_name": "Doe",
"list_id": null,
"message_id": "4E90F4C3-43A3-489D-9AB8-DA1F4332A0C3",
"message_parts": "1.00",
"message_price": "0.070000",
"schedule": "1436879372",
"status": "Completed",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+16783270696",
"user_id": 1
},
{
"_api_username": "johndoe",
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton 1iQByXxdLN.",
"carrier": "",
"contact_id": 0,
"country": "US",
"custom_string": "this is a test",
"date": "1436932432",
"direction": "out",
"error_code": null,
"error_text": null,
"first_name": "John",
"from": "sendlist",
"from_email": null,
"last_name": "Doe",
"list_id": null,
"message_id": "7DA5EB64-29FF-4E8A-AB6B-FE945EC9B45E",
"message_parts": "1.00",
"message_price": "0.070000",
"schedule": "1436879372",
"status": "Completed",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+16783275492",
"user_id": 1
},
{
"_api_username": "johndoe",
"body": "Jelly liquorice marshmallow candy carrot cake fgzOlMXuOI.",
"carrier": "Telstra",
"contact_id": 0,
"country": "AU",
"custom_string": "this is a test",
"date": "1436932503",
"direction": "out",
"error_code": null,
"error_text": null,
"from": "sendmobile",
"from_email": null,
"list_id": null,
"message_id": "064AF521-2A27-4B2A-9AB5-C45F555024EA",
"message_parts": "1.00",
"message_price": "0.070000",
"schedule": "1436871976",
"status": "Completed",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61411111111",
"user_id": 1
},
{
"_api_username": "johndoe",
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton 1iQByXxdLN.",
"carrier": "Telstra",
"contact_id": 0,
"country": "AU",
"custom_string": "this is a test",
"date": "1436932503",
"direction": "out",
"error_code": null,
"error_text": null,
"from": "sendlist",
"from_email": null,
"list_id": null,
"message_id": "25DD465D-2286-45AF-AE25-D7AB36587B57",
"message_parts": "1.00",
"message_price": "0.070000",
"schedule": "1436879372",
"status": "Completed",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+61411111111",
"user_id": 1
},
{
"_api_username": "johndoe",
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton 1iQByXxdLN.",
"carrier": "",
"contact_id": 0,
"country": "US",
"custom_string": "this is a test",
"date": "1436932503",
"direction": "out",
"error_code": null,
"error_text": null,
"first_name": "John",
"from": "sendlist",
"from_email": null,
"last_name": "Doe",
"list_id": null,
"message_id": "CBC8FCF2-78B2-4C7B-ABFB-76B7AC5CB558",
"message_parts": "1.00",
"message_price": "0.070000",
"schedule": "1436879372",
"status": "Completed",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+16783270696",
"user_id": 1
},
{
"_api_username": "johndoe",
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton 1iQByXxdLN.",
"carrier": "",
"contact_id": 0,
"country": "US",
"custom_string": "this is a test",
"date": "1436932503",
"direction": "out",
"error_code": null,
"error_text": null,
"first_name": "John",
"from": "sendlist",
"from_email": null,
"last_name": "Doe",
"list_id": null,
"message_id": "39266530-5430-44AA-B620-FDFC7D4A9184",
"message_parts": "1.00",
"message_price": "0.070000",
"schedule": "1436879372",
"status": "Completed",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+16783275492",
"user_id": 1
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 6,
"total": 6
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all History",
"tags": [
"SMS"
]
}
},
"/sms/inbound": {
"get": {
"description": "",
"operationId": "Get all Inbound SMS - Pull",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_keyword": "liquorice",
"body": "Liquorice sweet roll fruitcake gummies. ",
"custom_string": "22PKU978RF",
"from": "+61411111111",
"message_id": "C557B56E-83C0-4070-A74C-9BF05474B418",
"original_body": "Liquorice sweet roll fruitcake gummies. ",
"original_message_id": "C557B56E-83C0-4070-A74C-9BF05474B418",
"timestamp": "1436174407",
"to": "SC557B56E-83C0-4070-A74C-9BF05474B418"
},
{
"_keyword": "lemon",
"body": "Lemon drops brownie pie chocolate bar pie sweet jelly-o chocolate.",
"custom_string": "2ATQKLETYX",
"from": "Lemon drops brownie pie chocolate bar pie swe",
"message_id": "C557B56E-83C0-4070-A74C-9BF05474B418",
"original_body": "Lemon drops brownie pie chocolate bar pie sweet jelly-o chocolate.",
"original_message_id": "373F7121-8089-42FA-8F5C-8F8F7C18DFAA",
"timestamp": "1436174406",
"to": "S373F7121-8089-42FA-8F5C-8F8F7C18DFAA"
},
{
"_keyword": "jelly",
"body": "Jelly beans jelly cupcake bear claw gummies.",
"custom_string": "0PZCOGJP0A",
"from": "Jelly beans jelly cupcake bear claw gummies.",
"message_id": "C557B56E-83C0-4070-A74C-9BF05474B418",
"original_body": "Jelly beans jelly cupcake bear claw gummies.",
"original_message_id": "A9F3863C-D88E-4A54-BEF1-BD73A6E42E2E",
"timestamp": "1436174405",
"to": "SA9F3863C-D88E-4A54-BEF1-BD73A6E42E2E"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 3,
"total": 3
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Inbound SMS - Pull",
"tags": [
"SMS"
]
},
"post": {
"description": "",
"operationId": "Add a Test Inbound SMS",
"requestBody": {
"$ref": "#/components/requestBodies/Add_a_Test_Delivery_ReceiptBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_keyword": "this",
"body": "This is a test incoming SMS. 5IHHOWWZTB.",
"custom_string": null,
"from": "+61468460249",
"message_id": "C557B56E-83C0-4070-A74C-9BF05474B418",
"original_body": "This is the original message. AA4NN45X7J.",
"original_message_id": "F35B6DF1-0C9E-488F-954E-2F603B6192F5",
"timestamp": "1442398236",
"to": "+61411111111"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your incoming messages."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Add a Test Inbound SMS",
"tags": [
"SMS"
]
}
},
"/sms/inbound-read": {
"put": {
"description": "",
"operationId": "Mark all Inbound SMS as read",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"date_before": 1442398100
},
"properties": {
"date_before": {
"description": "An optional timestamp - mark all as read before this timestamp. If not given, all messages will be marked as read.",
"type": "number"
}
},
"required": [
"date_before"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Inbound messages have been marked as read."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Mark all Inbound SMS as read",
"tags": [
"SMS"
]
}
},
"/sms/inbound-read/{message_id}": {
"put": {
"description": "",
"operationId": "Mark a specific Inbound SMS as read",
"parameters": [
{
"description": "Message ID. Must be a valid GUID.",
"example": "C557B56E-83C0-4070-A74C-9BF05474B418",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Inbound messages have been marked as read."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Mark a specific Inbound SMS as read",
"tags": [
"SMS"
]
}
},
"/sms/inbound/{outbound_message_id}": {
"get": {
"description": "",
"operationId": "Get Specific Inbound - Pull",
"parameters": [
{
"description": "Message ID of the original outbound message, to which the inbound message is a reply. Must be a valid GUID.",
"example": "C557B56E-83C0-4070-A74C-9BF05474B418",
"in": "path",
"name": "outbound_message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_keyword": "this",
"body": "This is a test incoming SMS. IWXTUW9DCH.",
"custom_string": "custom_string",
"from": "+61410926433",
"message_id": "C557B56E-83C0-4070-A74C-9BF05474B418",
"original_body": "This is the original message. 0CSO0ITKJM.",
"original_message_id": "5D420421-8715-4461-A9A2-C8F569E41835",
"timestamp": "1457947468",
"to": "+61411111111"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here's your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Inbound - Pull",
"tags": [
"SMS"
]
}
},
"/sms/price": {
"post": {
"description": "",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"custom_string": "this is a test",
"from": "sendmobile",
"schedule": 1436874701,
"source": "php",
"to": "+61411111111"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"custom_string": "this is a test",
"from": "sendlist",
"list_id": 428,
"schedule": 1436876011,
"source": "php"
}
]
},
"properties": {
"body": {
"description": "Your message.",
"type": "string"
},
"country": {
"description": "Recipient country.",
"type": "string"
},
"custom_string": {
"description": "Your reference. Will be passed back with all replies and delivery reports.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
},
"list_id": {
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'.",
"type": "number"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
},
"to": {
"description": "Recipient number in E.164 format or local format ([more info](https://help.clicksend.com/SMS/what-format-does-the-recipient-phone-number-need-to-be-in)).",
"type": "string"
}
},
"required": [
"to",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"country": "AU",
"custom_string": "this is a test",
"from": "sendmobile",
"message_parts": 1,
"message_price": "0.0566",
"schedule": 1436874701,
"status": "SUCCESS",
"to": "+61411111111"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"country": "AU",
"custom_string": "this is a test",
"from": "sendlist",
"message_parts": 1,
"message_price": "0.0566",
"schedule": 1436876011,
"status": "SUCCESS",
"to": "+61411111111"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"country": "US",
"custom_string": "this is a test",
"from": "sendlist",
"message_parts": 1,
"message_price": "0.0566",
"schedule": 1436876011,
"status": "SUCCESS",
"to": "+16783270696"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"country": "US",
"custom_string": "this is a test",
"from": "sendlist",
"message_parts": 1,
"message_price": "0.0566",
"schedule": 1436876011,
"status": "SUCCESS",
"to": "+16783275492"
}
],
"queued_count": 4,
"total_count": 4,
"total_price": 0.2264
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Calculate Price",
"tags": [
"SMS"
]
}
},
"/sms/receipts": {
"get": {
"description": "",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"_message_type": "sms",
"custom_string": null,
"error_code": null,
"error_text": null,
"message_id": "31BC271B-1E0C-45F6-9E7E-97186C46BB82",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"timestamp": "1442381791",
"timestamp_send": "1442381791"
},
{
"_message_type": "sms",
"custom_string": null,
"error_code": null,
"error_text": null,
"message_id": "23C8ADA3-FD8B-420B-801A-F829BB87AC6F",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"timestamp": "1442381829",
"timestamp_send": "1442381829"
},
{
"_message_type": "sms",
"custom_string": null,
"error_code": null,
"error_text": null,
"message_id": "3BD22FAD-A5D3-4D99-B4C0-16BF65BE052C",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"timestamp": "1442381861",
"timestamp_send": "1442381861"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 3,
"total": 3
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your delivery receipts."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Delivery Receipts",
"tags": [
"SMS"
]
},
"post": {
"description": "",
"requestBody": {
"$ref": "#/components/requestBodies/Add_a_Test_Delivery_ReceiptBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"custom_string": null,
"error_code": null,
"error_text": null,
"message_id": "493FFB41-9733-4641-985F-BD79A067B58F",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"timestamp": "1441958441"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Receipt has been added"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Add a Test Delivery Receipt",
"tags": [
"SMS"
]
}
},
"/sms/receipts-read": {
"put": {
"description": "",
"operationId": "Mark Delivery Receipts as read",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"date_before": 1441958441
},
"properties": {
"date_before": {
"description": "An optional timestamp - mark all as read before this timestamp. If not given, all receipts will be marked as read.",
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Receipts has been marked as read."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Mark Delivery Receipts as read",
"tags": [
"SMS"
]
}
},
"/sms/receipts/{message_id}": {
"get": {
"description": "",
"operationId": "Get a Specific Delivery Receipt",
"parameters": [
{
"description": "Your message id.",
"example": "88AB118E EB1B 478C 98CE 6C73ABA23F67",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"custom_string": "",
"error_code": "errorcode",
"error_text": "errortext",
"message_id": "88AB118E-EB1B-478C-98CE-6C73ABA23F67",
"message_type": "sms",
"status_code": "Completed",
"status_text": "statustext",
"timestamp": "1451200622",
"timestamp_send": "1450854013"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your receipt."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a Specific Delivery Receipt",
"tags": [
"SMS"
]
}
},
"/sms/send": {
"post": {
"description": "You can post **up to 1000 messages** with each API call.",
"operationId": "Send an SMS",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"custom_string": "this is a test",
"from": "sendmobile",
"schedule": 1436874701,
"source": "php",
"to": "+61411111111"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"custom_string": "this is a test",
"from": "sendlist",
"list_id": 428,
"schedule": 1436876011,
"source": "php"
}
]
},
"properties": {
"body": {
"description": "Your message.",
"type": "string"
},
"country": {
"description": "Recipient country.",
"type": "string"
},
"custom_string": {
"description": "Your reference. Will be passed back with all replies and delivery reports.",
"type": "string"
},
"from": {
"description": "Your sender id - [more info](http://help.clicksend.com/SMS/what-is-a-sender-id-or-sender-number).",
"type": "string"
},
"from_email": {
"description": "An email address where the reply should be emailed to. If omitted, the reply will be emailed back to the user who sent the outgoing SMS.",
"type": "string"
},
"list_id": {
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'.",
"type": "number"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
},
"to": {
"description": "Recipient number in E.164 format or local format ([more info](https://help.clicksend.com/SMS/what-format-does-the-recipient-phone-number-need-to-be-in)).",
"type": "string"
}
},
"required": [
"to",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"carrier": "Telstra",
"country": "AU",
"custom_string": "this is a test",
"date": 1436871253,
"direction": "out",
"from": "sendmobile",
"message_id": "BF7AD270-0DE2-418B-B606-71D527D9C1AE",
"message_parts": 1,
"message_price": 0.07,
"schedule": 1436874701,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+61411111111",
"user_id": 1
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"carrier": "Telstra",
"country": "AU",
"custom_string": "this is a test",
"date": 1436871253,
"direction": "out",
"from": "sendlist",
"message_id": "D0C273EE-816D-4DF2-8E9D-9D9C65F168F3",
"message_parts": 1,
"message_price": 0.07,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+61411111111",
"user_id": 1
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"carrier": "",
"country": "US",
"custom_string": "this is a test",
"date": 1436871253,
"direction": "out",
"from": "sendlist",
"message_id": "A1845B61-C404-4793-8661-97890C19C8A2",
"message_parts": 1,
"message_price": 0.07,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+16783270696",
"user_id": 1
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"carrier": "",
"country": "US",
"custom_string": "this is a test",
"date": 1436871253,
"direction": "out",
"from": "sendlist",
"message_id": "DB545FAA-7325-465F-A696-8BDBFA8C1E49",
"message_parts": 1,
"message_price": 0.07,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+16783275492",
"user_id": 1
}
],
"queued_count": 4,
"total_count": 4,
"total_price": 0.28
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Send an SMS",
"tags": [
"SMS"
]
}
},
"/sms/templates": {
"get": {
"description": "Get list of templates.",
"operationId": "List of Templates",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"body": "This is a sample template.",
"template_id": 1,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 2,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 3,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 4,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 5,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 6,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 7,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 8,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 9,
"template_name": "My Awesome Template"
},
{
"body": "This is a sample template.",
"template_id": 10,
"template_name": "My Awesome Template"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 10,
"total": 10
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "List of Templates",
"tags": [
"SMS Templates"
]
},
"post": {
"description": "Create new template.",
"operationId": "Create a Template",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"body": "This is a sample content: H7YI68B3yk for this template.",
"template_name": "Template 501916"
},
"properties": {
"body": {
"description": "Your template body.",
"type": "string"
},
"template_name": {
"description": "Your template name.",
"type": "string"
}
},
"required": [
"template_name",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "This is a sample content: H7YI68B3yk for this template.",
"template_id": 25,
"template_name": "Template 501916"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New template has been saved."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Create a Template",
"tags": [
"SMS Templates"
]
}
},
"/sms/templates/{template_id}": {
"delete": {
"description": "",
"operationId": "Delete a Template",
"parameters": [
{
"description": "Your template id.",
"example": "25",
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your template has been deleted."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a Template",
"tags": [
"SMS Templates"
]
},
"put": {
"description": "",
"operationId": "Update a Template",
"parameters": [
{
"description": "Your template id.",
"example": "25",
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"body": "This is a sample content: Sc0KNWgSMG for this template.",
"template_name": "I am updated"
},
"properties": {
"body": {
"description": "Your template body.",
"type": "string"
},
"template_name": {
"description": "Your template name.",
"type": "string"
}
},
"required": [
"template_name",
"body"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"body": "This is a sample content: Sc0KNWgSMG for this template.",
"template_id": 25,
"template_name": "I am updated"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your template has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Update a Template",
"tags": [
"SMS Templates"
]
}
},
"/sms/{message_id}/cancel": {
"put": {
"description": "",
"operationId": "Cancel a Scheduled Message",
"parameters": [
{
"description": "B7CE432193CD-0753597B7293 (string, required) - The message ID you want to cancel.",
"example": "307EF035",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Message 307EF035-B7CE-4321-93CD-0753597B7293 has been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel a Scheduled Message",
"tags": [
"SMS"
]
}
},
"/statistics/sms": {
"get": {
"description": "",
"operationId": "Get SMS Statistics",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "Australian Dollars",
"currency_name_short": "AUD",
"currency_prefix_c": "c",
"currency_prefix_d": "$"
},
"stat": [
{
"bounced": {
"count": 0
},
"date": 1434412800,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1434499200,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1434585600,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1434672000,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1434758400,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1434844800,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1434931200,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435017600,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435104000,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435190400,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435276800,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435363200,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435449600,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435536000,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435622400,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435708800,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435795200,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435881600,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1435968000,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436054400,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436140800,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436227200,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436313600,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436400000,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436486400,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436572800,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436659200,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436745600,
"inbound": {
"count": 0
},
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1436832000,
"inbound": {
"count": 0
},
"outbound": {
"count": 49,
"price": 3.43
}
},
{
"bounced": {
"count": 0
},
"date": 1436918400,
"inbound": {
"count": 0
},
"outbound": {
"count": 83,
"price": 5.81
}
}
],
"total": {
"bounced": {
"count": 0
},
"inbound": {
"count": 0
},
"outbound": {
"count": 132,
"price": 9.24
}
}
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get SMS Statistics",
"tags": [
"Statistics"
]
}
},
"/statistics/voice": {
"get": {
"description": "",
"operationId": "Get Voice Statistics",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"stats": [
{
"bounced": {
"count": 0
},
"date": 1441065600,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441152000,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441238400,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441324800,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441411200,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441497600,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441584000,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441670400,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441756800,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441843200,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1441929600,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442016000,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442102400,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442188800,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442275200,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442361600,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442448000,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442534400,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442620800,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442707200,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442793600,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442880000,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1442966400,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1443052800,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1443139200,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1443225600,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1443312000,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1443398400,
"outbound": {
"count": 0,
"price": 0
}
},
{
"bounced": {
"count": 0
},
"date": 1443484800,
"outbound": {
"count": 4,
"price": 0.6600252
}
},
{
"bounced": {
"count": 0
},
"date": 1443571200,
"outbound": {
"count": 0,
"price": 0
}
}
],
"total": {
"bounced": {
"count": 0
},
"outbound": {
"count": 4,
"price": 0.6600252
}
}
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your statistics."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Voice Statistics",
"tags": [
"Statistics"
]
}
},
"/subaccounts": {
"get": {
"description": "",
"operationId": "Get all Subaccounts",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "E72D09F6-AC80-0A5C-F7F0-1A244A377A5C",
"api_username": "johndoe",
"email": "john@doe.com",
"first_name": "John",
"last_name": "Doe",
"notes": null,
"phone_number": "+13523944199",
"share_campaigns": 0,
"subaccount_id": 1
},
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "B7825E96-6A67-1275-0F35-8DB8AC743B2C",
"api_username": "name9Fb",
"email": "testvT9@gmail.com",
"first_name": "Firstname7JiPG",
"last_name": "Lastname2olB1",
"notes": null,
"phone_number": "+19417516953",
"share_campaigns": 0,
"subaccount_id": 27
},
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "D09BA7BC-546A-C951-6D3D-DAE3FEE6D848",
"api_username": "nameLXD",
"email": "testIiq@gmail.com",
"first_name": "FirstnameSA3tA",
"last_name": "Lastname22Pam",
"notes": null,
"phone_number": "+19417519130",
"share_campaigns": 0,
"subaccount_id": 28
},
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "9415E584-794E-4F90-699D-7ECEF7290E51",
"api_username": "nameh7m",
"email": "testxQv.updated@gmail.com",
"first_name": "Firstname5dgZw Updated",
"last_name": "Lastname0voRd Updated",
"notes": null,
"phone_number": "+19417519640",
"share_campaigns": 0,
"subaccount_id": 29
},
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "6E1491FC-797E-3011-1274-595EAFDE06EE",
"api_username": "name5XC",
"email": "testaLj.updated@gmail.com",
"first_name": "FirstnameZcMSS Updated",
"last_name": "LastnameDLmEB Updated",
"notes": null,
"phone_number": "+19417514461",
"share_campaigns": 0,
"subaccount_id": 30
},
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "2C3B97DD-6C61-94BF-7886-9CA11DF550AF",
"api_username": "franklinew5",
"email": "frank@test.com",
"first_name": "John",
"last_name": "Doe",
"notes": null,
"phone_number": "+13108147982",
"share_campaigns": 0,
"subaccount_id": 47
},
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "DE5F8C8F-E939-941B-C9E0-2BD542C3FFE3",
"api_username": "franklinew6",
"email": "frank@test.com",
"first_name": "John",
"last_name": "Doe",
"notes": null,
"phone_number": "+13108147982",
"share_campaigns": 0,
"subaccount_id": 48
},
{
"access_billing": 1,
"access_contacts": 1,
"access_email": 0,
"access_fax": 0,
"access_mms": 0,
"access_post": 0,
"access_reporting": 1,
"access_reseller": 0,
"access_settings": 1,
"access_sms": 0,
"access_users": 1,
"access_voice": 0,
"api_key": "6279E8E9-8D02-72AE-9824-BF7C0C2E4FE7",
"api_username": "franklinew7",
"email": "frank@test.com",
"first_name": "John",
"last_name": "Doe",
"notes": null,
"phone_number": "+13108147982",
"share_campaigns": 0,
"subaccount_id": 49
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 8,
"total": 8
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "SUCCESS"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get all Subaccounts",
"tags": [
"Subaccounts"
]
},
"post": {
"description": "",
"operationId": "Create a new subaccount",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"api_username": "nameP99",
"email": "testvrq@gmail.com",
"first_name": "FirstnameeGPqV",
"last_name": "LastnamePvjJp",
"password": "pass",
"phone_number": "941-751-3278"
},
"properties": {
"access_billing": {
"description": "Your access billing flag value, must be 1 or 0.",
"type": "number"
},
"access_contacts": {
"description": "Your access contacts flag value, must be 1 or 0.",
"type": "number"
},
"access_reporting": {
"description": "Your access reporting flag value, must be 1 or 0.",
"type": "number"
},
"access_settings": {
"description": "Your access settings flag value, must be 1 or 0.",
"type": "number"
},
"access_users": {
"description": "Your access users flag value, must be 1 or 0.",
"type": "number"
},
"api_username": {
"description": "Your new api username.",
"type": "string"
},
"email": {
"description": "Your new email.",
"type": "string"
},
"first_name": {
"description": "Your firstname.",
"type": "string"
},
"last_name": {
"description": "Your lastname.",
"type": "string"
},
"password": {
"description": "Your new password.",
"type": "string"
},
"phone_number": {
"description": "Your phone number in E.164 format.",
"type": "string"
},
"share_campaigns": {
"description": "Your share campaigns flag value, must be 1 or 0.",
"type": "number"
}
},
"required": [
"api_username",
"password",
"email",
"phone_number",
"first_name",
"last_name"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "367C506E-FBCA-1EDA-E8E0-1384F9F196D5",
"api_username": "nameP99",
"email": "testvrq@gmail.com",
"first_name": "FirstnameeGPqV",
"last_name": "LastnamePvjJp",
"notes": null,
"phone_number": "+619417513278",
"share_campaigns": 0,
"subaccount_id": 59
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "New account has been created."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Create a new subaccount",
"tags": [
"Subaccounts"
]
}
},
"/subaccounts/{subaccount_id}": {
"delete": {
"description": "",
"operationId": "Delete a specific subaccount",
"parameters": [
{
"description": "The subaccount ID you want to access.",
"example": "59",
"in": "path",
"name": "subaccount_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": true,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Subaccount #59 has been deleted"
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Delete a specific subaccount",
"tags": [
"Subaccounts"
]
},
"get": {
"description": "",
"operationId": "Get a specific subaccount",
"parameters": [
{
"description": "The subaccount ID you want to access.",
"example": "59",
"in": "path",
"name": "subaccount_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "367C506E-FBCA-1EDA-E8E0-1384F9F196D5",
"api_username": "nameP99",
"email": "testvrq@gmail.com",
"first_name": "FirstnameeGPqV",
"last_name": "LastnamePvjJp",
"notes": null,
"phone_number": "+619417513278",
"share_campaigns": 0,
"subaccount_id": 59
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get a specific subaccount",
"tags": [
"Subaccounts"
]
},
"put": {
"description": "",
"operationId": "Update a specific subaccount",
"parameters": [
{
"description": "The subaccount ID you want to access.",
"example": "59",
"in": "path",
"name": "subaccount_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"email": "testfP0.updated@gmail.com",
"first_name": "FirstnameKvdRZUpdated",
"last_name": "LastnameHUPYGUpdated",
"notes": null,
"password": "pass",
"phone_number": "+19417519130",
"share_campaigns": 0
},
"properties": {
"access_billing": {
"description": "Your access billing flag value, must be 1 or 0.",
"type": "number"
},
"access_contacts": {
"description": "Your access contacts flag value, must be 1 or 0.",
"type": "number"
},
"access_reporting": {
"description": "Your access reporting flag value, must be 1 or 0.",
"type": "number"
},
"access_settings": {
"description": "Your access settings flag value, must be 1 or 0.",
"type": "number"
},
"access_users": {
"description": "Your access users flag value, must be 1 or 0.",
"type": "number"
},
"email": {
"description": "Your new email.",
"type": "string"
},
"first_name": {
"description": "Your firstname.",
"type": "string"
},
"last_name": {
"description": "Your lastname.",
"type": "string"
},
"password": {
"description": "Your new password.",
"type": "string"
},
"phone_number": {
"description": "Your phone number in E.164 format.",
"type": "string"
},
"share_campaigns": {
"description": "Your share campaigns flag value, must be 1 or 0.",
"type": "number"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"access_billing": 1,
"access_contacts": 1,
"access_email": 1,
"access_fax": 1,
"access_mms": 1,
"access_post": 1,
"access_reporting": 1,
"access_reseller": 1,
"access_settings": 1,
"access_sms": 1,
"access_users": 1,
"access_voice": 1,
"api_key": "367C506E-FBCA-1EDA-E8E0-1384F9F196D5",
"api_username": "nameP99",
"email": "testfP0.updated@gmail.com",
"first_name": "FirstnameKvdRZ Updated",
"last_name": "LastnameHUPYG Updated",
"notes": null,
"phone_number": "+619417513065",
"share_campaigns": 0,
"subaccount_id": 59
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Subaccount #59 has been updated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Update a specific subaccount",
"tags": [
"Subaccounts"
]
}
},
"/subaccounts/{subaccount_id}/regen-api-key": {
"put": {
"description": "",
"operationId": "Regenerate API Key",
"parameters": [
{
"description": "The ID of the subaccount to be accessed.",
"example": "2837",
"in": "path",
"name": "subaccount_id",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"api_key": "E72D09F6-AC80-0A5C-F7F0-1A244A377A5C"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your API Key has been regenerated."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Regenerate API Key",
"tags": [
"Subaccounts"
]
}
},
"/timezones": {
"get": {
"description": "Get supported list of timezones.",
"operationId": "Get Timezones",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Johnston",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"UTC"
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "List of timezones."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Timezones",
"tags": [
"Timezones"
]
}
},
"/uploads?convert={convert}": {
"post": {
"description": "",
"operationId": "Upload a file",
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"example": {
"content": "PGh0bWw+PGhlYWQ+PHN0eWxlIHR5cGU9InRleHQvY3NzIj5ib2R5IHsgZm9udC1mYW1pbHk6J0FyaWFsJzsgfTwvc3R5bGU+PHRpdGxlPkhpPC90aXRsZT48L2hlYWQ+PGJvZHk+PGgxPkhlbGxvIHRoZXJlPC9oMT48aDI+SG93IGFyZSB5b3UgdG9kYXk/PC9oMj48L2JvZHk+PC9odG1sPg=="
},
"properties": {
"content": {
"description": "Your file contents encoded in `base64`.",
"type": "string"
},
"convert": {
"description": "Conversion type: `fax`, `mms`, `csv` or `post`",
"type": "string"
}
},
"required": [
"content",
"convert"
],
"type": "object"
},
{
"properties": {
"convert": {
"description": "Conversion type: `fax`, `mms`, `csv` or `post`",
"type": "string"
},
"file": {
"description": "Your file.",
"type": "string"
}
},
"required": [
"file",
"convert"
],
"type": "object"
}
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"_url": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/document.pdf",
"date_added": 1449500640,
"date_delete": 1450105440,
"file_name": "161BFA93-3660-4B03-9BCB-7629166F2E91.pdf",
"upload_id": 15,
"user_id": 1
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Your file has been uploaded."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Upload a file",
"tags": [
"Uploads"
]
}
},
"/voice/cancel-all": {
"put": {
"description": "",
"operationId": "Cancel all Voice Calls",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"count": 5
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "5 messages have been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel all Voice Calls",
"tags": [
"Voice"
]
}
},
"/voice/history/export?filename={filename}": {
"get": {
"description": "",
"operationId": "Export Voice History",
"parameters": [
{
"description": "Your export filename.",
"example": "export.csv",
"in": "path",
"name": "filename",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"url": "https://rest.clicksend.com/files/22D55AF9-6CF0-476D-A8B3-82A998FD2738?filename=export.csv"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Download your file here."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Export Voice History",
"tags": [
"Voice"
]
}
},
"/voice/history?date_from={date_from}&date_to={date_to}": {
"get": {
"description": "",
"operationId": "Get Voice History",
"parameters": [
{
"description": "Timestamp (from) used to show records by date.",
"example": "1443501617",
"in": "path",
"name": "date_from",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Timestamp (to) used to show recrods by date.",
"example": "1443501727",
"in": "path",
"name": "date_to",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"body": "this is a test.",
"carrier": "",
"country": "US",
"custom_string": "mystring",
"date_added": 1443501617,
"digits": null,
"from": "+19403944918",
"lang": "en-us",
"list_id": null,
"machine_detected": 0,
"message_id": "D6456F8A-9DF9-46EC-8014-BFE87860F65C",
"message_parts": "1.00",
"message_price": "0.17",
"require_input": 0,
"schedule": "1538672470",
"status": "WaitApproval",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+15184811537",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "this is a test.",
"carrier": "",
"country": "US",
"custom_string": "mystring",
"date_added": 1443501727,
"digits": null,
"from": "+19403944918",
"lang": "en-us",
"list_id": null,
"machine_detected": 0,
"message_id": "25304958-15F2-41D9-8716-CF1F28EF506B",
"message_parts": "1.00",
"message_price": "0.17",
"require_input": 0,
"schedule": "1538672470",
"status": "WaitApproval",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+15184811537",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "this is a test.",
"carrier": "",
"country": "US",
"custom_string": "mystring",
"date_added": 1443501727,
"digits": null,
"from": "+19403944918",
"lang": "en-us",
"list_id": null,
"machine_detected": 0,
"message_id": "0B474459-B75F-4180-9567-7ECA3FC56BD7",
"message_parts": "1.00",
"message_price": "0.17",
"require_input": 0,
"schedule": "1538672470",
"status": "WaitApproval",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+15184811538",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "this is a test.",
"carrier": "",
"country": "US",
"custom_string": "mystring",
"date_added": 1443501727,
"digits": null,
"from": "+19403944918",
"lang": "en-us",
"list_id": null,
"machine_detected": 0,
"message_id": "A991556C-D4A5-47D5-A5E5-C9D251C8743A",
"message_parts": "1.00",
"message_price": "0.17",
"require_input": 0,
"schedule": "1538672470",
"status": "WaitApproval",
"status_code": null,
"status_text": null,
"subaccount_id": 1,
"to": "+15184811539",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 4,
"total": 4
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your history."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Voice History",
"tags": [
"Voice"
]
}
},
"/voice/lang": {
"get": {
"description": "",
"operationId": "Voice Languages",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [
{
"code": "en-us",
"country": "English, US",
"gender": [
"female",
"male"
]
},
{
"code": "en-au",
"country": "English, Australia",
"gender": [
"female",
"male"
]
},
{
"code": "en-gb",
"country": "English, UK",
"gender": [
"female",
"male"
]
},
{
"code": "en-in",
"country": "English, India",
"gender": "female"
},
{
"code": "de-de",
"country": "German, Germany",
"gender": [
"female",
"male"
]
},
{
"code": "es-es",
"country": "Spanish, Spain",
"gender": [
"female",
"male"
]
},
{
"code": "es-us",
"country": "Spanish, US",
"gender": [
"female",
"male"
]
},
{
"code": "fr-ca",
"country": "French, Canada",
"gender": "female"
},
{
"code": "fr-fr",
"country": "French, France",
"gender": [
"female",
"male"
]
},
{
"code": "is-is",
"country": "Icelandic, Iceland",
"gender": [
"female",
"male"
]
},
{
"code": "it-it",
"country": "Italian, Italy",
"gender": [
"female",
"male"
]
},
{
"code": "nl-nl",
"country": "Dutch, Netherlands",
"gender": [
"female",
"male"
]
},
{
"code": "pl-pl",
"country": "Polish-Poland",
"gender": [
"female",
"male"
]
},
{
"code": "pt-pt",
"country": "Portuguese, Portugal",
"gender": "male"
},
{
"code": "pt-br",
"country": "Portuguese, Brazil",
"gender": [
"female",
"male"
]
},
{
"code": "ro-ro",
"country": "Romanian, Romania",
"gender": "female"
},
{
"code": "ru-ru",
"country": "Russian, Russia",
"gender": [
"female",
"male"
]
},
{
"code": "sv-se",
"country": "Swedish, Sweden",
"gender": "female"
},
{
"code": "tr-tr",
"country": "Turkish, Turkey",
"gender": "female"
},
{
"code": "en-gb-wls",
"country": "English, Wales",
"gender": [
"female",
"male"
]
},
{
"code": "cy-gb-wls",
"country": "Celtic, Wales",
"gender": [
"female",
"male"
]
},
{
"code": "nb-no",
"country": "Norwegian, Norway",
"gender": "female"
},
{
"code": "da-dk",
"country": "Danish, Denmark",
"gender": [
"female",
"male"
]
}
],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are the possible languages."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Voice Languages",
"tags": [
"Voice"
]
}
},
"/voice/price": {
"post": {
"description": "",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"custom_string": "this is a test",
"lang": "en-au",
"schedule": 1436874701,
"source": "php",
"to": "+61411111111",
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"custom_string": "this is a test",
"lang": "en-au",
"list_id": 428,
"require_input": 1,
"schedule": 1436876011,
"source": "php",
"voice": "female"
}
]
},
"properties": {
"body": {
"description": "Your message.",
"type": "string"
},
"country": {
"description": "The country of the recipient.",
"type": "string"
},
"custom_string": {
"description": "Your reference. Will be passed back with all replies and delivery reports.",
"type": "string"
},
"lang": {
"description": "au (string, required) - See section on available languages.",
"type": "string"
},
"list_id": {
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'.",
"type": "number"
},
"require_input": {
"description": "Whether you want to receive a keypress from the call recipient (1 for on, 0 [default] for off)",
"type": "number"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
},
"to": {
"description": "Recipient number in E.164 format or local format ([more info](https://help.clicksend.com/SMS/what-format-does-the-recipient-phone-number-need-to-be-in)).",
"type": "string"
},
"voice": {
"description": "Either 'female' or 'male'.",
"type": "string"
}
},
"required": [
"to",
"body",
"voice"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"country": "AU",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "BF7AD270-0DE2-418B-B606-71D527D9C1AE",
"message_parts": 1,
"message_price": 0.07,
"require_input": 0,
"schedule": 1436874701,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+61411111111",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"country": "AU",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "D0C273EE-816D-4DF2-8E9D-9D9C65F168F3",
"message_parts": 1,
"message_price": 0.07,
"require_input": 1,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+61411111111",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"country": "US",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "A1845B61-C404-4793-8661-97890C19C8A2",
"message_parts": 1,
"message_price": 0.07,
"require_input": 1,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+16783270696",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"country": "US",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "DB545FAA-7325-465F-A696-8BDBFA8C1E49",
"message_parts": 1,
"message_price": 0.07,
"require_input": 1,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+16783275492",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
}
],
"queued_count": 4,
"total_count": 4,
"total_price": 0.28
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Calculate Price",
"tags": [
"Voice"
]
}
},
"/voice/receipts": {
"get": {
"description": "",
"operationId": "Get Voice receipts",
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"current_page": 1,
"data": [
{
"custom_string": null,
"digits": "2",
"error_code": null,
"error_text": null,
"message_id": "31BC271B-1E0C-45F6-9E7E-97186C46BB82",
"message_type": "voice",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"timestamp": "1442381791",
"timestamp_send": "1442381791"
},
{
"custom_string": null,
"digits": "5",
"error_code": null,
"error_text": null,
"message_id": "23C8ADA3-FD8B-420B-801A-F829BB87AC6F",
"message_type": "voice",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"timestamp": "1442381829",
"timestamp_send": "1442381829"
}
],
"from": 1,
"last_page": 1,
"next_page_url": null,
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your delivery receipts."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Voice receipts",
"tags": [
"Voice"
]
},
"post": {
"description": "",
"requestBody": {
"$ref": "#/components/requestBodies/Add_a_Test_Delivery_ReceiptBody"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"custom_string": null,
"digits": "2",
"error_code": null,
"error_text": null,
"message_id": "CEA5E06A-F4BF-4EC6-8315-B25087352DFA",
"message_type": "voice",
"status_code": "201",
"status_text": "Success: Message received on handset.",
"subaccount_id": 1746,
"timestamp": "1489730505",
"timestamp_send": "1489730505"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Test receipt has been added."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Add a Test Delivery Receipt",
"tags": [
"Voice"
]
}
},
"/voice/receipts-read?date_before={date_before}": {
"put": {
"description": "",
"operationId": "Marked Voice Receipts as Read",
"parameters": [
{
"description": "An optional [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp) - mark all as read before this timestamp. If not given, all receipts will be marked as read.",
"example": "1461897483",
"in": "path",
"name": "date_before",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": null,
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Receipts have been marked as read."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Marked Voice Receipts as Read",
"tags": [
"Voice"
]
}
},
"/voice/receipts/{message_id}": {
"get": {
"description": "",
"operationId": "Get Specific Voice Receipt",
"parameters": [
{
"description": "3055-45F1-9B79-F2C43509FD16 (string, required) - The voice receipt message id.",
"example": "28DD2718",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"custom_string": "custom string test",
"digits": "6",
"error_code": "",
"error_text": "",
"message_id": "1FCFEBBF-90F5-4198-AEBD-5DAEDBA3D7B1",
"message_type": "voice",
"status_code": "Sent",
"status_text": "Sent",
"subaccount_id": 1039,
"timestamp": "1461658202",
"timestamp_send": "1461658202"
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Get Specific Voice Receipt",
"tags": [
"Voice"
]
}
},
"/voice/send": {
"post": {
"description": "You can post **up to 1000 messages** with each API call.\n\nWe support some SSML tags allowing custom breaks or pauses to be entered, and the readout rate to be altered. [More info](https://help.clicksend.com/voice/how-to-adjust-tts-voice-calls).",
"operationId": "Send a Voice Call",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"custom_string": "this is a test",
"lang": "en-au",
"machine_detection": 1,
"require_input": 1,
"schedule": 1436874701,
"source": "php",
"to": "+61411111111",
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"custom_string": "this is a test",
"lang": "en-au",
"list_id": 428,
"schedule": 1436876011,
"source": "php",
"voice": "female"
}
]
},
"properties": {
"body": {
"description": "Your message.",
"type": "string"
},
"country": {
"description": "The country of the recipient.",
"type": "string"
},
"custom_string": {
"description": "Your reference. Will be passed back with all replies and delivery reports.",
"type": "string"
},
"lang": {
"description": "au (string, required) - See section on available languages.",
"type": "string"
},
"list_id": {
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'. Will override 'to' if both are used.",
"type": "number"
},
"machine_detection": {
"description": "Whether to attempt to detect an answering machine or voicemail service and leave a message (1 for on, 0 [default] for off)",
"type": "number"
},
"require_input": {
"description": "Whether you want to receive a keypress from the call recipient (1 for on, 0 [default] for off)",
"type": "number"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
},
"to": {
"description": "Recipient number in E.164 format or local format ([more info](https://help.clicksend.com/SMS/what-format-does-the-recipient-phone-number-need-to-be-in)).",
"type": "string"
},
"voice": {
"description": "Either 'female' or 'male'.",
"type": "string"
}
},
"required": [
"to",
"body",
"voice"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": {
"currency": {
"currency_name_long": "US Dollars",
"currency_name_short": "USD",
"currency_prefix_c": "¢",
"currency_prefix_d": "$"
},
"messages": [
{
"body": "Jelly liquorice marshmallow candy carrot cake 4Eyffjs1vL.",
"carrier": "Telstra",
"country": "AU",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "BF7AD270-0DE2-418B-B606-71D527D9C1AE",
"message_parts": 1,
"message_price": 0.07,
"require_input": 1,
"schedule": 1436874701,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+61411111111",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"carrier": "Telstra",
"country": "AU",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "D0C273EE-816D-4DF2-8E9D-9D9C65F168F3",
"message_parts": 1,
"message_price": 0.07,
"require_input": 0,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+61411111111",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"carrier": "",
"country": "US",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "A1845B61-C404-4793-8661-97890C19C8A2",
"message_parts": 1,
"message_price": 0.07,
"require_input": 0,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+16783270696",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
},
{
"body": "Chocolate bar icing icing oat cake carrot cake jelly cotton MWEvciEPIr.",
"carrier": "",
"country": "US",
"custom_string": "this is a test",
"date": 1436871253,
"from": null,
"lang": "en-au",
"machine_detection": 0,
"message_id": "DB545FAA-7325-465F-A696-8BDBFA8C1E49",
"message_parts": 1,
"message_price": 0.07,
"require_input": 0,
"schedule": 1436876011,
"status": "SUCCESS",
"subaccount_id": 1,
"to": "+16783275492",
"to_type": "mobile",
"user_id": 1,
"voice": "female"
}
],
"queued_count": 4,
"total_count": 4,
"total_price": 0.28
},
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here are your data."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"security": [
{
"basic": []
}
],
"summary": "Send a Voice Call",
"tags": [
"Voice"
]
}
},
"/voice/{message_id}/cancel": {
"put": {
"description": "",
"operationId": "Cancel a Specific Voice Call",
"parameters": [
{
"description": "Your voice message id.",
"example": "7B5BFC19 06B7 49C1 8DCDFB011600E12B",
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"data": [],
"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Voice have been cancelled."
}
}
}
}
},
"description": "OK",
"headers": {}
}
},
"summary": "Cancel a Specific Voice Call",
"tags": [
"Voice"
]
}
}
},
"components": {
"requestBodies": {
"Add_a_Test_Delivery_ReceiptBody": {
"content": {
"application/json": {
"schema": {
"example": {
"url": "http://yourdomain.com"
},
"properties": {
"url": {
"description": "Your URL if using the push option or 'poll' if using the pull option.",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
}
}
},
"Create_Email_CampaignBody": {
"content": {
"application/json": {
"schema": {
"example": {
"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
},
"properties": {
"from_email_address_id": {
"description": "The allowed email address id.",
"type": "number"
},
"from_name": {
"description": "The name that will appear on the email.",
"type": "string"
},
"list_id": {
"description": "The list id you want to access.",
"type": "number"
},
"name": {
"description": "The name of the sender.",
"type": "string"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"subject": {
"description": "The subject of the email campaign.",
"type": "string"
},
"template_id": {
"description": "The template id you want to use.",
"type": "number"
}
},
"required": [
"name",
"subject",
"from_email_address_id",
"from_name",
"template_id",
"list_id"
],
"type": "object"
}
}
}
},
"Create_Reseller_AccountBody": {
"content": {
"application/json": {
"schema": {
"example": {
"account_name": "The Awesome Company",
"country": "US",
"password": "pass",
"user_email": "johndoe2@awesome.com",
"user_first_name": "John",
"user_last_name": "Doe",
"user_phone": "518-481-1002",
"username": "johndoe2"
},
"properties": {
"account_name": {
"description": "Your delivery to value.",
"type": "string"
},
"country": {
"description": "Client country.",
"type": "string"
},
"password": {
"description": "Your password.",
"type": "string"
},
"user_email": {
"description": "Your email.",
"type": "string"
},
"user_first_name": {
"description": "Your first name.",
"type": "string"
},
"user_last_name": {
"description": "Your last name.",
"type": "string"
},
"user_phone": {
"description": "Your phone number in E.164 format.",
"type": "string"
},
"username": {
"description": "Your username.",
"type": "string"
}
},
"required": [
"username",
"password",
"user_email",
"user_phone",
"user_first_name",
"user_last_name",
"account_name",
"country"
],
"type": "object"
}
}
}
},
"Create_a_Post_Return_AddressBody": {
"content": {
"application/json": {
"schema": {
"example": {
"address_city": "Flynn",
"address_country": "AU",
"address_line_1": "Maritime Avenue",
"address_line_2": "",
"address_name": "John Smith",
"address_postal_code": 6302,
"address_state": "WA"
},
"properties": {
"address_city": {
"description": "Your address city.",
"type": "string"
},
"address_country": {
"description": "Two-letter country code defined in ISO 3166.",
"type": "string"
},
"address_line_1": {
"description": "Your address line 1.",
"type": "string"
},
"address_line_2": {
"description": "Your address line 2.",
"type": "string"
},
"address_name": {
"description": "Your address name.",
"type": "string"
},
"address_postal_code": {
"description": "Your address postal code.",
"type": "number"
},
"address_state": {
"description": "Your address state.",
"type": "string"
}
},
"required": [
"address_name",
"address_line_1",
"address_city",
"address_state",
"address_postal_code",
"address_country"
],
"type": "object"
}
}
}
},
"Create_a_new_ruleBody": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "EMAIL_FIXED",
"action_address": "email@domain.com",
"dedicated_number": "+61298441484",
"enabled": 1,
"rule_name": "Rule Name"
},
"properties": {
"action": {
"description": "Action",
"type": "string"
},
"action_address": {
"description": "Action Address",
"type": "string"
},
"dedicated_number": {
"description": "Decicated Number",
"type": "string"
},
"enabled": {
"description": "Enable",
"type": "number"
},
"rule_name": {
"description": "Rule Name",
"type": "string"
}
},
"required": [
"dedicated_number",
"rule_name",
"action",
"action_address",
"enabled"
],
"type": "object"
}
}
}
},
"Create_a_new_ruleBody2": {
"content": {
"application/json": {
"schema": {
"example": {
"action": "EMAIL_FIXED",
"action_address": "john@doe.com",
"enabled": 1,
"match_type": 3,
"rule_name": "My Rule"
},
"properties": {
"action": {
"description": "Action.",
"type": "string"
},
"action_address": {
"description": "Action Address.",
"type": "string"
},
"enabled": {
"description": "Enabled.",
"type": "number"
},
"match_type": {
"description": "Match Type. 0=All reports, 1=Only failed, 2=Only successful.",
"type": "number"
},
"rule_name": {
"description": "Rule Name.",
"type": "string"
}
},
"required": [
"rule_name",
"match_type",
"action",
"action_address",
"enabled"
],
"type": "object"
}
}
}
},
"Send_FaxBody": {
"content": {
"application/json": {
"schema": {
"example": {
"file_url": "https://s3-ap-southeast-2.amazonaws.com/clicksend-api-downloads/_public/_examples/document.pdf",
"messages": [
{
"country": "AF",
"custom_string": "custom_string",
"from_email": "will@smith.com",
"schedule": "1436874701",
"source": "php",
"to": "+61261111111"
},
{
"country": "AF",
"custom_string": "custom_string",
"from_email": "john@doe.com",
"schedule": "1436874701",
"source": "php",
"to": "+61261111122"
}
]
},
"properties": {
"country": {
"description": "Recipient country.",
"type": "string"
},
"custom_string": {
"description": "Your reference. Will be passed back with all replies and delivery reports.",
"type": "string"
},
"file_url": {
"description": "Your URL to your PDF file.",
"type": "string"
},
"from": {
"description": "Your sender id. Must be a valid fax number.",
"type": "string"
},
"from_email": {
"description": "An email address where the reply should be emailed to.",
"type": "string"
},
"list_id": {
"description": "Your list ID if sending to a whole list. Can be used instead of 'to'.",
"type": "number"
},
"messages": {
"description": "Your messages.",
"items": {},
"type": "array"
},
"schedule": {
"description": "Leave blank for immediate delivery. Your schedule time as a [unix timestamp](http://help.clicksend.com/what-is-a-unix-timestamp).",
"type": "number"
},
"source": {
"description": "Your method of sending e.g. 'wordpress', 'php', 'c#'.",
"type": "string"
},
"to": {
"description": "Recipient number in E.164 format or local format ([more info](https://help.clicksend.com/SMS/what-format-does-the-recipient-phone-number-need-to-be-in)).",
"type": "string"
}
},
"required": [
"file_url",
"messages",
"to"
],
"type": "object"
}
}
}
}
},
"schemas": {
"Acceptable_Import_Fields": {},
"Account_Activation": {},
"Account_Collection": {},
"Allowed_From_Email_Addresses": {},
"Buy_dedicated_number": {},
"CSV_Import_File_Preview": {},
"Calculate_Price": {},
"Calculate_Price_for_SMS_Campaign": {},
"Calculate_Pricing": {},
"Cancel_Scheduled_Messages": {},
"Cancel_Voice_Calls": {},
"Contact": {},
"Contact_Collection": {},
"Contact_List": {},
"Contact_List_Collection": {},
"Contact_Suggestions": {},
"Country_Collection": {},
"Create_SMS_Campaign": {},
"Credit_Card_Info": {},
"Delivery_Issues": {},
"Delivery_Receipts": {},
"Detect_Address": {},
"Direct_Mail_Campaign": {},
"Email-to-SMS_Allowed_Address": {},
"Email-to-SMS_Allowed_Address_-_Object": {},
"Email_Campaigns": {},
"Email_Delivery_Receipt_Rules": {},
"Existing_SMS_Campaigns": {},
"Export_Contacts": {},
"Export_Post_Letter_History": {},
"Export_Postcard_History": {},
"Fax_Delivery_Receipt_Rules": {},
"Fax_History": {},
"Forgot_Password": {},
"Forgot_Username": {},
"Get_Country_Pricing": {},
"Get_Post_Letter_History": {},
"Get_Postcard_History": {},
"Get_SMS_Statistics": {},
"Get_Voice_Statistics": {},
"Get_all_Dedicated_Numbers": {},
"Import_Contacts": {},
"Inbound_Fax_Rules": {},
"Inbound_MMS": {},
"Inbound_SMS": {},
"Inbound_SMS_Rules": {},
"MMS_History": {},
"Master_Template_Categories": {},
"Master_Templates": {},
"Post_Code_Search": {},
"Post_Return_Address": {},
"Referral_Accounts": {},
"Remove_Duplicate_Contacts": {},
"Remove_Opted_Out_Contacts": {},
"Reseller": {},
"Reseller_Account": {},
"Reseller_Accounts": {},
"Reseller_Subdomain": {},
"SDK_Download": {},
"SMS_Delivery_Receipt_Rules": {},
"SMS_History": {},
"Search_Contacts-Lists": {},
"Search_Dedicated_Numbers_by_Country": {},
"Send_Fax": {},
"Send_Post_Letter": {},
"Send_Postcard": {},
"Send_a_Voice_Call_-_Text-to-speech": {},
"Send_an_MMS": {},
"Send_an_SMS": {},
"Stripped_Strings": {},
"Subaccount": {},
"Subaccount_Collection": {},
"Templates": {},
"Timezones": {},
"Transactional_Email": {},
"Transfer_Contact": {},
"URL_Shortening": {},
"Upload_Image": {},
"Upload_a_File": {},
"User_Email_Templates": {},
"Verify_Forgot_Password": {},
"Voice_Delivery_Receipt_Rules": {},
"Voice_History": {},
"Voice_Languages": {}
},
"securitySchemes": {
"basic": {
"scheme": "basic",
"type": "http"
}
}
}
}