Support and Documentation


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:

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

Settings.Update

Description

Update system settings. This API command can be called by administrative privileges

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 = {Settings.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

System_Email_from_Name = {string}

System_Email_from_Email = {string}

System_Email_Replyto_Name = {string}

System_Email_Replyto_Email = {string}

Alert_Recipient_Email = {string}

Report_Abuse_Email = {string}

X_Complaints_To = {string}

S3_Enabled = {true | false}

S3_Access_Id = {string}

S3_Secret_Key = {string}

S3_Bucket = {string}

S3_Medialibrary_Path = {string}

S3_URL = {string}

Media_Upload_Method = {file | database | s3}

Threshold_Soft_Bounce_Detection = {integer}

Fbl_Incoming_Emailaddress = {string}

Bounce_Catchall_Domain = {string}

Load_Balance_Status = {true | false}

Load_Balance_Emails = {integer}

Load_Balance_Sleep = {integer}

Pme_Usage_Type = {Admin | User}

Pme_Default_Account = {string}

Pme_Default_Apikey = {string}

User_Signup_Enabled = {true | false}

User_Signup_Fields = {string}

User_Signup_Reputation = {Trusted | Untrusted}

User_Signup_Language = {string}

Default_Language = {string}

User_Signup_Groupid = {integer}
ID number of the user group which the user will be assigned to. Pass -1 to make this option selectable in user sign up form
User_Signup_Groupids = {string}
ID number of user groups which will be shown in user sign-up form

Default_Themeid = {integer}

Payment_Currency = {string}

Payment_Tax_Percent = {integer}

Payment_Receipt_Email_Subject = {string}

Payment_Receipt_Email_Message = {string}

Admin_Captcha = {true | false}

User_Captcha = {true | false}

Enabled_Plugins = {string}

Send_Method = {SMTP | LocalMTA | PHPMail | PowerMTA | SaveToDisk}

Send_Method_Localmta_Path = {string}

Send_Method_Powermta_Vmta = {string}

Send_Method_Powermta_Dir = {string}

Send_Method_Savetodisk_Dir = {string}

Send_Method_Smtp_Host = {string}

Send_Method_Smtp_Port = {integer}

Send_Method_Smtp_Secure = { | ssl | tls}

Send_Method_Smtp_Auth = {true | false}

Send_Method_Smtp_Username = {string}

Send_Method_Smtp_Password = {string}

Send_Method_Smtp_Timeout = {integer}

Send_Method_Smtp_Debug = {true | false}

Send_Method_Smtp_Keepalive = {true | false}

Send_Method_Smtp_Msg_Conn = {integer}

Import_Max_Filesize = {integer}

Attachment_Max_Filesize = {integer}

Media_Max_Filesize = {integer}

X_Mailer = {string}

Mail_Engine = {phpmailer | swiftmailer}

Google_Analytics_Source = {string}

Google_Analytics_Medium = {string}

Forward_to_Friend_Header = {string}

Forward_to_Friend_Footer = {string}

Report_Abuse_Friend_Header = {string}

Report_Abuse_Friend_Footer = {string}

User_Signup_Header = {string}

User_Signup_Footer = {string}

Product_Name = {string}

Default_Subscriberarea_Logout_Url = {string}

Pop3_Bounce_Status = {Enabled | Disabled}

Pop3_Bounce_Host = {string}

Pop3_Bounce_Port = {integer}

Pop3_Bounce_Username = {string}

Pop3_Bounce_Password = {string}

Pop3_Fbl_Status= {Enabled | Disabled}

Pop3_Fbl_Host = {string}

Pop3_Fbl_Port = {integer}

Pop3_Fbl_Username = {string}

Pop3_Fbl_Password = {string}

Pop3_Requests_Status = {Enabled | Disabled}

Pop3_Requests_Host = {string}

Pop3_Requests_Port = {integer}

Pop3_Requests_Username = {string}

Pop3_Requests_Password = {string}

Send_Bounce_Notificationemail = {Enabled | Disabled}

Rebranded_Product_Logo = {Enabled | Disabled}

Rebranded_Product_Logo_Type = {string}

PaypalExpressStatus = {Enabled | Disabled}

PaypalExpressBusinessName = {string}

PaypalExpressPurchaseDescription = {string}

PaypalExpressCurrency = {string}

PaypalWPPStatus = {Enabled | Disabled}

Display_Trigger_Send_Engine_Link = {Yes | No}

Default_Optin_Email_Subject = {string}

Default_Optin_Email_Body = {string}

Response Parameters

Success = {true | false}
States if there is an error or not
ErrorCode = {integer}
If there is an error, error's code
EmailSettingsErrorMessage = {string}
If an error occurs on email settings, error message is provided

Error Codes

1
Invalid email address format
2
Invalid field value
3
PreviewMyEmail.com server connection error
4
Invalid PreviewMyEamil.com account information
5
Email settings failed. Check for returned error message
6
POP3 connection failed. Incorrect connection parameters. Returned POP3 error message included in 'EmailSettingsErrorMessage' parameter.
7
Default opt-in email body does not contain the subscription confirmation link tag (%Link: Confirm%)
99998
Authentication failure or session expired
99999
Not enough privileges

Stay connected!