Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

User.Update

Description

Update the user information

Oempro Version

4+

Request Parameters

SessionID = {string} (required)

Session ID which is needed to authenticate the access. It's optional and required for desktop applications only

Command = {User.Update} (required)

API Command

ResponseFormat = {JSON | XML} (required)

Response format

JSONPCallBack = {bool}

Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP

UserID = {integer} (required)

Target user ID to update

RelUserGroupID = {integer} (required)

ID number of the user group which is assigned to the user

EmailAddress = {string} (required)

Email address of the user

Username = {string} (required)

Username of the user

Password = {string} (required)

Password of the user

ReputationLevel = {Trusted | Untrusted} (required)

Reputation level of the user

UserSince = {YYYY-MM-DD HH: MM: SS} (required)

Sign-up date of the user

FirstName = {string} (required)

First name of the user

LastName = {string} (required)

Last name of the user

Companyname = {string} (required)

Company name of the user

Website = {string} (required)

Website of the user

Street = {string} (required)

Street of the user

City = {string} (required)

City of the user

State = {string} (required)

State of the user

Zip = {string} (required)

Zip of the user

Country = {string} (required)

Country of the user

Phone = {string} (required)

Phone of the user

Fax = {string} (required)

Fax of the user

TimeZone = {string} (required)

TimeZone of the user

SignUpIPAddress = {string} (required)

IP address of the user during sign-up process

APIKey = {string} (required)

API key of the user

Language = {string} (required)

Language of the user

LastActivityDateTime = {YYYY-MM-DD HH: MM: SS} (required)

Last activity time of the user

PreviewMyEmailAccount = {string} (required)

If user is subscribed to PreviewMyEmail.com service, subdomain of the account

PreviewMyEmailAPIKey = {string} (required)

If user is subscribed to PreviewMyEmail.com service, API key of the account

AccountStatus = {Enabled | Disabled}

Set to "Disabled" if you wish to disable user account, else set it to "Enabled"

AvailableCredits = {Integer} (>=v4.1.0)

Set the available credits for the user

Response Parameters

Success = {true | false}

States if there is an error or not

ErrorCode = {integer}

If there is an error, error's code

Error Codes

1

User ID is missing

2

Authentication failed

3

PreviewMyEmail.com connection error occurred

4

Invalid PreviewMyEmail.com access information

5

Invalid user ID

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!