Newsletter

NewsletterClientConfigurationCollection

object

A collection of NewsletterClientConfiguration instances.

clientsarray[object]required

A newsletter client configuration.

Show Child Parameters
Example

NewsletterClientConfigurationField

object

A newsletter client field.

formatstring

A regular expression describing the field’s value format
Example for validating a date: /^(19[0-9]{2}|2[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/

multi_valueboolean

Whether field supports multiple values or not.

namestringrequired

Name of the field.

requiredboolean

Whether field is required or not.

Example

NewsletterProfile

object

Xcampaign newsletter profile.

emailstringrequired
fieldsobject

Profile fields (such as email address, first name, last name, etc).

* Additional properties are allowed.
idintegerrequired
statusstringrequired
Example