ClickSend REST API v3
  1. Post Letter
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
      GET
    • Export Post Letter History
      GET
    • Calculate Price
      POST
    • Send Post Letter
      POST
    • Get List of Post Return Addresses
      GET
    • Create a Post Return Address
      POST
    • Delete Post Return Address
      DELETE
    • Get Post Return Address
      GET
    • Update Post Return Address
      PUT
  • 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
  • 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. Post Letter

Calculate Price

POST
/post/letters/price
Post Letter
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://rest.clicksend.com/v3/post/letters/price' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
}'
Response Response Example
{
    "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."
}

Request

Body Params application/json
colour
number 
optional
Is it in colored?
duplex
number 
optional
Is it in duplex?
file_url
string 
required
Your URL to your PDF file.
priority_post
number 
optional
Is it priority? 0 = Not Priority, 1 = Priority.
recipients
array
optional
Your recipients.
template_used
number 
optional
Whether you used our template or not (More Info).
Examples

Responses

🟢200OK
application/json
Body
object {0}
Previous
Export Post Letter History
Next
Send Post Letter
Built with