Account

View Subaccounts

Subaccounts

Everything about Subaccounts.

Download OpenAPI description

subaccounts.json

subaccounts.yaml

Servers

https://rest.clicksend.com/

View Subaccounts

Request

Get all subaccounts

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

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: "SUCCESS"

dataArray of objects(subaccount)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "SUCCESS",
  "data": [
    { … }
  ]
}

Create Subaccount

Request

Create new subaccount

Properties

Name	Type	Required	Restrictions	Description
api_username	string	true	none	Your new api username.
password	string	true	none	Your new password
email	string	true	none	Your new email.
phone_number	string	true	none	Your phone number in E.164 format.
first_name	string	true	none	Your firstname
last_name	string	true	none	Your lastname
access_users	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_billing	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_reporting	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_contacts	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_settings	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.

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

api_usernamestring

Example: "test"

passwordstring

Example: "test123"

emailstring

Example: "test@test.com"

phone_numberstring

Example: "+61411111111"

first_namestring

Example: "John"

last_namestring

Example: "Doe"

user_idinteger

Example: 3839

sms_deidentify_messageinteger

access_smppinteger

access_usersinteger

Example: 1

access_billinginteger

Example: 1

access_reportinginteger

Example: 1

access_contactsinteger

Example: 1

access_settingsinteger

Example: 1

notesstring

Example: "these are test notes"

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

     --data-binary "    {
        \"api_username\":\"nameP99\",
        \"password\":\"pass\",
        \"email\":\"testvrq@gmail.com\",
        \"phone_number\":\"941-751-3278\",
        \"first_name\":\"FirstnameeGPqV\",
        \"last_name\":\"LastnamePvjJp\"
    }" \
'https://rest.clicksend.com/v3/subaccounts'

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 account has been created."

dataobject(subaccount)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "New account has been created.",
  "data": {
    "subaccount_id": 126,
    "api_username": "johndoe1",
    "email": "johndoe1@awesome.com",
    "phone_number": "+15184811001",
    "first_name": "John",
    "last_name": "Doe",
    "api_key": "F3702045-EB2C-0091-C211-7728048DCAE2",
    "access_users": 1,
    "access_billing": 1,
    "access_reporting": 1,
    "access_contacts": 1,
    "access_settings": 1,
    "access_sms": 1,
    "access_email": 1,
    "access_voice": 1,
    "access_fax": 1,
    "access_post": 1,
    "access_reseller": 1,
    "access_mms": 1,
    "share_campaigns": 0,
    "notes": null
  }
}

View Specific Subaccount

Request

Get specific subaccount

Parameters

Parameter	In	Type	Required	Description
subaccount_id	path	integer(int32)	true	ID of subaccount to get

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

This endpoint requires authentication,more info...

Path

subaccount_idstringrequired

Headers

Content-Typestring

Example: application/json

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

'https://rest.clicksend.com/v3/subaccounts/{subaccount_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(subaccount)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here are your data.",
  "data": {
    "subaccount_id": 126,
    "api_username": "johndoe1",
    "email": "johndoe1@awesome.com",
    "phone_number": "+15184811001",
    "first_name": "John",
    "last_name": "Doe",
    "api_key": "F3702045-EB2C-0091-C211-7728048DCAE2",
    "access_users": 1,
    "access_billing": 1,
    "access_reporting": 1,
    "access_contacts": 1,
    "access_settings": 1,
    "access_sms": 1,
    "access_email": 1,
    "access_voice": 1,
    "access_fax": 1,
    "access_post": 1,
    "access_reseller": 1,
    "access_mms": 1,
    "share_campaigns": 0,
    "notes": null
  }
}

Update Subaccount

Request

Update subaccount

Parameters

Parameter	In	Type	Required	Description
subaccount_id	path	integer(int32)	true	ID of subaccount to update

Properties

Name	Type	Required	Restrictions	Description
api_username	string	true	none	Your new api username.
password	string	true	none	Your new password
email	string	true	none	Your new email.
phone_number	string	true	none	Your phone number in E.164 format.
first_name	string	true	none	Your firstname
last_name	string	true	none	Your lastname
access_users	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_billing	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_reporting	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_contacts	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.
access_settings	integer(int1)	false	none	Flag value must be 1 for yes or 0 for no.

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

This endpoint requires authentication,more info...

Path

subaccount_idstringrequired

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

access_smsinteger

Example: 1

emailstring

Example: "{{email}}"

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

     --data-binary "    {
        \"password\":\"pass\",
        \"email\":\"testfP0.updated@gmail.com\",
        \"phone_number\":\"+19417519130\",
        \"first_name\":\"FirstnameKvdRZUpdated\",
        \"last_name\":\"LastnameHUPYGUpdated\",
        \"access_users\": 1,
        \"access_billing\": 1,
        \"access_reporting\": 1,
        \"access_contacts\": 1,
        \"access_settings\": 1,
        \"access_sms\": 1,
        \"access_email\": 1,
        \"access_voice\": 1,
        \"access_fax\": 1,
        \"access_post\": 1,
        \"access_reseller\": 1,
        \"access_mms\": 1,
        \"share_campaigns\": 0,
        \"notes\": null
    }" \
'https://rest.clicksend.com/v3/subaccounts/{subaccount_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: "Subaccount #59 has been updated."

dataobject(subaccount)

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Subaccount #59 has been updated.",
  "data": {
    "subaccount_id": 59,
    "api_username": "nameP99",
    "email": "testfP0.updated@gmail.com",
    "phone_number": "+619417513065",
    "first_name": "FirstnameKvdRZ Updated",
    "last_name": "LastnameHUPYG Updated",
    "api_key": "367C506E-FBCA-1EDA-E8E0-1384F9F196D5",
    "access_users": 1,
    "access_billing": 1,
    "access_reporting": 1,
    "access_contacts": 1,
    "access_settings": 1,
    "access_sms": 1,
    "access_email": 1,
    "access_voice": 1,
    "access_fax": 1,
    "access_post": 1,
    "access_reseller": 1,
    "access_mms": 1,
    "share_campaigns": 0,
    "notes": null
  }
}

Delete Subaccount

Request

Delete a subaccount

Parameters

Parameter	In	Type	Required	Description
subaccount_id	path	integer(int32)	true	ID of subaccount to delete

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

This endpoint requires authentication,more info...

Path

subaccount_idstringrequired

Headers

Content-Typestring

Example: application/json

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

'https://rest.clicksend.com/v3/subaccounts/{subaccount_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: "Subaccount #59 has been deleted"

databoolean

The status of the operation.

Example: true

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Subaccount #59 has been deleted",
  "data": true
}

Generate New API Key

Request

Regenerate an API Key

Parameters

Parameter	In	Type	Required	Description
subaccount_id	path	integer(int32)	true	ID of subaccount to regenerate API key for

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

This endpoint requires authentication,more info...

Path

subaccount_idstringrequired

Headers

Content-Typestring

Example: application/json

Bodyapplication/json

access_smsinteger

Example: 1

emailstring

Example: "{{email}}"

notesstring

Example: "This is a test"

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

'https://rest.clicksend.com/v3/subaccounts/{subaccount_id}/regen-api-key'

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 API Key has been regenerated."

dataobject

Response

application/json

{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Your API Key has been regenerated.",
  "data": {
    "api_key": "E72D09F6-AC80-0A5C-F7F0-1A244A377A5C"
  }
}

Subaccounts

View Subaccounts

Request

Parameters

Responses

Was this helpful?

Create Subaccount

Request

Properties

Responses

Was this helpful?

View Specific Subaccount

Request

Parameters

Responses

Was this helpful?

Update Subaccount

Request

Parameters

Properties

Responses

Was this helpful?

Delete Subaccount

Request

Parameters

Responses

Was this helpful?

Generate New API Key

Request

Parameters

Responses

Was this helpful?