List Import API

The Webexpress Subscriber and Opt-Out List Import API allows you to automate the import of subscriber and opt-out lists by linking your CRM system to this interface. The upload process is executed via HTTPS (POST, multipart/form-data encoding), ensuring secure data transmission. Non-secure HTTP connections are rejected.

General rules

• You can upload lists for yourself at any time. If you have the appropriate permissions, you can also upload lists for other users within your company, provided they have an equal or lower security level (e.g., a Customer Admin for customer staff).

• Individual parts of a list cannot be modified after upload. You cannot add or delete specific information from an existing list.

• If a row contains an invalid value at any point, the entire row is rejected, and an error message appears.

• If a column type is detected more than once (e.g., two fax columns), the upload is canceled, and an error message appears.

• If your login is valid, error messages appear in your preferred language. Otherwise, they are displayed in English.

• Uploads cannot have a blank list name.

• The Reference column is optional.

• All list columns are always imported. Columns that do not contain "ref", "email", "fax", or "sms" are treated as personalized columns.

• The maximum number of columns allowed is 4 media columns and 13 personalization columns. If this limit is exceeded, the upload is canceled. Column names cannot exceed 64 characters.

• Multiple files must be uploaded separately.

Handling recipient numbers

• Recipient numbers must always include a country code, usually prefixed with zero.

• Recipient numbers without a country code either have dlu_defaultcountrycode added to them or are rejected.

• If any required data is missing, the upload is canceled, and an error message appears.

Defining column types

Webexpress automatically detects special column types, such as reference IDs, email addresses, fax numbers, and mobile numbers. Recognition works in two ways:

1. Matching predefined column titles

2. Tagging column headers with specific identifiers

For automatic detection to work:

• Column headings must be specified.

• The dlu_firstrowcolumnnames option must be set to "on."

Updating existing lists

If you need to update an existing list, the following conditions must be met:

• Column names must match exactly with those in the existing list if dlu_firstrowcolumnnames is enabled. If they do not match, the upload is canceled, and an error message appears.

• The number of columns must remain the same as in the existing list.

• Column types are always inherited from the existing list.

• If you provide dlu_listcomment, the existing comments are replaced. If not, they remain unchanged.