Reseller

Account

Learn how to manage your clients and reseller accounts via API.

Note:

Unfortunately, our reseller dashboard, white-label and reseller API are only available to customers who were approved as resellers before 1st Jan, 2024. If you were not approved as a reseller before 1st Jan, 2024, you may still earn profits by adding a mark-up on your client rates when reselling ClickSend through our standard messaging endpoints.

Download OpenAPI description

reseller.json

reseller.yaml

Servers

https://rest.clicksend.com/

View Client Accounts

Request

Get list of reseller accounts

Parameters

Parameter	In	Type	Required	Description
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/reseller/accounts'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Here are you data."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are you data.",
  "data": {
    "total": 2,
    "per_page": 15,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 2,
    "data": [ … ],
    "_currency": { … },
    "_subaccount": { … }
  }
}

Create Reseller Account

Request

Create reseller account

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	Account username
password	string	true	none	Account password (unhashed)
user_email	string	true	none	Account email
user_phone	string	true	none	Account phone number
user_first_name	string	true	none	Account owner first name
user_last_name	string	true	none	Account owner last name
account_name	string	true	none	Account name (usually company name)
country	string	true	none	Country of account holder

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

countrystring

Example: "Country Example"

passwordstring

Example: "password123"

user_emailstring

Example: "user@example.com"

user_first_namestring

Example: "John"

user_last_namestring

Example: "Doe"

account_namestring

Example: "JohnDoeAccount"

user_phonestring

Example: "+1234567890"

usernamestring

Example: "johndoe"

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \

     --header "Content-Type: application/json" \
     --data-binary "    {
        \"username\":\"johndoe2\",
        \"user_email\":\"johndoe2@awesome.com\",
        \"user_phone\":\"518-481-1002\",
        \"user_first_name\":\"John\",
        \"user_last_name\":\"Doe\",
        \"country\":\"US\",
        \"password\":\"pass\",
        \"account_name\":\"The Awesome Company\"
    }" \
'https://rest.clicksend.com/v3/reseller/accounts'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "New reseller has been added."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "New reseller has been added.",
  "data": {
    "user_id": 117,
    "username": "johndoe2",
    "user_email": "johndoe2@awesome.com",
    "active": 0,
    "banned": 0,
    "balance": "0.000000",
    "user_phone": 15184811002,
    "reply_to": "originalemail",
    "delivery_to": null,
    "user_first_name": "John",
    "user_last_name": "Doe",
    "account": 0,
    "account_name": "The Awesome Company",
    "account_billing_email": "johndoe2@awesome.com",
    "account_billing_mobile": 15184811002,
    "country": "US",
    "default_country_sms": "US",
    "auto_recharge": 0,
    "auto_recharge_amount": "20.00",
    "low_credit_amount": "0.00",
    "setting_unicode_sms": 0,
    "setting_email_sms_subject": 0,
    "setting_fix_sender_id": 0,
    "setting_sms_message_char_limit": 6,
    "old_dashboard": 0,
    "balance_commission": "0.299954",
    "timezone": "Australia/Melbourne",
    "_currency": { … },
    "_subaccount": { … }
  }
}

View Specific Client Account

Request

Get Reseller clients Account

Parameters

Parameter	In	Type	Required	Description
client_user_id	path	integer(int32)	true	User ID of client

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

client_user_idstringrequired

Headers

Content-Typestring

Example: application/json

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/reseller/accounts/{client_user_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Here are your data."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are your data.",
  "data": {
    "user_id": 117,
    "username": "johndoe2",
    "user_email": "johndoe2@awesome.com",
    "active": 0,
    "banned": 0,
    "balance": "0.000000",
    "user_phone": 15184811002,
    "reply_to": "originalemail",
    "delivery_to": null,
    "user_first_name": "John",
    "user_last_name": "Doe",
    "account": 0,
    "account_name": "The Awesome Company",
    "account_billing_email": "johndoe2@awesome.com",
    "account_billing_mobile": 15184811002,
    "country": "US",
    "default_country_sms": "US",
    "auto_recharge": 0,
    "auto_recharge_amount": "20.00",
    "low_credit_amount": "0.00",
    "setting_unicode_sms": 0,
    "setting_email_sms_subject": 0,
    "setting_fix_sender_id": 0,
    "setting_sms_message_char_limit": 6,
    "old_dashboard": 0,
    "balance_commission": "0.299954",
    "timezone": "Australia/Melbourne",
    "_currency": { … },
    "_subaccount": { … }
  }
}

Update Client Account

Request

Update Reseller clients Account

Parameters

Parameter	In	Type	Required	Description
client_user_id	path	integer(int32)	true	User ID of client

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	Account username
password	string	true	none	Account password (unhashed)
user_email	string	true	none	Account email
user_phone	string	true	none	Account phone number
user_first_name	string	true	none	Account owner first name
user_last_name	string	true	none	Account owner last name
account_name	string	true	none	Account name (usually company name)
country	string	true	none	Country of account holder

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Path

client_user_idstringrequired

Headers

Content-Typestring

Example: application/x-www-form-urlencoded

Bodyapplication/json

numberstring

Example: "1234567812345678"

expiry_monthinteger

Example: 12

expiry_yearinteger

Example: 2025

cvcinteger

Example: 123

namestring

Example: "John Doe"

bank_namestring

Example: "Bank of Example"

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \

     --header "Content-Type: application/json" \
     --data-binary "    {
        \"username\":\"johndoe2\",
        \"user_email\":\"johndoe2@awesome.com\",
        \"user_phone\":\"518-481-1002\",
        \"user_first_name\":\"John\",
        \"user_last_name\":\"Doe\",
        \"country\":\"US\",
        \"password\":\"pass\",
        \"account_name\":\"The Awesome Company\"
    }" \
'https://rest.clicksend.com/v3/reseller/accounts/{client_user_id}'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Reseller account has been updated."

dataobject

Example: {"user_id":117,"username":"johndoe2","user_email":"johndoe2@awesome.com","active":0,"banned":0,"balance":"199.997000","user_phone":"518-481-1002","reply_to":"originalemail","delivery_to":null,"user_first_name":"John","user_last_name":"Doe","account":0,"account_name":"The Awesome Company","account_billing_email":"johndoe2@awesome.com","account_billing_mobile":"+15184811002","country":"US","default_country_sms":"US","auto_recharge":0,"auto_recharge_amount":"20.00","low_credit_amount":"0.00","setting_unicode_sms":0,"setting_email_sms_subject":0,"setting_fix_sender_id":0,"setting_sms_message_char_limit":6,"old_dashboard":0,"balance_commission":"0.299954","timezone":"Australia/Melbourne","_currency":{"currency_name_short":"USD","currency_prefix_d":"$","currency_prefix_c":"¢","currency_name_long":"US Dollars"},"_subaccount":null}

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Reseller account has been updated.",
  "data": {
    "user_id": 117,
    "username": "johndoe2",
    "user_email": "johndoe2@awesome.com",
    "active": 0,
    "banned": 0,
    "balance": "199.997000",
    "user_phone": "518-481-1002",
    "reply_to": "originalemail",
    "delivery_to": null,
    "user_first_name": "John",
    "user_last_name": "Doe",
    "account": 0,
    "account_name": "The Awesome Company",
    "account_billing_email": "johndoe2@awesome.com",
    "account_billing_mobile": "+15184811002",
    "country": "US",
    "default_country_sms": "US",
    "auto_recharge": 0,
    "auto_recharge_amount": "20.00",
    "low_credit_amount": "0.00",
    "setting_unicode_sms": 0,
    "setting_email_sms_subject": 0,
    "setting_fix_sender_id": 0,
    "setting_sms_message_char_limit": 6,
    "old_dashboard": 0,
    "balance_commission": "0.299954",
    "timezone": "Australia/Melbourne",
    "_currency": { … },
    "_subaccount": null
  }
}

Reseller Transfer Credit

Request

Transfer Credit

Properties

Name	Type	Required	Restrictions	Description
client_user_id	integer(int32)	true	none	User ID of client
balance	integer(int32)	true	none	Balance to transfer
currency	string	true	none	Currency of balance to transfer

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication,more info...

Headers

Content-Typestring

Example: application/x-www-form-urlencoded

Bodyapplication/json

numberstring

Example: "1234567812345678"

expiry_monthinteger

Example: 12

expiry_yearinteger

Example: 2025

cvcinteger

Example: 123

namestring

Example: "John Doe"

bank_namestring

Example: "Bank of Example"

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \
     --header "Content-Type: application/json" \

     --data-binary "    {
        \"client_user_id\":60,
        \"balance\":12,
        \"currency\":\"USD\"
    }" \
'https://rest.clicksend.com/v3/reseller/transfer-credit'

Responses

Successful response

Bodyapplication/json

http_codeinteger

The HTTP status code of the response.

Example: 200

response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"

response_msgstring

A message describing the outcome of the operation.

Example: "Your balance has been successfully transferred."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your balance has been successfully transferred.",
  "data": {
    "user_id": 117,
    "username": "johndoe2",
    "user_email": "johndoe2@awesome.com",
    "active": 0,
    "banned": 0,
    "balance": "0.000000",
    "user_phone": 15184811002,
    "reply_to": "originalemail",
    "delivery_to": null,
    "user_first_name": "John",
    "user_last_name": "Doe",
    "account": 0,
    "account_name": "The Awesome Company",
    "account_billing_email": "johndoe2@awesome.com",
    "account_billing_mobile": 15184811002,
    "country": "US",
    "default_country_sms": "US",
    "auto_recharge": 0,
    "auto_recharge_amount": "20.00",
    "low_credit_amount": "0.00",
    "setting_unicode_sms": 0,
    "setting_email_sms_subject": 0,
    "setting_fix_sender_id": 0,
    "setting_sms_message_char_limit": 6,
    "old_dashboard": 0,
    "balance_commission": "0.299954",
    "timezone": "Australia/Melbourne",
    "_currency": { … },
    "_subaccount": { … }
  }
}

Reseller

Note:

View Client Accounts

Request

Parameters

Responses

Was this helpful?

Create Reseller Account

Request

Properties

Responses

Was this helpful?

View Specific Client Account

Request

Parameters

Responses

Was this helpful?

Update Client Account

Request

Parameters

Properties

Responses

Was this helpful?

Reseller Transfer Credit

Request

Properties

Responses

Was this helpful?