Loading...
Area: Episerver Campaign
Applies to versions: Not applicable

addAll3

Adds multiple recipients to an existing recipient list in Episerver Campaign. Be aware of the different behavior of this method according to the target recipient list:

  • If a recipient is unsubscribed  and the target recipient list an opt-in list, the recipient will be re-activated with this method and the unsubscribe status will be reset.
  • If a recipient is unsubscribed and the target recipient list a regular list, the unsubscribe status will not be changed and the recipient will not receive any further emails.

This method can be replaced by the .NET replacement method addAll3Flat.

Type: int[ ]

Parameters

NameTypeValue

sessionId

String

ID of the session

recipientListId

long

ID of the recipient list

optinProcessId

long

ID of the opt-in process

The recipient will be processed with the given opt-in process identified by this ID. If no opt-in process shall be used and the recipient be activated immediately, set the value to 0.

recipientIds

String[ ]

IDs of the recipients

emailAddresses

String[ ]

Email addresses of the recipients

attributeNames

String[ ]

Defines a map of attributes in association with attributeValues

attributeValues

String[ ] [ ]

Defines a map of attributes in association with attributeNames

Example structure for attributeNames and attributeValues

$attributeNames = array('Salutation','Firstname','Lastname');
$arrayRecipient1 = array("Mr","John","Doe");
$arrayRecipient2 = array("Mrs","Jane","Doe");
$arrayRecipient3 = array("Mr","Peter","Jackson"); $attributeValues = array($arrayRecipient1 ,$arrayRecipient2 ,$arrayRecipient3 );

Return values

For each recipient:

  • 0: Recipient was added
  • 1: Recipient validation failed, e.g., due to invalid email address syntax
  • 2: Recipient is unsubscribed (applies only if the target recipient list is a regular list and no opt-in list)
  • 3: Recipient is blacklisted
  • 4: Recipient is bounce overflowed (i.e., produced too many bounces in the past)
  • 5: Recipient is already in the list
  • 6: Recipient has been filtered
  • 7: A general error occurred

Code structure

Int[] addAll3(String sessionId, long recipientListId, long optinProcessId, String[] recipientIds, String[] emailAddresses, String[] attributeNames, String[][] attributeValues) 

Last updated: Apr 25, 2018