parameter | value | type | default / required* | notes |
---|
nkey | | token | * | Session key or token. Automatically assigned (only if optional) or obtained via acct_login/acct_token call. |
acct | | string | | Account e-mail. If left empty, then the request is on behalf of the account that is logged in (nkey). |
name | | string (60) | | Client name (first last). |
email | | string (80) | | Account email address, and account credentials. |
passwd | | string | | Account password. Please use a minimum of five characters including at least one digit or non-alphanumeric character.. |
apipasswd | | string | | Main API password. Please use a minimum of five characters including at least one digit or non-alphanumeric character.. |
lang | | string (6) | | Language, two chararters, following ISO 639. |
timezone | | string | | Timezone name, example: Europe/Amsterdam. |
company | | string (60) | | Company name. |
address | | string (60) | | Address. |
zip | | string (10) | | ZIP or postal code. |
city | | string (40) | | City. |
state | | string (40) | | State or province. |
country | | char (2) | | Country, following ISO 3166. Examples: us, gb, nl. |
telnr | | string (256) | | Telephone number, including "+" and international prefix. |
faxnr | | string (15) | | Facsimile number, including "+" and international prefix. |
callback | | string | | Callback function for JSONP style calls. When this parameter is given, the result will be JSON instead of XML. |
view | | enum (xml, json) | xml | Specifies the desirable representation of the output (XML or JSON). HTTP Accept header can be used and has precedence. |