Skip to end of metadata
Go to start of metadata

 

Create a sub-account.

http://api.textmarketer.co.uk/services/rest/account/sub

Creating a sub-account will attach the new account to the one used to access the API, which becomes the master account.

The ability to create accounts is disabled by default. To enable this, please contact Text Marketer.

PUT arguments

 

The following parameters can be used in a PUT request URL:

Parameter Value
username

The username of the accessing/master account, for authentication. Not required if you use HTTP Basic Authentication instead.

password 

The password of the accessing/master account, for authentication. Not required if you use HTTP Basic Authentication instead.

Request body parameters:

Under the REST methodology, data are sent in the request body.

Parameter

Value

account_password

Optional. Set an account password (for access to the web UI). Between 5 and 20 characters, inclusive. Alpha numeric (no accented letters), '-' and '_' characters allowed. If you don't supply one, a random password will be used.

account_username

Optional. Set an account username (for access to the web UI). Between 5 and 20 characters, inclusive. Alpha numeric (no accented letters), '-' and '_' characters allowed. If you don't supply one, a random password will be used.

company_name

Set a new company name for the account. Between 3 and 40 characters, inclusive. No special restrictions.

notification_email 

Optional (required if notification_mobile is not set). Sets the email address to which notifications and alerts are sent. Must be a valid email address.

notification_mobile

Optional (required if notification_email is not set). Sets the mobile number to which notifications and alerts are sent. Must be a valid UK mobile number.

override_pricing

If set to 'true', use the credits rates set on your main account (the account used to access the API), rather than the Text Marketer defaults.

promo_code Use a promotional code to put extra credits on the account.

although you cannot set the API username/password here (they are set to the same values as the account username/password you specify), you can modify them afterwards using the POST method.

Specific errors:

CodeMeaning
0

Either the email address or mobile number must be supplied.

1

The company name must be supplied.

2

The email address you specified is invalid.

3

The mobile number you specified is not a valid UK mobile number.

4

A value you tried to set is either too long or too short. See specific error text.

5A value you tried to set does not match the required pattern. See specific error text.
6

A parameter was missing (see specific error text).

7The username you specified is already in use. Please choose another.
8

You have reached your limit for the number of accounts you can create.

Please contact Text Marketer to increase this.

that a 404 status code is returned if the account ID specified does not exist, and 403 if you do not have permission to access the account you specified.

Example successful response body XML:

DTD: