EndPoint Add or Update Upsert List Members (Bulk Subscribe or Unsubscribe)

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

Name

upsert_list_members

Description

Add or Update Upsert List Members (Bulk Subscribe or Unsubscribe). [API reference]

Parameters

Parameter

Label

Required

Options

Description

ListId

List Id

YES

The ID of the list for which you like to perform this operation.

SkipMergeValidation

Skip Merge Validation

Option	Value
true	true
false	false

If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.

SkipDuplicateCheck

Skip Duplicate Check

Option	Value
true	true
false	false

If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false.

UpdateExisting

Update Exising Subscription Status?

Option	Value
true	true
false	false

Whether this batch operation will change existing members' subscription status.

SyncTags

Sync Tags

Option	Value
true	true
false	false

Whether this batch operation will replace all existing tags with tags in request.

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_WSTR`	`nvarchar(200)`	200	False
ListId	`DT_WSTR`	`nvarchar(200)`	200	False
EmailAddress	`DT_WSTR`	`nvarchar(200)`	200	False
UniqueEmailId	`DT_WSTR`	`nvarchar(200)`	200	False
ContactId	`DT_WSTR`	`nvarchar(200)`	200	False
FullName	`DT_WSTR`	`nvarchar(100)`	100	False
WebId	`DT_I4`	`int`		False
EmailType	`DT_WSTR`	`nvarchar(20)`	20	False
Status	`DT_WSTR`	`nvarchar(20)`	20	False
ConsentsToOneToOneMessaging	`DT_BOOL`	`bit`		False
FirstName	`DT_WSTR`	`nvarchar(50)`	50	False
LastName	`DT_WSTR`	`nvarchar(50)`	50	False
AddressLine1	`DT_WSTR`	`nvarchar(200)`	200	False
AddressLine2	`DT_WSTR`	`nvarchar(200)`	200	False
City	`DT_WSTR`	`nvarchar(200)`	200	False
State	`DT_WSTR`	`nvarchar(100)`	100	False
Zip	`DT_WSTR`	`nvarchar(20)`	20	False
Country	`DT_WSTR`	`nvarchar(100)`	100	False
Phone	`DT_WSTR`	`nvarchar(50)`	50	False
Birthday	`DT_WSTR`	`nvarchar(50)`	50	False
StatsAvgOpenRate	`DT_I4`	`int`		False
StatsAvgClickRate	`DT_I4`	`int`		False
IpSignup	`DT_WSTR`	`nvarchar(200)`	200	False
TimestampSignup	`DT_DBTIMESTAMP`	`datetime`		False
IpOpt	`DT_WSTR`	`nvarchar(200)`	200	False
TimestampOpt	`DT_DBTIMESTAMP`	`datetime`		False
MemberRating	`DT_I4`	`int`		False
LastChanged	`DT_DBTIMESTAMP`	`datetime`		False
Language	`DT_WSTR`	`nvarchar(100)`	100	False
Vip	`DT_BOOL`	`bit`		False
EmailClient	`DT_WSTR`	`nvarchar(200)`	200	False
Latitude	`DT_I4`	`int`		False
Longitude	`DT_I4`	`int`		False
LocationGmtOff	`DT_I4`	`int`		False
LocationDstOff	`DT_I4`	`int`		False
CountryCode	`DT_WSTR`	`nvarchar(100)`	100	False
TimeZone	`DT_WSTR`	`nvarchar(100)`	100	False
Region	`DT_WSTR`	`nvarchar(100)`	100	False
Source	`DT_WSTR`	`nvarchar(100)`	100	False
TagsCount	`DT_I4`	`int`		False
Tags	`DT_WSTR`	`nvarchar(4000)`	4000	False
RowStatus	`DT_WSTR`	`nvarchar(50)`	50	False
TotalCreated	`DT_I4`	`int`		False
TotalUpdated	`DT_I4`	`int`		False
ErrorCount	`DT_I4`	`int`		False
ErrorMessage	`DT_WSTR`	`nvarchar(4000)`	4000	False
ErrorCode	`DT_WSTR`	`nvarchar(255)`	255	False
ErrorField	`DT_WSTR`	`nvarchar(255)`	255	False
ErrorFieldMessage	`DT_WSTR`	`nvarchar(4000)`	4000	False

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
EmailAddress	`DT_WSTR`	`nvarchar(200)`	200	False
Status	`DT_WSTR`	`nvarchar(80)`	80	False	Subscriber's current status. Possible values: subscribed, unsubscribed, cleaned, pending, or transactional.
EmailType	`DT_WSTR`	`nvarchar(20)`	20	False	Type of email this member asked to get ('html' or 'text').
FirstName	`DT_WSTR`	`nvarchar(255)`	255	False
LastName	`DT_WSTR`	`nvarchar(255)`	255	False
AddressLine1	`DT_WSTR`	`nvarchar(200)`	200	False
AddressLine2	`DT_WSTR`	`nvarchar(200)`	200	False
City	`DT_WSTR`	`nvarchar(200)`	200	False
State	`DT_WSTR`	`nvarchar(100)`	100	False
Zip	`DT_WSTR`	`nvarchar(20)`	20	False
Country	`DT_WSTR`	`nvarchar(100)`	100	False
Phone	`DT_WSTR`	`nvarchar(50)`	50	False
Birthday	`DT_WSTR`	`nvarchar(50)`	50	False
MergeFields	`DT_WSTR`	`nvarchar(4000)`	4000	True	A dictionary of merge fields where the keys are the merge tags.
Interests	`DT_WSTR`	`nvarchar(4000)`	4000	True	The key of this object's properties is the ID of the interest in question.
Language	`DT_WSTR`	`nvarchar(10)`	10	False	If set/detected, the subscriber's language.
Vip	`DT_BOOL`	`bit`		False	VIP status for subscriber.
Latitude	`DT_WSTR`	`nvarchar(4000)`	4000	False	The location latitude.
Longitude	`DT_WSTR`	`nvarchar(4000)`	4000	False	The location longitude.
MarketingPermissions	`DT_WSTR`	`nvarchar(4000)`	4000	True	The marketing permissions for the subscriber.
IpSignup	`DT_WSTR`	`nvarchar(200)`	200	False	IP address the subscriber signed up from.
TimestampSignup	`DT_DBTIMESTAMP`	`datetime`		False	The date and time the subscriber signed up for the list in ISO 8601 format.
IpOpt	`DT_WSTR`	`nvarchar(200)`	200	False	The IP address the subscriber used to confirm their opt-in status.
TimestampOpt	`DT_DBTIMESTAMP`	`datetime`		False	The date and time the subscriber confirmed their opt-in status in ISO 8601 format.
Tags	`DT_WSTR`	`nvarchar(4000)`	4000	True	The tags that are associated with a member.

Required columns that you need to supply are bolded.