Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.
Sections:
- Description
- Oempro Version
- Request Parameters
- Response Parameters
- Error Codes
User.Create
Description
Creates new user account.
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.Create} (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
- RelUserGroupID = {integer} (required)
- ID number of the user group which is assigned to the user
- EmailAddress = {string} (required)
- Email address of the new user
- Username = {string} (required)
- Username of the user account
- Password = {string} (required)
- Password of the user account
- FirstName = {string} (required)
- First name of the user account
- LastName = {string} (required)
- Last name of the user account
- TimeZone = {string} (required)
- Time zone of the user location
- Language = {string} (required)
- Language code (Ex: en)
- ReputationLevel = {Trusted | Untrusted} (required)
- Reputation level of the user (currently disabled)
- CompanyName = {string} (required)
- Company name of the user
- Website = {string} (required)
- Website URL
- Street = {string} (required)
- Street of the user address
- City = {string} (required)
- City of the user address
- State = {string} (required)
- State of the user address
- Zip = {string} (required)
- Zip of the user address
- Country = {string} (required)
- Country of the user address
- Phone = {string} (required)
- Phone of the user address
- Fax = {string} (required)
- Fax of the user address
- PreviewMyEmailAccount = {string} (required)
- If user has a PreviewMyEmail.com account with API enabled, subdomain of the previewmyemail.com account
- PreviewMyEmailAPIKey = {string} (required)
- If user has a PreviewMyEmail.com account with API enabled, API key of the account
- 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
- UserID = {integer}
- ID number of the new user account
Error Codes
- 1
- Missing user group ID
- 2
- Missing email address
- 3
- Username is missing
- 4
- Password is missing
- 5
- Reputation level is missing
- 6
- Missing first name
- 7
- Missing last name
- 8
- Missing time zone
- 9
- Missing language
- 10
- Invalid email address
- 11
- Invalid user group ID
- 12
- Username is already registered
- 13
- Email address is already registered
- 14
- Invalid language. Not supported.
- 15
- Invalid reputation level
- 16
- Maximum allowed user accounts in your license exceeded
- 99998
- Authentication failure or session expired
- 99999
- Not enough privileges
Stay connected!