File upload
The automated import of mailing and blocklists is simplified by using an interface to which different CRM systems can be linked. The parameters that must be configured in order to use this interface are detailed below.
Technical note
The upload is executed via HTTPS using POST in multipart/form-data encoding, with the transfer of key-value pairs. Non-secure HTTP connections are rejected.
All data is provided via the following URL:
https://webexpress.retarus.com/PicoPortal/autoLogin/listImport/
A Java sample code that presents the structure and function of the automated list import is located in the annex to this document.
Transfer parameters
Transfer parameters | Description | Conditions | Additional information |
|---|---|---|---|
j_username | The uploading user’s User ID | j_username and j_pass-word must be the first two transfer parameters (must precede dlu_file), otherwise upload will be prevented (access de-nied) | |
j_password | User ID password | ||
dlu_targetuser (optional) | The User ID indicated here becomes the owner of the list | If no dlu_targetuser is indicated, the list is uploaded for j_username | User ID for which the lists are uploaded on behalf of can optionally be entered here |
dlu_listname | Name under which the distribution list/blocklist is to be created. | If the selected list name does not exist, a new list is created. | |
dlu_listcomment (optional) | Optional comment about the list. | ||
dlu_visibility | The visibility of the list is defined here. | "user": the list is only visi-ble for the owner. | |
dlu_defaultcountrycode | The country code must al-ways be included here, e.g., + 1 or +44. | If the international country code is missing in the re-cipient column of the list (mobile phone/fax num-ber), the default code noted here is added as a prefix | |
dlu_firstrowcolumnnames | Indicates whether the first row in the distribution list contains column names. | "Enter transfer parame-ters": the first row con-tains column names | |
dlu_file | The file data is defined here. | TXT, CSV, XLS and XLSX (2007) are supported. | XLS prior to MS Office 1997 are not sup-ported. |
dlu_charset | The character coding in which CSV or TXT is coded. | If the coding is not indi-cated, automatic character coding identification is used. However, a form of coding should always be selected to prevent mistaken identification. | In the case of binary formats such as XLS, this parame-ter is irrelevant and can be omitted. |
dlu_type | What type of list is it? | "distributionlist": distribution list |
General instructions for uploading files
Users can always upload lists for themselves. A user can upload lists for other users in the same company if they have an identical or lower security level (e.g., Customer Admin for customer staff).
Individual parts of a list cannot be modified, e.g., by adding or deleting information.
If a line contains an invalid value at any point, no part of it can be imported, and the corresponding error message appears.
If a column type is detected more than once, the upload is canceled (e.g., two fax columns).
If a login is valid, the error messages appear in the language of the uploading user, otherwise they will be in English.
Multiple files must be uploaded separately.
Invalid data causes the upload to be canceled, and an error message appears.
If any required data is missing, the upload is canceled, and an error message appears.
Recipient numbers must always be entered with their country code. The country code usually must have a zero in front of it.
Recipient numbers without a country code are rejected.
Recipient numbers without a country code have dlu_defaultcountrycode added to them.
All of the list columns are always imported. Columns that do not contain "ref", "email", "fax", or "sms" become personalized columns.
Uploads cannot have a blank list name.
The Reference column is optional.
If the maximum number of columns is exceeded, the upload is canceled (there can only be a maximum of 4 media columns and 13 personalization columns). Column names cannot exceed 64 characters.