Skip to end of metadata
Go to start of metadata

 

Create a new account, linked to your main account (requires additional permissions on your account, please contact Text Marketer to apply).

Example

Arguments:

 

string $companyName:

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

string $notificationMobile:

(optional*) a mobile number to which notifications and alerts are sent. Must be a valid UK mobile number.

*Required if $notificationEmail is not set.

string $notificationEmail:

(optional*) an email address to which notifications and alerts are sent.

*Required if $notificationMobile is not set. 

string $username:

(optional) the username you wish to set on the new account - the API username will be the same. Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters allowed. If this is not set, one will be set for you.

string $password:

(optional) the password you wish to set on the new account - the API password will be the same. Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters allowed. If this is not set, one will be set for you.

string $promoCode:

(optional) a promotional code entitling the new account to extra credits.

boolean $overrideRates:

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

Returns:

an array with 10 keys: 'api_password', 'api_username', 'company_name', 'create_date', 'credits', 'password' and 'username', 'notification_email', 'notification_mobile', 'account_id'

Array key

Value

api_password 

String. The new account API password

api_usernameString. The new account API username
company_name 

String. The new account company name

create_dateString. The creation date of the account in ISO 8601 format
credit 

Integer. The number of credits on the new acccount.

password 

String. The new account web interface password.

username 

String. The new account web interface username.

notification_emailString. The new account email address used for notifications.
notification_mobile

String. The new account UK mobile number used for notifications.

account_id String. The ID of the account used for identification in other functions.

Specific error codes:

Code 

Meaning

0Either 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).

7

The 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.

see General error codes

 

 

 

You must know!

Our example code is an illustration of how you might integrate with our systems and is not certified for production environments. You are responsible for testing and QA.