Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »


 

Modify account details.

POST arguments

The following parameters can be used in a POST request:

Parameter

Value

account_api_password

Optional. Set a new API password. Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters.

account_api_username

Optional. Set a new API username. Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters.

account_password

Optional. Set a new account password (for access to the web UI). Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters allowed.

account_username

Optional. Set a new account username (for access to the web UI). Between 5 and 20 characters, inclusive. Alpha-numeric (no accented letters), '-' and '_' characters allowed.

company_name 

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

notifcation_email 

Optional. Sets the email address to which notifcations and alerts are sent. Must be a valid email address.

notifcation_mobile 

Optional. Sets the mobile number to which notifcations and alerts are sent. Must be a valid UK mobile number.

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.

specific errors:

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

5

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

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

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:

  • No labels