{ "info": { "_postman_id": "6ed7bccd-55bc-48c4-be33-02588a8a96f2", "name": "ClickSend v3 API", "description": "ClickSend v3 REST API - SMS, MMS, voice, email, and physical post. HTTP Basic auth (username + API key).", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{username}}", "type": "string" }, { "key": "password", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://rest.clicksend.com/v3" }, { "key": "username", "value": "" }, { "key": "apiKey", "value": "" } ], "item": [ { "name": "SMS", "item": [ { "name": "Send SMS messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sms/send", "host": [ "{{baseUrl}}" ], "path": [ "sms", "send" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Calculate SMS price", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sms/price", "host": [ "{{baseUrl}}" ], "path": [ "sms", "price" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get sent SMS history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sms/history", "host": [ "{{baseUrl}}" ], "path": [ "sms", "history" ] } }, "response": [] }, { "name": "Cancel a queued SMS", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/sms/{message_id}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "sms", "{message_id}", "cancel" ] } }, "response": [] }, { "name": "Get SMS templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sms/templates", "host": [ "{{baseUrl}}" ], "path": [ "sms", "templates" ] } }, "response": [] } ] }, { "name": "MMS", "item": [ { "name": "Send MMS messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mms/send", "host": [ "{{baseUrl}}" ], "path": [ "mms", "send" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Calculate MMS price", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/mms/price", "host": [ "{{baseUrl}}" ], "path": [ "mms", "price" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get sent MMS history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/mms/history", "host": [ "{{baseUrl}}" ], "path": [ "mms", "history" ] } }, "response": [] } ] }, { "name": "Voice", "item": [ { "name": "Send voice (TTS) messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/voice/send", "host": [ "{{baseUrl}}" ], "path": [ "voice", "send" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Calculate voice price", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/voice/price", "host": [ "{{baseUrl}}" ], "path": [ "voice", "price" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get supported voice languages", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/voice/lang", "host": [ "{{baseUrl}}" ], "path": [ "voice", "lang" ] } }, "response": [] }, { "name": "Cancel a queued voice message", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/voice/{message_id}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "voice", "{message_id}", "cancel" ] } }, "response": [] } ] }, { "name": "Email", "item": [ { "name": "Send a transactional email", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/email/send", "host": [ "{{baseUrl}}" ], "path": [ "email", "send" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Calculate email price", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/email/price", "host": [ "{{baseUrl}}" ], "path": [ "email", "price" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get sent email history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/email/history", "host": [ "{{baseUrl}}" ], "path": [ "email", "history" ] } }, "response": [] }, { "name": "Get verified from-addresses", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/email/addresses", "host": [ "{{baseUrl}}" ], "path": [ "email", "addresses" ] } }, "response": [] } ] }, { "name": "Post Letter", "item": [ { "name": "Print and mail letters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/post/letters/send", "host": [ "{{baseUrl}}" ], "path": [ "post", "letters", "send" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Calculate letter price", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/post/letters/price", "host": [ "{{baseUrl}}" ], "path": [ "post", "letters", "price" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get letter history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/post/letters/history", "host": [ "{{baseUrl}}" ], "path": [ "post", "letters", "history" ] } }, "response": [] }, { "name": "Detect address on a letter PDF", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/post/letters/detect-address", "host": [ "{{baseUrl}}" ], "path": [ "post", "letters", "detect-address" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Upload a media file (PDF/image)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/uploads", "host": [ "{{baseUrl}}" ], "path": [ "uploads" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Post Postcard", "item": [ { "name": "Print and mail postcards", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/post/postcards/send", "host": [ "{{baseUrl}}" ], "path": [ "post", "postcards", "send" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Calculate postcard price", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/post/postcards/price", "host": [ "{{baseUrl}}" ], "path": [ "post", "postcards", "price" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get postcard history", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/post/postcards/history", "host": [ "{{baseUrl}}" ], "path": [ "post", "postcards", "history" ] } }, "response": [] } ] }, { "name": "Contacts & Lists", "item": [ { "name": "Get contact lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/lists", "host": [ "{{baseUrl}}" ], "path": [ "lists" ] } }, "response": [] }, { "name": "Create a contact list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists", "host": [ "{{baseUrl}}" ], "path": [ "lists" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get contacts in a list", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/lists/{list_id}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "lists", "{list_id}", "contacts" ] } }, "response": [] }, { "name": "Create a contact in a list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/{list_id}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "lists", "{list_id}", "contacts" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Import contacts into a list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/{list_id}/import", "host": [ "{{baseUrl}}" ], "path": [ "lists", "{list_id}", "import" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search contacts and lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/search/contacts-lists", "host": [ "{{baseUrl}}" ], "path": [ "search", "contacts-lists" ] } }, "response": [] } ] }, { "name": "Delivery Receipts & Inbound", "item": [ { "name": "Get SMS delivery receipts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sms/receipts", "host": [ "{{baseUrl}}" ], "path": [ "sms", "receipts" ] } }, "response": [] }, { "name": "Mark SMS receipts as read", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/sms/receipts-read", "host": [ "{{baseUrl}}" ], "path": [ "sms", "receipts-read" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get inbound SMS", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/sms/inbound", "host": [ "{{baseUrl}}" ], "path": [ "sms", "inbound" ] } }, "response": [] }, { "name": "Get voice delivery receipts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/voice/receipts", "host": [ "{{baseUrl}}" ], "path": [ "voice", "receipts" ] } }, "response": [] }, { "name": "Get MMS delivery receipts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/mms/receipts", "host": [ "{{baseUrl}}" ], "path": [ "mms", "receipts" ] } }, "response": [] }, { "name": "Get inbound-SMS automations", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/automations/sms/inbound", "host": [ "{{baseUrl}}" ], "path": [ "automations", "sms", "inbound" ] } }, "response": [] }, { "name": "Create inbound-SMS automation (webhook)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/automations/sms/inbound", "host": [ "{{baseUrl}}" ], "path": [ "automations", "sms", "inbound" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get receipt automations", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/automations/sms/receipts", "host": [ "{{baseUrl}}" ], "path": [ "automations", "sms", "receipts" ] } }, "response": [] }, { "name": "Create receipt automation (webhook)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/automations/sms/receipts", "host": [ "{{baseUrl}}" ], "path": [ "automations", "sms", "receipts" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Account & Balance", "item": [ { "name": "Get account details and balance", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/account", "host": [ "{{baseUrl}}" ], "path": [ "account" ] } }, "response": [] }, { "name": "Get usage by subaccount", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/account/usage/{year}/{month}/subaccount", "host": [ "{{baseUrl}}" ], "path": [ "account", "usage", "{year}", "{month}", "subaccount" ] } }, "response": [] }, { "name": "Get subaccounts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/subaccounts", "host": [ "{{baseUrl}}" ], "path": [ "subaccounts" ] } }, "response": [] } ] } ] }