ClickSend REST API v3
  1. Uploads
ClickSend REST API v3
  • Account
    • Get account
      GET
    • Create a new account
      POST
    • Update Account
      PUT
    • Send account activation token
      PUT
    • Verify new account
      PUT
    • Account Usage
      GET
  • Automation Rules
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
  • Contact Suggestions
    • List Contact Suggestions
  • Countries
    • Get all Countries
  • Delivery Issues
    • Get Delivery Issues
    • Create Delivery Issue
  • Email Marketing
    • Get All Email Campaigns
    • Calculate Price
    • Create Email Campaign
    • Get Specific Email Campaign History
    • Get Specific Email Campaign
    • Update Email Campaign
    • Cancel Email Campaign
    • Send Verification Token
    • Verify Allowed Email Address
    • Get All Allowed Email Addresses
    • Create Allowed Email Address
    • Delete Allowed Email Address
    • Get Specific Allowed Email Address
    • Get All Master Email Templates
    • Get All Master Template Categories
    • Get Specific Email Template Category
    • Get All Templates For Category
    • Get Specific Master Template
    • Get All Email Templates
    • Create New Email Template from Master Template
    • Upload Image to Specific Template
    • Delete Email Template
    • Get Specific Email Template
    • Update an Email Template
  • Transactional Email
    • Email History
    • Export History
    • Email Price
    • Add a Test Delivery Receipt
    • Email Send
  • Fax
    • Export Fax History
    • Get Fax History
    • Calculate Price
    • List of Fax Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Fax Delivery Receipts as read
    • Get a Specific Fax Delivery Receipt
    • Send Fax
  • Forgot Account
    • Forgot Password
    • Verify Forgot Password
    • Forgot Username
  • Contact Lists
    • Get all Contact Lists
    • Create a new contact list
    • Delete a specific contact list
    • Get a specific contact list
    • Update a specific contact list
    • Export Contacts List
    • Import Contacts to List
    • Show CSV Import File Preview
    • Get List of Acceptable Import Fields
    • Remove Duplicate Contacts
  • Contacts
    • Transfer a Contact
    • Get all Contacts in a List
    • Create a new contact
    • Delete a specific contact
    • Get a specific contact
    • Update a specific contact
    • Remove Opted Out Contacts
  • MMS
    • Cancel All MMS
    • Export MMS History
    • Get MMS History
    • Get Price
    • Get all Delivery Receipts
    • Mark Receipts As Read
    • Get Delivery Receipt
    • Send MMS
    • Cancel MMS
  • Numbers
    • Get all Dedicated Numbers
    • Buy dedicated number
    • Search Dedicated Numbers by Country
  • Post Direct Mail
    • List Direct Mail Campaigns
    • Calculate Direct Mail Campaign Price
    • Create New Campaign
    • Search Locations
  • Post Address Detection
    • Detect Address
  • Post Letter
    • Get Post Letter History
    • Export Post Letter History
    • Calculate Price
    • Send Post Letter
    • Get List of Post Return Addresses
    • Create a Post Return Address
    • Delete Post Return Address
    • Get Post Return Address
    • Update Post Return Address
  • Postcards
    • Export Postcard History
    • Get Postcard History
    • Calculate Pricing
    • Send Postcard
  • Pricing
    • Get Country Pricing
  • Account Recharge
    • Get Credit Card info
    • Update Credit Card info
    • List of Packages
    • Purchase a Package
    • Get Transactions
    • Get a specific transaction
  • Referral Accounts
    • Get List of Referral Accounts
  • Reseller
    • Get Reseller Setting
    • Update Reseller Setting
    • Reseller By Subdomain
  • Reseller Accounts
    • List of Reseller Accounts
    • Create Reseller Account
    • Create Reseller Account - Public
    • Get Reseller Account
    • Update Reseller Account
    • Transfer Credit
  • SDK
    • SDK Download
  • Search
    • Search Contacts-Lists
  • SMS Campaigns
    • Get list of SMS Campaigns
    • Calculate Price for SMS Campaign
    • Use Short URL
    • Link Tracking Export
    • Link Statistics
    • Link Tracking
    • Get SMS Campaign
    • Update an SMS Campaign
    • Cancel an SMS Campaign
  • SMS
    • Cancel all Scheduled Messages
    • Export SMS History
    • Get all History
    • Get all Inbound SMS - Pull
    • Add a Test Inbound SMS
    • Mark all Inbound SMS as read
    • Mark a specific Inbound SMS as read
    • Get Specific Inbound - Pull
    • Calculate Price
    • Get all Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Delivery Receipts as read
    • Get a Specific Delivery Receipt
    • Send an SMS
    • Cancel a Scheduled Message
  • Email-to-SMS Allowed Address
    • List of Email-to-SMS Allowed Address
    • Create Email to SMS Allowed Address
    • Delete Email-to-SMS Allowed Address
    • Get specific Email-to-SMS Allowed Address
    • Update Email-to-SMS Allowed Address
  • Email-to-SMS Stripped Strings
    • List Stripped Strings
    • Create Stripped String
    • Delete Stripped String
    • Find Specific Stripped String
    • Update Stripped String
  • SMS Templates
    • List of Templates
    • Create a Template
    • Delete a Template
    • Update a Template
  • Statistics
    • Get SMS Statistics
    • Get Voice Statistics
  • Subaccounts
    • Get all Subaccounts
    • Create a new subaccount
    • Delete a specific subaccount
    • Get a specific subaccount
    • Update a specific subaccount
    • Regenerate API Key
  • Timezones
    • Get Timezones
  • Uploads
    • Upload a file
      POST
  • Voice
    • Cancel all Voice Calls
    • Export Voice History
    • Get Voice History
    • Voice Languages
    • Calculate Price
    • Get Voice receipts
    • Add a Test Delivery Receipt
    • Marked Voice Receipts as Read
    • Get Specific Voice Receipt
    • Send a Voice Call
    • Cancel a Specific Voice Call
  1. Uploads

Upload a file

POST
/uploads
Uploads
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://rest.clicksend.com/v3/uploads?convert={convert}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": "PGh0bWw+PGhlYWQ+PHN0eWxlIHR5cGU9InRleHQvY3NzIj5ib2R5IHsgZm9udC1mYW1pbHk6J0FyaWFsJzsgfTwvc3R5bGU+PHRpdGxlPkhpPC90aXRsZT48L2hlYWQ+PGJvZHk+PGgxPkhlbGxvIHRoZXJlPC9oMT48aDI+SG93IGFyZSB5b3UgdG9kYXk/PC9oMj48L2JvZHk+PC9odG1sPg=="
}'
Response Response Example
{
    "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."
}

Request

Query Params
convert
string 
required
Example:
{convert}
Body Params application/json
optional
Any of
Example:
{"content":"PGh0bWw+PGhlYWQ+PHN0eWxlIHR5cGU9InRleHQvY3NzIj5ib2R5IHsgZm9udC1mYW1pbHk6J0FyaWFsJzsgfTwvc3R5bGU+PHRpdGxlPkhpPC90aXRsZT48L2hlYWQ+PGJvZHk+PGgxPkhlbGxvIHRoZXJlPC9oMT48aDI+SG93IGFyZSB5b3UgdG9kYXk/PC9oMj48L2JvZHk+PC9odG1sPg=="}
content
string 
required
Your file contents encoded in base64.
convert
string 
required
Conversion type: fax, mms, csv or post
Examples

Responses

🟢200OK
application/json
Body
object {0}
Previous
Get Timezones
Next
Cancel all Voice Calls
Built with