Contacts
| Field |
Type |
| idContact |
String |
| idDatabase |
String |
| primaryKeyValue |
String |
| email |
String |
| status |
String
It may accept subscribed, unsubscribed, unconfirmed and suspended values too. |
| check |
String |
| values |
List of MNContactValue |
| Field |
Type |
| values |
MNContactValue |
| Field |
Type |
| field |
String |
| value |
String |
Note: When the field name is "flag_stato" it can be substituted with "status". In this case the field_value allowed are: "subscribed", "unsubscribed", "unconfirmed", "suspended".
| Field |
Type |
| idContact |
String |
| debug |
String |
| primaryKeyValue |
String |
| requestedAction |
String |
| actionResult |
String |
| ok |
Boolean |
| errors |
List of MNError |
| sendEmailResult |
MNSendEmailResult |
MNError
| Field |
Type |
Description |
| fieldRef |
String |
|
| debugExplanation |
String |
|
| value |
String |
|
| errorType |
String |
"Generic", "EmptyValue", "ValueNotValid", "UniqueConstraintViolation" |
Filter
| Field |
Type |
|
| field |
String |
Field ID e.g. 'NAME' |
| operator |
String |
Filter operator e.g. 'UGUALE' |
| value |
String |
Value converted to a string according to the user's settings |
| conjunction (optional) |
String |
'AND' or 'OR'. To compose more conditions fill out the conjunction and children fields and leave blank the previous ones. |
| children (optional) |
List of Filter |
|
Operators
Operators for filters on contacts:
| Operator |
Description |
| 'UGUALE' |
Equal |
| 'DIVERSO' |
Different |
| 'MAGGIORE' |
Greater than |
| 'MINORE' |
Less than |
| 'MAGGIORE_UGUALE' |
Greater than or equal |
| 'MINORE_UGUALE' |
Less than or equal |
| 'E' |
Is |
| 'CONTIENE' |
Contains |
| 'INIZIA_PER' |
Begins with |
| 'FINISCE_PER' |
Ends with |
FileOptions
| Field |
Type |
Description |
| fileType |
String |
Default 'csv' |
| zipped |
Boolean |
Default false |
| columnMapping |
List of String |
Contains the mapping between the columns of the file and the fields in the DB. You must specify the field ID (e.g. EMAIL,NAME, ...), not the textual description (e.g. E-mail, Contact name, ...) |
| options |
List of <Option> |
Available values:
- encoding (encoding of the file, default 'windows-1252')
- field_separator (separator of fields, default is COMMA (","))
- line_separator (separator of lines, default is CRLF ("\r\n") (you can use special values CRLF, CR, LF instead of using the direct binary value)
- quotation_mark (default value is DOUBLE QUOTES (" "" "))
- use_quotation_mark (set to 'true' to consider the quotation mark)
|
MNBatchStartOptions
| Field |
Type |
Description |
| name |
String |
The operation name |
| idDatabase |
String |
ID of the database to use for the operation, defaults to 1 |
| addContactsToSimpleStaticGroup |
Boolean |
Flag to use to request to add every updated/inserted contact in a static audience |
| idGroup |
String |
The id of the audience to be used for the addContactsToSimpleStaticGroup option |
| emptySimpleStaticGroup |
Boolean |
Empties a static audience before repopulating it |
MNBatchStatusInfo
| Field |
Type |
Description |
| batchId |
String |
Batch operation id |
| name |
String |
|
| status |
String |
Expected values: RUNNING, FINISHED, DELETED, IDLE or ERROR |
| reportRowsSetId |
String |
|
| totalRecordCount |
int |
|
| userRequestedStop |
Boolean |
true if a user previously requested to stop the batch operation |
| info |
List of FieldValue |
|
BatchMergeValues
| Field |
Type |
| values |
List of MNContactValue |
MNDeliverabilityCluster
| Field |
Type |
| iddeliverabilitycluster |
Numeric ID of delivery cluster (use this field as value for contact field "IDDELIVERYCLUSTER" in subscribe or merge contact methods |
| name |
Logical id of delivery cluster |
| title |
Description |
MergeResult
| Field |
Type |
Description |
| ok |
Boolean |
true if the operation was successful |
| pk |
String |
Primary key value of the contact |
| idcontact |
Integer |
ID of the contact involved in the operation |
| action |
String |
Actual action which has been executed
Possible values: insert, update, delete, nothing, suspend, subscription_confirm, restore |
| errors |
List of MergeResultError |
List of errors, with type and reference to the invalid field |
| sendemail |
SendEmailResult |
Details in case of requested email delivery |
| enterworkflow |
EnterWorkflowResult |
Details in case of requested workflow operation |
| idwebtracking |
String |
WebTracking ID for the contact |
MergeResultError
| Field |
Type |
Description |
| type |
String |
Error type
Possible values: SYNTAX_ERROR, UNIQUE_CONSTRAINT_VIOLATION, EMPTY_REQUIRED_FIELD, READ_ONLY_FIELD, GENERIC_ERROR, ACTION_NOT_ALLOWED |
| field |
String |
Related field |
SendEmailResult
| Field |
Type |
Description |
| emailsent |
boolean |
|
| emailaddress |
String |
|
| idsimplemessage |
int |
|
MergeContactBodyOptions
| Field |
Type |
Description |
| denyupdatecontact |
boolean |
It prevents to update a contact |
| denysubscribenewcontact |
boolean |
It prevents to subscribe new contacts |
| denysubscribeunsubscribedcontact |
boolean |
Denies to reactivate already unsubscribed contacts |
| forceallowrestorecontactonupdate |
boolean |
It allows to reactivate a suspended or unsubscribed contact, even if 'denyupdatecontact' is set to 'true' |
| lookuprelations |
boolean |
If 'true' for every relation field, a lookup on the table is done in order to use the logical primary key value of the table instead of the integer internal key. |
| addToSimpleGroup |
int |
If not empty the contact will be added to the given audience. The id must be a valid id of a static audience in the database of the contact. If the contact is already assigned to the audience no error is reported |
| removeFromSimpleGroup |
int |
If not empty the contact will be remove from the given audience. The id must be a valid id of a static audience in the database of the contact. If the contact is not yet assigned to the audience no error is reported |
| sendemail |
boolean |
Request to send an email to the contact. It is possible to specify a template (via idtemplate) to use and/or a list of triggers (via sendemailonactions) |
| idtemplate |
int |
When sendemail is enabled, this is the ID of the template to be used for the email |
| sendemailonactions |
string |
Comma separated string of actions that will trigger email sending if sendemail is enabled.
Allowed values are: insert, update, delete, nothing, reactivate, restore, subscription_confirm, suspend |
| messageRetention |
string |
Specify a retention policy for the welcome message between:
- "minimal" - discard the message body,
- "full" - keep the whole message and headers, and
- "reserved" - discard the recipient.
|
| enterworkflow |
boolean |
Request the contact to enter a workflow |
| idworkflow |
int |
When enterworkflow is enabled, this optional field specifies the ID of the workflow to be entered by the contact. When left unspecified (0), every workflow containing the provided key will be entered. Otherwise only the specified workflow will be started |
| enterworkflowonactions |
string |
List of actions upon which a contact is going to be triggered to enter a workflow |
| key |
boolean |
ID of the entry point exploited by the contact to enter the workflow. When no workflow id is provided, every workflow containing the specified entry point will be started |
Databases
MNFieldInfo
| Field |
Type |
|
| name |
String |
|
| label |
String |
|
| dataType |
String |
TYPE_STRING = 1; TYPE_INT = 2; TYPE_BOOLEAN = 3; TYPE_ENUM = 4; TYPE_DATE = 5; TYPE_TIMESTAMP = 6; TYPE_MULTI = 7; TYPE_FLOAT = 8; TYPE_TEXT = 9;
TYPE_PHONENUMBER = 10; TYPE_EMAILADDRESS = 11; TYPE_SIMPLERELATION = 12; TYPE_SIMPLEMULTIRELATION = 13; TYPE_TIMEZONE = 14; TYPE_DELIVERYCLUSTER = 15 |
| subDataType |
String |
For all types there is the subtype SUBTYPE_GENERAL = 0;
For type TYPE_STRING: SUBTYPE_ITALIAN_CF = 100; SUBTYPE_ITALIAN_PIVA = 101; SUBTYPE_ITALIAN_CAP = 102; SUBTYPE_PASSWORD = 105;
For TYPE_PHONENUMBER: SUBTYPE_FAXNUMBER = 103; SUBTYPE_CELLNUMBER = 104;
For TYPE_ENUM and TYPE_MULTI there is the structure MNFieldOptions that describes the list of possible values (such as 'string') |
| values |
List of <String> |
|
| notNull |
Boolean |
true if the field is required for the given iddatabase |
MNFieldOptions
| Field |
Type |
|
| values |
List of <String> |
You can indicate the value and name of possible values for the fields bound (e.g. enum) |
| ids |
List of <String> |
IDs of the items of a multiple values field |
MNDatabaseInfo
| Field |
Type |
| idDatabase |
String |
| name |
String |
| creationDate |
Date |
MNAlterSchemaResult
| Field |
Type |
| errors |
MNError |
| ok |
Boolean |
Audiences
MNGroupInfo
| Field |
Type |
| idGroup |
String |
| name |
String |
| idList |
String |
Special Lists
MNList
| Field |
Type |
| idDatabase |
String |
| name |
String |
| description |
String |
| idList |
String |
| idGroup |
String |
| Field |
Type |
| idContact |
String |
| idList |
Boolean |
| idSubscriptionCause |
String |
| idSuspensionCause |
String |
| idUnsubscriptionCause |
String |
| status |
String |