openapi-directory/api/clicksend.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"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://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":{"respons