Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Table of Contents

...

Note

Access token should be related to an authentication that is done by means of a console user that is enabled for creating filters on MailUp admin console.
If you need to use these methods using WS username (i.e. user 'a'+ consoleIdconsole ID, for example a1234) please contact us.


Method parameters

ParameterDescriptionExample
Idalways set to zero0
IdListSpecify here MailUp list ID. Use '0' (zero), if filter shall be applicable to all lists1
NameNumber that identifies console IDmyFilter
Descriptionoptional, filter description"this filter selects recipients whose name starts with S"
CategoryCategory ID. Each filter should belong to a category, IDs can be retrieved by reading from tooltips (more on this)3
Conditions[ ]

Array of conditions (at list one). Each condition is composed of the following fields:

  • Id (always set to zero)
  • IdFilter (always set to zero)
  • LogicalOperation (allowed values: None, And, Or)
  • IdPersonalDataField (Personal Data Field ID)
  • IdPersonalDataFieldType (enum value, chosen between PersonalDataFilterConditionFieldType values in WSDL (link)
  • Type (enum value, chosen between PersonalDataFilterConditionType values in WSDL (link)
  • Value (value to be checked by the filter)

If you want to filter all the recipients whose names starts with S you can use these values

  • Id=0
  • IdFilter=0
  • LogicalOperation=None
  • IdPersonalDataField=1
  • PersonalDataFieldTyp=String
  • Type=StartsWith
  • Value=S

...