Skip to main content
Server path: /clicksend-account | Type: Application | PCID required: Yes

Tools

ToolDescription
clicksend_account_countries_getGet all country codes
clicksend_account_delivery_issues_getGet all delivery issues
clicksend_account_delivery_issues_postCreate delivery Issue
clicksend_account_detect_address_postDetects address in uploaded file.
clicksend_account_forgot_password_putForgot password
clicksend_account_forgot_password_verify_putVerify forgot password
clicksend_account_forgot_username_putForgot username
clicksend_account_getGet account information
clicksend_account_numbers_buy_by_dedicated_number_postBuy dedicated number
clicksend_account_numbers_getGet all availible dedicated numbers
clicksend_account_numbers_search_by_country_getGet all dedicated numbers by country
clicksend_account_postCreate a new account
clicksend_account_recharge_credit_card_getGet Credit Card info
clicksend_account_recharge_credit_card_putUpdate credit card info
clicksend_account_recharge_packages_getGet list of all packages
clicksend_account_recharge_purchase_by_package_id_putPurchase a package
clicksend_account_recharge_transactions_by_transaction_id_getGet specific Transaction
clicksend_account_recharge_transactions_getPurchase a package
clicksend_account_referral_accounts_getGet all referral accounts
clicksend_account_reseller_accounts_by_client_user_id_getGet Reseller clients Account
clicksend_account_reseller_accounts_by_client_user_id_putUpdate Reseller clients Account
clicksend_account_reseller_accounts_getGet list of reseller accounts
clicksend_account_reseller_accounts_postCreate reseller account
clicksend_account_reseller_transfer_credit_putTransfer Credit
clicksend_account_search_contacts_lists_getGet list of searched contact list
clicksend_account_statistics_sms_getGet sms statistics
clicksend_account_statistics_voice_getGet voice statistics
clicksend_account_subaccounts_by_subaccount_id_deleteDelete a subaccount
clicksend_account_subaccounts_by_subaccount_id_getGet specific subaccount
clicksend_account_subaccounts_by_subaccount_id_putUpdate subaccount
clicksend_account_subaccounts_getGet all subaccounts
clicksend_account_subaccounts_postCreate new subaccount
clicksend_account_subaccounts_regen_api_key_by_subaccount_id_putRegenerate an API Key
clicksend_account_timezones_getGet supported list of timezones.
clicksend_account_uploads_postUpload File
clicksend_account_useage_by_subaccount_getGet account useage by subaccount
clicksend_account_verify_send_putSend account activation token
clicksend_account_verify_verify_by_activation_token_putVerify new account

clicksend_account_countries_get

Get all country codes

clicksend_account_delivery_issues_get

Get all delivery issues Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_delivery_issues_post

Create delivery Issue Parameters:
ParameterTypeRequiredDefaultDescription
client_commentsstringNoThe user’s comments.
descriptionstringYesThe description of the message.
email_addressstringYesThe user’s email address.
message_idstringNoThe message id of the message.
typestringYesThe 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:
ParameterTypeRequiredDefaultDescription
contentstringYesYour base64 encoded file string.

clicksend_account_forgot_password_put

Forgot password Parameters:
ParameterTypeRequiredDefaultDescription
usernamestringNoUsername belonging to account.

clicksend_account_forgot_password_verify_put

Verify forgot password Parameters:
ParameterTypeRequiredDefaultDescription
activation_tokenstringYesActivation token
passwordstringYesThe password value
subaccount_idintegerYesID of subaccount

clicksend_account_forgot_username_put

Forgot username Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoEmail belonging to account.
phone_numberstringNoPhone number belonging to account.

clicksend_account_get

Get account information

clicksend_account_numbers_buy_by_dedicated_number_post

Buy dedicated number Parameters:
ParameterTypeRequiredDefaultDescription
dedicated_numberstringYesPhone number to purchase

clicksend_account_numbers_get

Get all availible dedicated numbers Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_numbers_search_by_country_get

Get all dedicated numbers by country Parameters:
ParameterTypeRequiredDefaultDescription
countrystringYesCountry code to search
searchstringNoYour search pattern or query.
search_typeintegerNoYour strategy for searching, 0 = starts with, 1 = anywhere, 2 = ends with.
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_post

Create a new account Parameters:
ParameterTypeRequiredDefaultDescription
account_namestringYesYour delivery to value.
countrystringYesYour country
passwordstringYesYour password
user_emailstringYesYour email
user_first_namestringYesYour first name
user_last_namestringYesYour last name
user_phonestringYesYour phone number in E.164 format.
usernamestringYesYour username

clicksend_account_recharge_credit_card_get

Get Credit Card info

clicksend_account_recharge_credit_card_put

Update credit card info Parameters:
ParameterTypeRequiredDefaultDescription
bank_namestringYesName of bank that credit card belongs to
cvcstringYesCVC number of credit card
expiry_monthintegerYesExpiry month of credit card
expiry_yearintegerYesExpiry year of credit card
namestringYesName printed on credit card
numberstringYesCredit card number

clicksend_account_recharge_packages_get

Get list of all packages Parameters:
ParameterTypeRequiredDefaultDescription
countrystringNoCountry code

clicksend_account_recharge_purchase_by_package_id_put

Purchase a package Parameters:
ParameterTypeRequiredDefaultDescription
package_idintegerYesID of package to purchase

clicksend_account_recharge_transactions_by_transaction_id_get

Get specific Transaction Parameters:
ParameterTypeRequiredDefaultDescription
transaction_idstringYesID of transaction to retrieve

clicksend_account_recharge_transactions_get

Purchase a package Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_referral_accounts_get

Get all referral accounts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_reseller_accounts_by_client_user_id_get

Get Reseller clients Account Parameters:
ParameterTypeRequiredDefaultDescription
client_user_idintegerYesUser ID of client

clicksend_account_reseller_accounts_by_client_user_id_put

Update Reseller clients Account Parameters:
ParameterTypeRequiredDefaultDescription
client_user_idintegerYesUser ID of client
account_namestringYesAccount name (usually company name)
countrystringYesCountry of account holder
passwordstringYesAccount password (unhashed)
user_emailstringYesAccount email
user_first_namestringYesAccount owner first name
user_last_namestringYesAccount owner last name
user_phonestringYesAccount phone number
usernamestringYesAccount username

clicksend_account_reseller_accounts_get

Get list of reseller accounts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_reseller_accounts_post

Create reseller account Parameters:
ParameterTypeRequiredDefaultDescription
account_namestringYesAccount name (usually company name)
countrystringYesCountry of account holder
passwordstringYesAccount password (unhashed)
user_emailstringYesAccount email
user_first_namestringYesAccount owner first name
user_last_namestringYesAccount owner last name
user_phonestringYesAccount phone number
usernamestringYesAccount username

clicksend_account_reseller_transfer_credit_put

Transfer Credit Parameters:
ParameterTypeRequiredDefaultDescription
balanceintegerYesBalance to transfer
client_user_idintegerYesUser ID of client
currencystringYesCurrency of balance to transfer

clicksend_account_search_contacts_lists_get

Get list of searched contact list Parameters:
ParameterTypeRequiredDefaultDescription
qstringYesYour keyword or query.
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_statistics_sms_get

Get sms statistics

clicksend_account_statistics_voice_get

Get voice statistics

clicksend_account_subaccounts_by_subaccount_id_delete

Delete a subaccount Parameters:
ParameterTypeRequiredDefaultDescription
subaccount_idintegerYesID of subaccount to delete

clicksend_account_subaccounts_by_subaccount_id_get

Get specific subaccount Parameters:
ParameterTypeRequiredDefaultDescription
subaccount_idintegerYesID of subaccount to get

clicksend_account_subaccounts_by_subaccount_id_put

Update subaccount Parameters:
ParameterTypeRequiredDefaultDescription
subaccount_idintegerYesID of subaccount to update
access_billingintegerNoYour access billing flag value, must be 1 or 0.
access_contactsintegerNoYour access contacts flag value, must be 1 or 0.
access_reportingintegerNoYour access reporting flag value, must be 1 or 0.
access_settingsintegerNoYour access settings flag value, must be 1 or 0.
access_usersintegerNoYour access users flag value, must be 1 or 0.
api_usernamestringYesYour new api username.
emailstringYesYour new email.
first_namestringYesYour firstname
last_namestringYesYour lastname
passwordstringYesYour new password
phone_numberstringYesYour phone number in E.164 format.

clicksend_account_subaccounts_get

Get all subaccounts Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_subaccounts_post

Create new subaccount Parameters:
ParameterTypeRequiredDefaultDescription
access_billingintegerNoYour access billing flag value, must be 1 or 0.
access_contactsintegerNoYour access contacts flag value, must be 1 or 0.
access_reportingintegerNoYour access reporting flag value, must be 1 or 0.
access_settingsintegerNoYour access settings flag value, must be 1 or 0.
access_usersintegerNoYour access users flag value, must be 1 or 0.
api_usernamestringYesYour new api username.
emailstringYesYour new email.
first_namestringYesYour firstname
last_namestringYesYour lastname
passwordstringYesYour new password
phone_numberstringYesYour phone number in E.164 format.

clicksend_account_subaccounts_regen_api_key_by_subaccount_id_put

Regenerate an API Key Parameters:
ParameterTypeRequiredDefaultDescription
subaccount_idintegerYesID of subaccount to regenerate API key for

clicksend_account_timezones_get

Get supported list of timezones. Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
limitintegerNoNumber of records per page

clicksend_account_uploads_post

Upload File Parameters:
ParameterTypeRequiredDefaultDescription
convertstringYesThe convert value
contentstringYesYour base64 encoded file string.

clicksend_account_useage_by_subaccount_get

Get account useage by subaccount Parameters:
ParameterTypeRequiredDefaultDescription
yearintegerYesYear to filter by (yyyy)
monthintegerYesMonth to filter by (mm)

clicksend_account_verify_send_put

Send account activation token Parameters:
ParameterTypeRequiredDefaultDescription
countrystringYesCountry code
typestringYesType of verification
user_phonestringYesUser’s phone number

clicksend_account_verify_verify_by_activation_token_put

Verify new account Parameters:
ParameterTypeRequiredDefaultDescription
activation_tokenstringYesActivation Token