ClickSend

Delete a Rule via DELETE /automations/email/receipts/{rule_id}

Delete a rule via DELETE /automations/fax/inbound/{inbound_rule_id}

Delete a Rule via DELETE /automations/fax/receipts/{rule_id}

Delete a rule via DELETE /automations/sms/inbound/{inbound_rule_id}

Delete a rule via DELETE /automations/sms/receipts/{receipt_rule_id}

Delete a rule via DELETE /automations/voice/receipts/{receipt_rule_id}

Delete Allowed Email Address via DELETE /email/addresses/{email_address_id}

Delete Email Template via DELETE /email/templates/{template_id}

Delete a specific contact list via DELETE /lists/{list_id}

Delete a specific contact via DELETE /lists/{list_id}/contacts/{contact_id}

Delete Post Return Address via DELETE /post/return-addresses/{return_address_id}

Delete Email-to-SMS Allowed Address via DELETE /sms/email-sms/{email_address_id}. Delete a specific allowed email address.

Delete Stripped String via DELETE /sms/email-sms-stripped-strings/{rule_id}

Delete a Template via DELETE /sms/templates/{template_id}

Delete a specific subaccount via DELETE /subaccounts/{subaccount_id}

Get account via GET /account

Account Usage via GET /account/usage/{year}/{month}/{type}

List Rules via GET /automations/email/receipts

Get a Specific Rule via GET /automations/email/receipts/{rule_id}

List rules via GET /automations/fax/inbound

Get a specific rule via GET /automations/fax/inbound/{inbound_rule_id}

List Rules via GET /automations/fax/receipts

Get a Specific Rule via GET /automations/fax/receipts/{rule_id}

List rules via GET /automations/sms/inbound

Get a specific rule via GET /automations/sms/inbound/{inbound_rule_id}

List rules via GET /automations/sms/receipts

Get a specific rule via GET /automations/sms/receipts/{receipt_rule_id}

List rules via GET /automations/voice/receipts

Get a specific rule via GET /automations/voice/receipts/{receipt_rule_id}

List Contact Suggestions via GET /contact-suggestions

Get all Countries via GET /countries

Get Delivery Issues via GET /delivery-issues

Get All Allowed Email Addresses via GET /email/addresses

Get Specific Allowed Email Address via GET /email/addresses/{email_address_id}

Get All Email Campaigns via GET /email-campaigns

Get Specific Email Campaign History via GET /email-campaigns/{campaign_id}/history

Get Specific Email Campaign via GET /email-campaigns/{email_campaign_id}

Email History via GET /email/history

Export History via GET /email/history/export

Get All Master Email Templates via GET /email/master-templates

Get Specific Master Template via GET /email/master-templates/{template_id}

Get All Master Template Categories via GET /email/master-templates-categories

Get Specific Email Template Category via GET /email/master-templates-categories/{category_id}

Get All Templates For Category via GET /email/master-templates-categories/{category_id}/master-templates

Get All Email Templates via GET /email/templates

Get Specific Email Template via GET /email/templates/{template_id}

Get Fax History via GET /fax/history. Get a list of Fax History.

Export Fax History via GET /fax/history/export

List of Fax Delivery Receipts via GET /fax/receipts

Get a Specific Fax Delivery Receipt via GET /fax/receipts/{message_id}

Get all Contact Lists via GET /lists

Get a specific contact list via GET /lists/{list_id}

Get all Contacts in a List via GET /lists/{list_id}/contacts

Get a specific contact via GET /lists/{list_id}/contacts/{contact_id}

Export Contacts List via GET /lists/{list_id}/export

Get List of Acceptable Import Fields via GET /lists/{list_id}/import-fields

Export MMS History via GET /mms/history/export

Get MMS History via GET /mms/history

Get all Delivery Receipts via GET /mms/receipts

Get Delivery Receipt via GET /mms/receipts/{message_id}

Get all Dedicated Numbers via GET /numbers

Search Dedicated Numbers by Country via GET /numbers/search/{country}

List Direct Mail Campaigns via GET /post/direct-mail/campaigns. Get list of direct mail campaigns.

Search Locations via GET /post/direct-mail/locations/search/{country}

Get Post Letter History via GET /post/letters/history

Export Post Letter History via GET /post/letters/history/export

Export Postcard History via GET /post/postcards/history/export

Get Postcard History via GET /post/postcards/history

Get List of Post Return Addresses via GET /post/return-addresses

Get Post Return Address via GET /post/return-addresses/{return_address_id}

Get Country Pricing via GET /pricing/{country}

Get Credit Card info via GET /recharge/credit-card

List of Packages via GET /recharge/packages

Get Transactions via GET /recharge/transactions

Get a specific transaction via GET /recharge/transactions/{transaction_id}

Get List of Referral Accounts via GET /referral/accounts

Get Reseller Setting via GET /reseller. Get reseller setting.

List of Reseller Accounts via GET /reseller/accounts. Get list of Reseller Accounts

Get Reseller Account via GET /reseller/accounts/{client_user_id}. Get a specific reseller account.

Reseller By Subdomain via GET /reseller/{subdomain}. Get reseller setting by subdomin.

SDK Download via GET /sdk-download/{type}

Search Contacts-Lists via GET /search/contacts-lists

Get list of SMS Campaigns via GET /sms-campaigns

Link Tracking Export via GET /sms-campaigns/{campaign_id}/link-export. Compile all link tracking for the specified campaign into a CSV for download.

Link Statistics via GET /sms-campaigns/{campaign_id}/link-statistics. Get the breakdown of statistics for your campaign. Note that the returned values vary depending on your specific customers' interaction, so it's not safe to assume a value will always be specified.

Link Tracking via GET /sms-campaigns/{campaign_id}/link-tracking. This endpoint gives you a paginated overview of all the links in a particular campaign, and who has and hasn't visited them.

Get SMS Campaign via GET /sms-campaigns/{sms_campaign_id}

List of Email-to-SMS Allowed Address via GET /sms/email-sms. Get list of allowed email addresses.

Get specific Email-to-SMS Allowed Address via GET /sms/email-sms/{email_address_id}. Get a specific allowed email address.

List Stripped Strings via GET /sms/email-sms-stripped-strings

Find Specific Stripped String via GET /sms/email-sms-stripped-strings/{rule_id}

Get all History via GET /sms/history. **SMS Delivery Status** **Status (status field)** | Status | Description | |---|---|---| | `Completed` | Added to delivery queue. Waiting to be sent to the network.| | `Sent` | Message sent to the network.| | `Cancelled` | Message cancelled.| | `Scheduled` | Message scheduled.| | `WaitApproval` | Waiting approval by our team. This is temporary and will change to 'Sent' once approved. This only happens for a few messages that are flagged for approval by our automated spam-detection system.| **Status Codes (status_code field)** | Code | Text | Description | |---|---|---| | `200` | Sent by network| Temporary success| | `201` | Received on handset| Permanent success| | `300` | Delivery failure| Permanent failure| | `301` | Delivery failure| Permanent failure| | `302` | Delivery failure| Temporary failure - supplier routing issue|

Export SMS History via GET /sms/history/export

Get all Inbound SMS - Pull via GET /sms/inbound

Get Specific Inbound - Pull via GET /sms/inbound/{outbound_message_id}

Get all Delivery Receipts via GET /sms/receipts

Get a Specific Delivery Receipt via GET /sms/receipts/{message_id}

List of Templates via GET /sms/templates. Get list of templates.

Get SMS Statistics via GET /statistics/sms

Get Voice Statistics via GET /statistics/voice

Get all Subaccounts via GET /subaccounts

Get a specific subaccount via GET /subaccounts/{subaccount_id}

Get Timezones via GET /timezones. Get supported list of timezones.

Get Voice History via GET /voice/history

Export Voice History via GET /voice/history/export

Voice Languages via GET /voice/lang

Get Voice receipts via GET /voice/receipts

Get Specific Voice Receipt via GET /voice/receipts/{message_id}

Create a new account via POST /account. **Note:** *Authentication isn't required to create a new account.*

Create a New Rule via POST /automations/email/receipts

Create a new rule via POST /automations/fax/inbound

Create a New Rule via POST /automations/fax/receipts

Create a new rule via POST /automations/sms/inbound

Create a new rule via POST /automations/sms/receipts

Create a new rule via POST /automations/voice/receipts

Create Delivery Issue via POST /delivery-issues

Create Allowed Email Address via POST /email/addresses

Calculate Price via POST /email-campaigns/price

Create Email Campaign via POST /email-campaigns/send

Email Price via POST /email/price

Add a Test Delivery Receipt via POST /email/receipts

Email Send via POST /email/send

Create New Email Template from Master Template via POST /email/templates

Upload Image to Specific Template via POST /email/templates-images/{template_id}

Calculate Price via POST /fax/price

Add a Test Delivery Receipt via POST /fax/receipts

Send Fax via POST /fax/send. **Letter File Options** **Use existing URL** With this option, you can use an existing URL to a PDF document. For example, you might generate the pdf on your server. **Upload File to Our Server** With this option, you can use the `/uploads` endpoint to upload the document. The `/uploads` endpoint returns a URL that can be used in the `/fax/send` endpoint.

Create a new contact list via POST /lists

Create a new contact via POST /lists/{list_id}/contacts. Note that the fields `phone_number`, `fax_number` and email` are all optional; however at least one of them must be specified, otherwise the API call will fail.

Import Contacts to List via POST /lists/{list_id}/import

Show CSV Import File Preview via POST /lists/{list_id}/import-csv-preview. Show first row of the csv import file.

Get Price via POST /mms/price

Send MMS via POST /mms/send

Buy dedicated number via POST /numbers/buy/{dedicated_number}

Calculate Direct Mail Campaign Price via POST /post/direct-mail/campaigns/price. Calculate direct mail campaign price.

Create New Campaign via POST /post/direct-mail/campaigns/send. Create new direct mail campaign.

Detect Address via POST /post/letters/detect-address. The `detect-address` endpoint accepts either a letter in PDF format or an address string and attempts to convert it to a standard address format. Note that the PDF should be in standard address format, having the recipient's name and address listed at the top. The endpoint accepts two types of data: 1. A PDF file in `base64` encoding. In this case, submit the `base64`-encoded PDF file contents in the `content` field of the request body. 2. An address string. In this case, submit the address in a string using the `address` field of the request body.

Calculate Price via POST /post/letters/price

Send Post Letter via POST /post/letters/send. **Supported File Types** We support `pdf`, `docx` and `doc` files. Contact us to add support for any other file type. If you're using `docx` or `doc` files, you'll need to convert the file first using our uploads endpoint with the querystring parameter `convert=post` e.g. `POST /uploads?convert=post`. This will return a URL to the converted pdf file that can be used in the `/post/letters/send` endpoint. **Letter File Options** **Use existing URL** With this option, you can use an existing URL to a `pdf` document. For example, you might generate the `pdf` on your server. **Upload File to Our Server** With this option, you can use the `/uploads` endpoint to upload the document. The `/uploads` endpoint returns a URL that can be used in the `/post/letters/send` endpoint.

Calculate Pricing via POST /post/postcards/price. For `file_urls` field. You can attach at least 1 and max of 2 PDF file urls. - Supply a single pdf with 2 pages (front and back) - Supply 2 urls to seperate PDFs

Send Postcard via POST /post/postcards/send. **Supported File Types** We support PDF, docx and doc. Contact us to add support for any other file type. If you're using docx or doc files, you'll need to convert the file first using our uploads endpoint with the querystring parameter ?convert=post. e.g. POST /uploads?convert=post. This will return a URL to the converted pdf file that can be used in the /post/postcards/send endpoint. **Postcard File Options** **Use existing URL** With this option, you can use an existing URL to a PDF document. For example, you might generate the pdf on your server. For `file_urls` field. You can attach at least 1 and max of 2 PDF file urls. - Supply a single pdf with 2 pages (front and back) - Supply 2 urls to seperate PDFs **Upload File to Our Server** With this option, you can use the `/uploads` endpoint to upload the document. The `/uploads` endpoint returns a URL that can be used in the `/post/postcards/send` endpoint.

Create a Post Return Address via POST /post/return-addresses

Create Reseller Account via POST /reseller/accounts

Create Reseller Account - Public via POST /reseller/accounts-public

Calculate Price for SMS Campaign via POST /sms-campaigns/price

Use Short URL via POST /sms-campaigns/send. This is functionally identical to the **POST /sms-campaigns/send** endpoint, other than adding the `smsg.us/xxxxx` string to the message body additional `url_to_shorten` parameter.

Create Email to SMS Allowed Address via POST /sms/email-sms. Create an allowed email address.

Create Stripped String via POST /sms/email-sms-stripped-strings

Add a Test Inbound SMS via POST /sms/inbound

Calculate Price via POST /sms/price

Add a Test Delivery Receipt via POST /sms/receipts

Send an SMS via POST /sms/send. You can post **up to 1000 messages** with each API call.

Create a Template via POST /sms/templates. Create new template.

Create a new subaccount via POST /subaccounts

Upload a file via POST /uploads

Calculate Price via POST /voice/price

Add a Test Delivery Receipt via POST /voice/receipts

Send a Voice Call via POST /voice/send. You can post **up to 1000 messages** with each API call. We support some SSML tags allowing custom breaks or pauses to be entered, and the readout rate to be altered. [More info](https://help.clicksend.com/voice/how-to-adjust-tts-voice-calls).

Update Account via PUT /account

Send account activation token via PUT /account-verify/send

Verify new account via PUT /account-verify/verify/{activation_token}

Update a Rule via PUT /automations/email/receipts/{rule_id}

Update a rule via PUT /automations/fax/inbound/{inbound_rule_id}

Update a Rule via PUT /automations/fax/receipts/{rule_id}

Update a rule via PUT /automations/sms/inbound/{inbound_rule_id}

Update a rule via PUT /automations/sms/receipts/{receipt_rule_id}

Update a rule via PUT /automations/voice/receipts/{receipt_rule_id}

Send Verification Token via PUT /email/address-verify/{email_address_id}/send

Verify Allowed Email Address via PUT /email/address-verify/{email_address_id}/verify/{activation_token}

Update Email Campaign via PUT /email-campaigns/{email_campaign_id}

Cancel Email Campaign via PUT /email-campaigns/{email_campaign_id}/cancel

Update an Email Template via PUT /email/templates/{template_id}

Mark Fax Delivery Receipts as read via PUT /fax/receipts-read

Forgot Password via PUT /forgot-password

Verify Forgot Password via PUT /forgot-password/verify

Forgot Username via PUT /forgot-username

Transfer a Contact via PUT /lists/{from_list_id}/contacts/{contact_id}/{to_list_id}. Transfers a specific contact to another list.

Update a specific contact list via PUT /lists/{list_id}

Update a specific contact via PUT /lists/{list_id}/contacts/{contact_id}

Remove Duplicate Contacts via PUT /lists/{list_id}/remove-duplicates

Remove Opted Out Contacts via PUT /lists/{list_id}/remove-opted-out-contacts/{opt_out_list_id}

Cancel MMS via PUT /mms/{message_id}/cancel

Cancel All MMS via PUT /mms/cancel-all

Mark Receipts As Read via PUT /mms/receipts-read

Update Post Return Address via PUT /post/return-addresses/{return_address_id}

Update Credit Card info via PUT /recharge/credit-card

Purchase a Package via PUT /recharge/purchase/{package_id}

Update Reseller Setting via PUT /reseller. Update a specific reseller setting.

Update Reseller Account via PUT /reseller/accounts/{client_user_id}

Transfer Credit via PUT /reseller/transfer-credit

Cancel a Scheduled Message via PUT /sms/{message_id}/cancel

Update an SMS Campaign via PUT /sms-campaigns/{sms_campaign_id}

Cancel an SMS Campaign via PUT /sms-campaigns/{sms_campaign_id}/cancel

Cancel all Scheduled Messages via PUT /sms/cancel-all

Update Email-to-SMS Allowed Address via PUT /sms/email-sms/{email_address_id}. Update a specific allowed email address.

Update Stripped String via PUT /sms/email-sms-stripped-strings/{rule_id}

Mark all Inbound SMS as read via PUT /sms/inbound-read

Mark a specific Inbound SMS as read via PUT /sms/inbound-read/{message_id}

Mark Delivery Receipts as read via PUT /sms/receipts-read

Update a Template via PUT /sms/templates/{template_id}

Update a specific subaccount via PUT /subaccounts/{subaccount_id}

Regenerate API Key via PUT /subaccounts/{subaccount_id}/regen-api-key

Cancel a Specific Voice Call via PUT /voice/{message_id}/cancel

Cancel all Voice Calls via PUT /voice/cancel-all

Marked Voice Receipts as Read via PUT /voice/receipts-read