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

Email.Update

Description

Updates custom field 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 = {Email.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
ValidateScope = {OptIn | Campaign | AutoResponder} (required)
Defines the validation scope of the email (required fields, links, etc.)
EmailID = {integer} (required)
Id of the email to be updated
EmailName = {string} (required)
Name of the email
FromName = {string} (required)
From name of the email
FromEmail = {string} (required)
From email address of the email
ReplyToName = {string} (required)
Reply to name of the email
ReplyToEmail = {string} (required)
Reply to email address of the email
Mode = {Empty | Template | Import} (required)
Email's content mode
FetchURL = {string} (required)
Email's remote content url
Subject = {string} (required)
Email's subject
PlainContent = {string} (required)
Email's plain content
HTMLContent = {string} (required)
Email's html content
ImageEmbedding = {Enabled | Disabled} (required)
Email's image embedding
RelTemplateID = {integer} (required)
Email's template id

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
Email id is missing
2
FetchURL is missing
3
Email id is invalid
4
Mode is invalid
5
RelTemplateID is missing
6
FromEmail email address is invalid
7
ReplyToEmail email address is invalid
8
Plain and HTML content is empty
9
Missing validation scope parameter
10
Invalid validation scope parameter
11
Missing unsubscription link in HTML content
12
Missing unsubscription link in plain content
13
Missing opt-in confirmation link in HTML content
14
Missing opt-in confirmation link in plain content
15
Missing opt-in reject link in HTML content
16
Missing opt-in reject link in plain content
99998
Authentication failure or session expired
99999
Not enough privileges

Stay connected!