Endpoint Update List Details
Name
update_list
Description
Update the settings for a specific list. [API reference]
Related Tables
Parameters
Parameter | Required | Options |
---|---|---|
Name:
Label: List Id The ID of the list for which data should be updated. |
YES |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(100)
|
100 | |
WebId |
DT_I4
|
int
|
||
Name |
DT_WSTR
|
nvarchar(100)
|
100 | |
Company |
DT_WSTR
|
nvarchar(500)
|
500 | |
Address1 |
DT_WSTR
|
nvarchar(500)
|
500 | |
Address2 |
DT_WSTR
|
nvarchar(500)
|
500 | |
City |
DT_WSTR
|
nvarchar(100)
|
100 | |
State |
DT_WSTR
|
nvarchar(100)
|
100 | |
Zip |
DT_WSTR
|
nvarchar(100)
|
100 | |
Country |
DT_WSTR
|
nvarchar(100)
|
100 | |
Phone |
DT_WSTR
|
nvarchar(100)
|
100 | |
PermissionReminder |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
UseArchiveBar |
DT_BOOL
|
bit
|
||
CampaignDefaultFromName |
DT_WSTR
|
nvarchar(100)
|
100 | |
CampaignDefaultFromEmail |
DT_WSTR
|
nvarchar(500)
|
500 | |
CampaignDefaultSubject |
DT_WSTR
|
nvarchar(500)
|
500 | |
CampaignDefaultLanguage |
DT_WSTR
|
nvarchar(100)
|
100 | |
NotifyOnSubscribe |
DT_WSTR
|
nvarchar(500)
|
500 | |
NotifyOnUnsubscribe |
DT_WSTR
|
nvarchar(500)
|
500 | |
DateCreated |
DT_DBTIMESTAMP
|
datetime
|
||
ListRating |
DT_I4
|
int
|
||
EmailTypeOption |
DT_BOOL
|
bit
|
||
SubscribeUrlShort |
DT_WSTR
|
nvarchar(512)
|
512 | |
SubscribeUrlLong |
DT_WSTR
|
nvarchar(1024)
|
1024 | |
BeamerAddress |
DT_WSTR
|
nvarchar(500)
|
500 | |
Visibility |
DT_WSTR
|
nvarchar(100)
|
100 | |
DoubleOptin |
DT_BOOL
|
bit
|
||
HasWelcome |
DT_BOOL
|
bit
|
||
MarketingPermissions |
DT_BOOL
|
bit
|
||
Modules |
DT_WSTR
|
nvarchar(500)
|
500 | |
MemberCount |
DT_I4
|
int
|
||
UnsubscribeCount |
DT_I4
|
int
|
||
CleanedCount |
DT_I4
|
int
|
||
MemberCountSinceSend |
DT_I4
|
int
|
||
UnsubscribeCountSinceSend |
DT_I4
|
int
|
||
CleanedCountSinceSend |
DT_I4
|
int
|
||
CampaignCount |
DT_I4
|
int
|
||
CampaignLastSent |
DT_WSTR
|
nvarchar(500)
|
500 | |
MergeFieldCount |
DT_I4
|
int
|
||
AvgSubRate |
DT_I4
|
int
|
||
AvgUnsubRate |
DT_I4
|
int
|
||
TargetSubRate |
DT_I4
|
int
|
||
OpenRate |
DT_I4
|
int
|
||
ClickRate |
DT_I4
|
int
|
||
LastSubDate |
DT_DBTIMESTAMP
|
datetime
|
||
LastUnsubDate |
DT_DBTIMESTAMP
|
datetime
|
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(100)
|
100 | The ID of the list for which data should be updated. |
Name |
DT_WSTR
|
nvarchar(200)
|
200 | The name of the list. |
Company |
DT_WSTR
|
nvarchar(200)
|
200 | The company name for the list. |
Address1 |
DT_WSTR
|
nvarchar(200)
|
200 | Line 1 of the street address for the list contact. |
Address2 |
DT_WSTR
|
nvarchar(200)
|
200 | Line 2 of the street address for the list contact. |
City |
DT_WSTR
|
nvarchar(200)
|
200 | The city for the list contact. |
State |
DT_WSTR
|
nvarchar(20)
|
20 | The state for the list contact. |
Zip |
DT_WSTR
|
nvarchar(20)
|
20 | The postal or zip code for the list contact. |
Country |
DT_WSTR
|
nvarchar(200)
|
200 | A two-character ISO3166 country code. Defaults to US if invalid. |
Phone |
DT_WSTR
|
nvarchar(30)
|
30 | The phone number for the list contact. |
PermissionReminder |
DT_WSTR
|
nvarchar(500)
|
500 | The permission reminder for the list. |
UseArchiveBar |
DT_WSTR
|
nvarchar(4000)
|
4000 | Whether campaigns for this list use the Archive Bar in archives by default. |
CampaignDefaultFromName |
DT_WSTR
|
nvarchar(200)
|
200 | The default from name for campaigns sent to this list. |
CampaignDefaultFromEmail |
DT_WSTR
|
nvarchar(200)
|
200 | The default from email for campaigns sent to this list. |
CampaignDefaultSubject |
DT_WSTR
|
nvarchar(200)
|
200 | The default subject line for campaigns sent to this list. |
CampaignDefaultLanguage |
DT_WSTR
|
nvarchar(200)
|
200 | The default language for this lists's forms. |
NotifyOnSubscribe |
DT_WSTR
|
nvarchar(200)
|
200 | The email address to send subscribe notifications to. |
NotifyOnUnsubscribe |
DT_WSTR
|
nvarchar(200)
|
200 | The email address to send unsubscribe notifications to. |
EmailTypeOption |
DT_WSTR
|
nvarchar(4000)
|
4000 | Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup. |
DoubleOptin |
DT_WSTR
|
nvarchar(4000)
|
4000 | Whether or not to require the subscriber to confirm subscription via email. |
MarketingPermissions |
DT_WSTR
|
nvarchar(4000)
|
4000 | Whether or not the list has marketing permissions (eg. GDPR) enabled. |
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 Lists table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to update list details:
Required Parameters | |
---|---|
List Id | Fill-in the parameter... |

ODBC application
Use these SQL queries in your ODBC application data source:
Update details of a list/audience in your Mailchimp account (Update Mail Footer Address for SPAM compliance)
UPDATE Lists SET Address1='123 Main Street', Address2 = 'Suite 52', City = 'Chicago'
WHERE Id='e246f7e24d'
update_list
endpoint belongs to
Lists
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:
Update details of a list/audience in your Mailchimp account (Update Mail Footer Address for SPAM compliance)
DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE Lists SET Address1=''123 Main Street'', Address2 = ''Suite 52'', City = ''Chicago''
WHERE Id=''e246f7e24d''';
EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];
update_list
endpoint belongs to
Lists
table(s), and can therefore be used via those table(s).