Reference

Endpoint Add New List Members in Bulk


Name

add_list_members_bulk

Description

Adds multiple members using Bulk API. [API reference]

Related Tables

ListMembersBulk

Parameters

Parameter Required Options
Name: ListId

Label: List Id

The ID of the list for which you like to perform this operation.
YES
Name: SkipMergeValidation

Label: Skip Merge Validation

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.
Option Value
true true
false false

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(100) 100
Email DT_WSTR nvarchar(255) 255
StatusCode DT_I4 int
OperationId DT_WSTR nvarchar(255) 255
ErrorTitle DT_WSTR nvarchar(4000) 4000
ErrorDetail DT_WSTR nvarchar(4000) 4000
If the column you are looking for is missing, consider customizing Mailchimp Connector.

Input Columns

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

Examples

SSIS

Use Mailchimp Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Destination

This Endpoint belongs to the ListMembersBulk table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to add new list members in bulk:

API Destination - Mailchimp
Read / write MailChimp Campaigns, Lists, Members, Reports and more in without coding.
Mailchimp
ListMembersBulk
Insert
Required Parameters
List Id Fill-in the parameter...
Optional Parameters
Skip Merge Validation false
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Bulk Add Subscibers (members) to the List from Source like MSSQL, ODBC

INSERT INTO ListMembersBulk
SOURCE('ODBC', 'DSN=MyOdbcDsn
,'select col1 as EmailAddress,col2 as FirstName, col3 as Status') --//column name alias must match with InputColumns of ListMembers
WITH(ListId='a4d24015f8')

add_list_members_bulk endpoint belongs to ListMembersBulk table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Bulk Add Subscibers (members) to the List from Source like MSSQL, ODBC

DECLARE @MyQuery NVARCHAR(MAX) = 'INSERT INTO ListMembersBulk
SOURCE(''ODBC'', ''DSN=MyOdbcDsn
,''select col1 as EmailAddress,col2 as FirstName, col3 as Status'') --//column name alias must match with InputColumns of ListMembers
WITH(ListId=''a4d24015f8'')';

EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];

add_list_members_bulk endpoint belongs to ListMembersBulk table(s), and can therefore be used via those table(s).