PARAMETRI RICHIESTA

Parametro Tipo di dato Richiesto Definizione
SessionID string Session ID which is needed to authenticate the access. It's optional and required for desktop applications only
Command string The API Command sended to the console
ResponseFormat JSON | XML 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
SubscriberListID integer Unique ID of subscriber list
PresetName string

{Gender | Age | Employment | Income | Education | Days of the week | Months of the year | U.S. states | Continents | Satisfaction | Importance | Agreement | Comparison}

You can create a new custom field by selecting a preset. This way all options of the preset will be created by backend.

FieldName string The name of new custom field
FieldType string

{Single line | Paragraph text | Multiple choice | Drop down | Checkboxes | Hidden field}

The type of the custom field

FieldDefaultValue string Default value of the custom field
OptionLabel[n] string Label of nth option
OptionValue[n] string Value of nth option
OptionSelected array An array of selected option ids (Option ids are n)
ValidationMethod string

{Disabled | Numbers | Letters | Numbers and letters | Email address | URL | Date | Time | Custom}

Validation method of the custom field

ValidationRule string Validation rule of the custom field
Visibility string

{Public | User Only}

Whether to show custom field in subscriber area or not

IsRequired string

{Yes | No}

Whether to make the custom field mandatory to fill in or not

IsUnique string

{Yes | No}

Whether to force custom field entry to be unique or not

IsGlobal string

{Yes | No}

/If this parameter is set to 'Yes', custom field will be valid for all lists in the user account

PARAMETRI DI RISPOSTA

Parametro Tipo di dato Definizione
Success bool States if an error has been generated during last command execution or not
ErrorCode integer The ErrorCode number, if an error has occurred. ErrorCode = 0 means no error has occurred.
CustomFieldID integer ID of the new custom field

CODICI DI ERRORE

Codice Definizione
1 Subscriber list id is missing
2 Field name is missing
3 Field type is missing
4 Validation rule is missing
5 Invalid custom field preset name
99998 Authentication failure or session expired
99999 Not enough privileges