ClickSend

ClickSend is a cloud communications company providing a single REST API for business messaging across SMS, MMS, voice / text-to-speech, transactional email, and physical post - letters and postcards printed and mailed globally. The v3 API (rest.clicksend.com/v3) uses HTTP Basic authentication with a username and API key and covers sending, delivery receipts, inbound handling, contacts and lists, and account balance.

9 APIs 0 Features

CommunicationsSMSMMSVoiceEmailPostMessagingCPaaS

APIs

ClickSend SMS API

Send single or bulk SMS worldwide, price a message before sending, view outbound history, cancel queued messages, and manage reusable SMS templates via POST /sms/send, /sms/pric...

ClickSend MMS API

Send multimedia messages with an image or media file and subject line, price MMS, and pull MMS history via POST /mms/send, /mms/price and GET /mms/history. Media is referenced f...

ClickSend Voice / Text-to-Speech API

Place automated voice calls that read text aloud via text-to-speech in a chosen language and voice, price the call, list supported languages, and cancel calls via POST /voice/se...

ClickSend Transactional Email API

Send transactional email from verified sender addresses, price and view email history, and manage verified from-addresses via POST /email/send, /email/price, GET /email/history ...

ClickSend Post - Letters API

Print and physically mail letters worldwide from an uploaded PDF, price a letter, validate a delivery address, and view history via POST /post/letters/send, /post/letters/price,...

ClickSend Post - Postcards API

Print and mail postcards worldwide from an uploaded PDF design, price a postcard, and view postcard history via POST /post/postcards/send, /post/postcards/price and GET /post/po...

ClickSend Contacts & Lists API

Create and manage contact lists and the contacts within them, import contacts, remove duplicates, transfer and copy contacts between lists, and search across lists via /lists, /...

ClickSend Delivery Receipts & Inbound API

Retrieve delivery receipts and inbound messages for SMS, MMS, voice and email, mark receipts and inbound messages as read, and configure automation rules that forward receipts a...

ClickSend Account & Balance API

Retrieve account details including the current credit balance, view usage by month, manage subaccounts, and recharge account credit via GET /account, /account/usage/{year}/{mont...

Collections

ClickSend v3 API

OPEN

Pricing Plans

Clicksend Plans Pricing

3 plans

PLANS

Rate Limits

Clicksend Rate Limits

3 limits

RATE LIMITS

FinOps

Clicksend Finops

FINOPS

Resources

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: ClickSend v3 API
  version: '3.1'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{apiKey}}'
items:
- info:
    name: SMS
    type: folder
  items:
  - info:
      name: Send SMS messages
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/sms/send
      body:
        type: json
        data: '{}'
    docs: Send SMS messages
  - info:
      name: Calculate SMS price
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/sms/price
      body:
        type: json
        data: '{}'
    docs: Calculate SMS price
  - info:
      name: Get sent SMS history
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/sms/history
    docs: Get sent SMS history
  - info:
      name: Cancel a queued SMS
      type: http
    http:
      method: PUT
      url: https://rest.clicksend.com/v3/sms/{message_id}/cancel
    docs: Cancel a queued SMS
  - info:
      name: Get SMS templates
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/sms/templates
    docs: Get SMS templates
- info:
    name: MMS
    type: folder
  items:
  - info:
      name: Send MMS messages
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/mms/send
      body:
        type: json
        data: '{}'
    docs: Send MMS messages
  - info:
      name: Calculate MMS price
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/mms/price
      body:
        type: json
        data: '{}'
    docs: Calculate MMS price
  - info:
      name: Get sent MMS history
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/mms/history
    docs: Get sent MMS history
- info:
    name: Voice
    type: folder
  items:
  - info:
      name: Send voice (TTS) messages
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/voice/send
      body:
        type: json
        data: '{}'
    docs: Send voice (TTS) messages
  - info:
      name: Calculate voice price
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/voice/price
      body:
        type: json
        data: '{}'
    docs: Calculate voice price
  - info:
      name: Get supported voice languages
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/voice/lang
    docs: Get supported voice languages
  - info:
      name: Cancel a queued voice message
      type: http
    http:
      method: PUT
      url: https://rest.clicksend.com/v3/voice/{message_id}/cancel
    docs: Cancel a queued voice message
- info:
    name: Email
    type: folder
  items:
  - info:
      name: Send a transactional email
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/email/send
      body:
        type: json
        data: '{}'
    docs: Send a transactional email
  - info:
      name: Calculate email price
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/email/price
      body:
        type: json
        data: '{}'
    docs: Calculate email price
  - info:
      name: Get sent email history
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/email/history
    docs: Get sent email history
  - info:
      name: Get verified from-addresses
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/email/addresses
    docs: Get verified from-addresses
- info:
    name: Post Letter
    type: folder
  items:
  - info:
      name: Print and mail letters
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/post/letters/send
      body:
        type: json
        data: '{}'
    docs: Print and mail letters
  - info:
      name: Calculate letter price
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/post/letters/price
      body:
        type: json
        data: '{}'
    docs: Calculate letter price
  - info:
      name: Get letter history
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/post/letters/history
    docs: Get letter history
  - info:
      name: Detect address on a letter PDF
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/post/letters/detect-address
      body:
        type: json
        data: '{}'
    docs: Detect address on a letter PDF
  - info:
      name: Upload a media file (PDF/image)
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/uploads
      body:
        type: json
        data: '{}'
    docs: Upload a media file (PDF/image)
- info:
    name: Post Postcard
    type: folder
  items:
  - info:
      name: Print and mail postcards
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/post/postcards/send
      body:
        type: json
        data: '{}'
    docs: Print and mail postcards
  - info:
      name: Calculate postcard price
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/post/postcards/price
      body:
        type: json
        data: '{}'
    docs: Calculate postcard price
  - info:
      name: Get postcard history
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/post/postcards/history
    docs: Get postcard history
- info:
    name: Contacts & Lists
    type: folder
  items:
  - info:
      name: Get contact lists
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/lists
    docs: Get contact lists
  - info:
      name: Create a contact list
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/lists
      body:
        type: json
        data: '{}'
    docs: Create a contact list
  - info:
      name: Get contacts in a list
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/lists/{list_id}/contacts
    docs: Get contacts in a list
  - info:
      name: Create a contact in a list
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/lists/{list_id}/contacts
      body:
        type: json
        data: '{}'
    docs: Create a contact in a list
  - info:
      name: Import contacts into a list
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/lists/{list_id}/import
      body:
        type: json
        data: '{}'
    docs: Import contacts into a list
  - info:
      name: Search contacts and lists
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/search/contacts-lists
    docs: Search contacts and lists
- info:
    name: Delivery Receipts & Inbound
    type: folder
  items:
  - info:
      name: Get SMS delivery receipts
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/sms/receipts
    docs: Get SMS delivery receipts
  - info:
      name: Mark SMS receipts as read
      type: http
    http:
      method: PUT
      url: https://rest.clicksend.com/v3/sms/receipts-read
      body:
        type: json
        data: '{}'
    docs: Mark SMS receipts as read
  - info:
      name: Get inbound SMS
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/sms/inbound
    docs: Get inbound SMS
  - info:
      name: Get voice delivery receipts
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/voice/receipts
    docs: Get voice delivery receipts
  - info:
      name: Get MMS delivery receipts
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/mms/receipts
    docs: Get MMS delivery receipts
  - info:
      name: Get inbound-SMS automations
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/automations/sms/inbound
    docs: Get inbound-SMS automations
  - info:
      name: Create inbound-SMS automation (webhook)
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/automations/sms/inbound
      body:
        type: json
        data: '{}'
    docs: Create inbound-SMS automation (webhook)
  - info:
      name: Get receipt automations
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/automations/sms/receipts
    docs: Get receipt automations
  - info:
      name: Create receipt automation (webhook)
      type: http
    http:
      method: POST
      url: https://rest.clicksend.com/v3/automations/sms/receipts
      body:
        type: json
        data: '{}'
    docs: Create receipt automation (webhook)
- info:
    name: Account & Balance
    type: folder
  items:
  - info:
      name: Get account details and balance
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/account
    docs: Get account details and balance
  - info:
      name: Get usage by subaccount
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/account/usage/{year}/{month}/subaccount
    docs: Get usage by subaccount
  - info:
      name: Get subaccounts
      type: http
    http:
      method: GET
      url: https://rest.clicksend.com/v3/subaccounts
    docs: Get subaccounts