Account
/
Management

Management

Endpoints associated with creating and managing user accounts.

Download OpenAPI description
management.json
management.yaml
Languages
Servers

https://rest.clicksend.com/

View Account Details

Request

Get account information

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/account'

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's your account."
dataobject(account)
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here's your account.",
  "data": {
    "user_id": 116,
    "username": "johndoe1",
    "user_email": "johndoe1@awesome.com",
    "active": 0,
    "banned": 0,
    "balance": "4.998000",
    "user_phone": "+15184811001",
    "reply_to": "originalemail",
    "delivery_to": null,
    "user_first_name": "John",
    "user_last_name": "Doe",
    "account": 0,
    "account_name": "The Awesome Company",
    "account_billing_email": "johndoe1@awesome.com",
    "account_billing_mobile": "+15184811001",
    "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 Account Usage

Request

Get account usage

NameTypeRequiredRestrictionsDescription
yearstringtruenoneYour account usage year. Example: 2019
monthstringtruenoneYour account usage month. Example: 4

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

This endpoint requires authentication,more info...
Path
yearstringrequired
monthstringrequired
Headers
Content-Typestring
Example: application/json
curl -i -X GET \
  -u <username>:<password> \
  'https://rest.clicksend.com/v3/account/usage/{year}/{month}/subaccount' \
  -H 'Content-Type: application/json'

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 is your usage for this month."
dataobject
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here is your usage for this month.",
  "data": {
    "sms": [ … ],
    "voice": [ … ],
    "fax": [ … ],
    "post": [ … ],
    "email": [ … ],
    "sms_total": { … },
    "voice_total": { … },
    "fax_total": { … },
    "post_total": { … },
    "email_total": { … }
  }
}