Create a new account

POST

/account

Account

Note: Authentication isn't required to create a new account.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://rest.clicksend.com/v3/account' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account_name": "The Awesome Company",
    "country": "US",
    "password": "pass",
    "user_email": "johndoe1@awesome.com",
    "user_first_name": "John",
    "user_last_name": "Doe",
    "user_phone": "518-481-1001",
    "username": "johndoe1"
}'

Response Example

{
    "data": {
        "_currency": {
            "currency_name_long": "US Dollars",
            "currency_name_short": "USD",
            "currency_prefix_c": "¢",
            "currency_prefix_d": "$"
        },
        "_subaccount": {
            "access_billing": 1,
            "access_contacts": 1,
            "access_email": 1,
            "access_fax": 1,
            "access_mms": 1,
            "access_post": 1,
            "access_reporting": 1,
            "access_reseller": 1,
            "access_settings": 1,
            "access_sms": 1,
            "access_users": 1,
            "access_voice": 1,
            "api_key": "F3702045-EB2C-0091-C211-7728048DCAE2",
            "api_username": "johndoe1",
            "email": "johndoe1@awesome.com",
            "first_name": "John",
            "last_name": "Doe",
            "notes": null,
            "phone_number": "+15184811001",
            "share_campaigns": 0,
            "subaccount_id": 126
        },
        "account": 0,
        "account_billing_email": "johndoe1@awesome.com",
        "account_billing_mobile": "+15184811001",
        "account_name": "The Awesome Company",
        "active": 0,
        "auto_recharge": 0,
        "auto_recharge_amount": "20.00",
        "balance": "4.998000",
        "balance_commission": "0.299954",
        "banned": 0,
        "country": "US",
        "default_country_sms": "US",
        "delivery_to": null,
        "low_credit_amount": "0.00",
        "old_dashboard": 0,
        "reply_to": "originalemail",
        "setting_email_sms_subject": 0,
        "setting_fix_sender_id": 0,
        "setting_sms_message_char_limit": 6,
        "setting_unicode_sms": 0,
        "timezone": "Australia/Melbourne",
        "user_email": "johndoe1@awesome.com",
        "user_first_name": "John",
        "user_id": 116,
        "user_last_name": "Doe",
        "user_phone": "+15184811001",
        "username": "johndoe1"
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Successfully created an account."
}

Request

Body Params application/json

account_name

string

required

Your delivery to value.

country

string

required

Your country.

password

string

required

Your password.

user_email

string

required

Your email.

user_first_name

string

required

Your first name.

user_last_name

string

required

Your last name.

user_phone

string

required

Your phone number in E.164 format.

username

string

required

Your username.

Examples

Responses

🟢200OK

application/json

Body

object {0}

Get account

Update Account