/clicksend-account | Type: Application | PCID required: Yes
Tools
clicksend_account_countries_get
Get all country codesclicksend_account_delivery_issues_get
Get all delivery issues Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_delivery_issues_post
Create delivery Issue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_comments | string | No | — | The user’s comments. |
description | string | Yes | — | The description of the message. |
email_address | string | Yes | — | The user’s email address. |
message_id | string | No | — | The message id of the message. |
type | string | Yes | — | The type of message, must be one of the following values SMS, MMS, VOICE, EMAIL_MARKETING, EMAIL_TRANSACTIONAL, FAX, POST. |
clicksend_account_detect_address_post
Detects address in uploaded file. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content | string | Yes | — | Your base64 encoded file string. |
clicksend_account_forgot_password_put
Forgot password Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
username | string | No | — | Username belonging to account. |
clicksend_account_forgot_password_verify_put
Verify forgot password Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
activation_token | string | Yes | — | Activation token |
password | string | Yes | — | The password value |
subaccount_id | integer | Yes | — | ID of subaccount |
clicksend_account_forgot_username_put
Forgot username Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Email belonging to account. |
phone_number | string | No | — | Phone number belonging to account. |
clicksend_account_get
Get account informationclicksend_account_numbers_buy_by_dedicated_number_post
Buy dedicated number Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dedicated_number | string | Yes | — | Phone number to purchase |
clicksend_account_numbers_get
Get all availible dedicated numbers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_numbers_search_by_country_get
Get all dedicated numbers by country Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country | string | Yes | — | Country code to search |
search | string | No | — | Your search pattern or query. |
search_type | integer | No | — | Your strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with. |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_post
Create a new account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_name | string | Yes | — | Your delivery to value. |
country | string | Yes | — | Your country |
password | string | Yes | — | Your password |
user_email | string | Yes | — | Your email |
user_first_name | string | Yes | — | Your first name |
user_last_name | string | Yes | — | Your last name |
user_phone | string | Yes | — | Your phone number in E.164 format. |
username | string | Yes | — | Your username |
clicksend_account_recharge_credit_card_get
Get Credit Card infoclicksend_account_recharge_credit_card_put
Update credit card info Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bank_name | string | Yes | — | Name of bank that credit card belongs to |
cvc | string | Yes | — | CVC number of credit card |
expiry_month | integer | Yes | — | Expiry month of credit card |
expiry_year | integer | Yes | — | Expiry year of credit card |
name | string | Yes | — | Name printed on credit card |
number | string | Yes | — | Credit card number |
clicksend_account_recharge_packages_get
Get list of all packages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country | string | No | — | Country code |
clicksend_account_recharge_purchase_by_package_id_put
Purchase a package Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
package_id | integer | Yes | — | ID of package to purchase |
clicksend_account_recharge_transactions_by_transaction_id_get
Get specific Transaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
transaction_id | string | Yes | — | ID of transaction to retrieve |
clicksend_account_recharge_transactions_get
Purchase a package Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_referral_accounts_get
Get all referral accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_reseller_accounts_by_client_user_id_get
Get Reseller clients Account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_user_id | integer | Yes | — | User ID of client |
clicksend_account_reseller_accounts_by_client_user_id_put
Update Reseller clients Account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
client_user_id | integer | Yes | — | User ID of client |
account_name | string | Yes | — | Account name (usually company name) |
country | string | Yes | — | Country of account holder |
password | string | Yes | — | Account password (unhashed) |
user_email | string | Yes | — | Account email |
user_first_name | string | Yes | — | Account owner first name |
user_last_name | string | Yes | — | Account owner last name |
user_phone | string | Yes | — | Account phone number |
username | string | Yes | — | Account username |
clicksend_account_reseller_accounts_get
Get list of reseller accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_reseller_accounts_post
Create reseller account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_name | string | Yes | — | Account name (usually company name) |
country | string | Yes | — | Country of account holder |
password | string | Yes | — | Account password (unhashed) |
user_email | string | Yes | — | Account email |
user_first_name | string | Yes | — | Account owner first name |
user_last_name | string | Yes | — | Account owner last name |
user_phone | string | Yes | — | Account phone number |
username | string | Yes | — | Account username |
clicksend_account_reseller_transfer_credit_put
Transfer Credit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
balance | integer | Yes | — | Balance to transfer |
client_user_id | integer | Yes | — | User ID of client |
currency | string | Yes | — | Currency of balance to transfer |
clicksend_account_search_contacts_lists_get
Get list of searched contact list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Your keyword or query. |
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_statistics_sms_get
Get sms statisticsclicksend_account_statistics_voice_get
Get voice statisticsclicksend_account_subaccounts_by_subaccount_id_delete
Delete a subaccount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subaccount_id | integer | Yes | — | ID of subaccount to delete |
clicksend_account_subaccounts_by_subaccount_id_get
Get specific subaccount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subaccount_id | integer | Yes | — | ID of subaccount to get |
clicksend_account_subaccounts_by_subaccount_id_put
Update subaccount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subaccount_id | integer | Yes | — | ID of subaccount to update |
access_billing | integer | No | — | Your access billing flag value, must be 1 or 0. |
access_contacts | integer | No | — | Your access contacts flag value, must be 1 or 0. |
access_reporting | integer | No | — | Your access reporting flag value, must be 1 or 0. |
access_settings | integer | No | — | Your access settings flag value, must be 1 or 0. |
access_users | integer | No | — | Your access users flag value, must be 1 or 0. |
api_username | string | Yes | — | Your new api username. |
email | string | Yes | — | Your new email. |
first_name | string | Yes | — | Your firstname |
last_name | string | Yes | — | Your lastname |
password | string | Yes | — | Your new password |
phone_number | string | Yes | — | Your phone number in E.164 format. |
clicksend_account_subaccounts_get
Get all subaccounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_subaccounts_post
Create new subaccount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access_billing | integer | No | — | Your access billing flag value, must be 1 or 0. |
access_contacts | integer | No | — | Your access contacts flag value, must be 1 or 0. |
access_reporting | integer | No | — | Your access reporting flag value, must be 1 or 0. |
access_settings | integer | No | — | Your access settings flag value, must be 1 or 0. |
access_users | integer | No | — | Your access users flag value, must be 1 or 0. |
api_username | string | Yes | — | Your new api username. |
email | string | Yes | — | Your new email. |
first_name | string | Yes | — | Your firstname |
last_name | string | Yes | — | Your lastname |
password | string | Yes | — | Your new password |
phone_number | string | Yes | — | Your phone number in E.164 format. |
clicksend_account_subaccounts_regen_api_key_by_subaccount_id_put
Regenerate an API Key Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
subaccount_id | integer | Yes | — | ID of subaccount to regenerate API key for |
clicksend_account_timezones_get
Get supported list of timezones. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
limit | integer | No | — | Number of records per page |
clicksend_account_uploads_post
Upload File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
convert | string | Yes | — | The convert value |
content | string | Yes | — | Your base64 encoded file string. |
clicksend_account_useage_by_subaccount_get
Get account useage by subaccount Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
year | integer | Yes | — | Year to filter by (yyyy) |
month | integer | Yes | — | Month to filter by (mm) |
clicksend_account_verify_send_put
Send account activation token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
country | string | Yes | — | Country code |
type | string | Yes | — | Type of verification |
user_phone | string | Yes | — | User’s phone number |
clicksend_account_verify_verify_by_activation_token_put
Verify new account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
activation_token | string | Yes | — | Activation Token |

