Endpoint Update List Member Details
Name
update_list_member
Description
Update the settings for a specific list member. [API reference]
Related Tables
Parameters
Parameter | Required | Options | ||||||
---|---|---|---|---|---|---|---|---|
Name:
Label: List Id The ID of the list for which you like to perform this operation. |
YES | |||||||
Name:
Label: Member Id The ID of the member to update. |
YES | |||||||
Name:
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. |
|
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Id |
DT_WSTR
|
nvarchar(200)
|
200 | |
ListId |
DT_WSTR
|
nvarchar(200)
|
200 | |
EmailAddress |
DT_WSTR
|
nvarchar(200)
|
200 | |
UniqueEmailId |
DT_WSTR
|
nvarchar(200)
|
200 | |
ContactId |
DT_WSTR
|
nvarchar(200)
|
200 | |
FullName |
DT_WSTR
|
nvarchar(100)
|
100 | |
WebId |
DT_I4
|
int
|
||
EmailType |
DT_WSTR
|
nvarchar(20)
|
20 | |
Status |
DT_WSTR
|
nvarchar(20)
|
20 | |
ConsentsToOneToOneMessaging |
DT_BOOL
|
bit
|
||
FirstName |
DT_WSTR
|
nvarchar(50)
|
50 | |
LastName |
DT_WSTR
|
nvarchar(50)
|
50 | |
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 | |
StatsAvgOpenRate |
DT_I4
|
int
|
||
StatsAvgClickRate |
DT_I4
|
int
|
||
IpSignup |
DT_WSTR
|
nvarchar(200)
|
200 | |
TimestampSignup |
DT_DBTIMESTAMP
|
datetime
|
||
IpOpt |
DT_WSTR
|
nvarchar(200)
|
200 | |
TimestampOpt |
DT_DBTIMESTAMP
|
datetime
|
||
MemberRating |
DT_I4
|
int
|
||
LastChanged |
DT_DBTIMESTAMP
|
datetime
|
||
Language |
DT_WSTR
|
nvarchar(100)
|
100 | |
Vip |
DT_BOOL
|
bit
|
||
EmailClient |
DT_WSTR
|
nvarchar(200)
|
200 | |
Latitude |
DT_I4
|
int
|
||
Longitude |
DT_I4
|
int
|
||
LocationGmtOff |
DT_I4
|
int
|
||
LocationDstOff |
DT_I4
|
int
|
||
CountryCode |
DT_WSTR
|
nvarchar(100)
|
100 | |
TimeZone |
DT_WSTR
|
nvarchar(100)
|
100 | |
Region |
DT_WSTR
|
nvarchar(100)
|
100 | |
Source |
DT_WSTR
|
nvarchar(100)
|
100 | |
TagsCount |
DT_I4
|
int
|
||
Tags |
DT_WSTR
|
nvarchar(4000)
|
4000 |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
ListId |
DT_WSTR
|
nvarchar(100)
|
100 | The ID of the list for which data should be updated. |
Id |
DT_WSTR
|
nvarchar(100)
|
100 | The ID of the member for which data should be updated. |
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 | |
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. |
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 ListMembers table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to update list member details:
Required Parameters | |
---|---|
List Id | Fill-in the parameter... |
Member Id | Fill-in the parameter... |
Optional Parameters | |
Skip Merge Validation | false |
ContineOnErrorForStatusCode | True |
ErrorStatusCodeToMatchRegex | 404|405 |

ODBC application
Use these SQL queries in your ODBC application data source:
Update an existing member in the specified list/audience in your Mailchimp account
UPDATE ListMembers
SET EmailAddress='brucewayne10@mycompany.com'
, Status='subscribed' --subscribed, unsubscribed, cleaned, pending
, EmailType='text' --html, text
, Vip='false' --true
, FirstName='Bruce'
, LastName='Wayne'
/*,MergeFields= '{
"FNAME": "Bruce1",
"LNAME": "Wayne1",
"PHONE": "678-111-1234"
}',
*/
, Language='en' --fr
, TimestampOpt='2023-04-02 11:37:49'
, Latitude='38.8951' , Longitude='-77.0364' --Washington DC
, Tags='["tag1","tag2"]'
WHERE Id='e9f73ced3b649f0ca829103bcacb2846'
WITH (ListId='a4d24015f8',SkipMergeValidation='false')
update_list_member
endpoint belongs to
ListMembers
, 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:
Update an existing member in the specified list/audience in your Mailchimp account
DECLARE @MyQuery NVARCHAR(MAX) = 'UPDATE ListMembers
SET EmailAddress=''brucewayne10@mycompany.com''
, Status=''subscribed'' --subscribed, unsubscribed, cleaned, pending
, EmailType=''text'' --html, text
, Vip=''false'' --true
, FirstName=''Bruce''
, LastName=''Wayne''
/*,MergeFields= ''{
"FNAME": "Bruce1",
"LNAME": "Wayne1",
"PHONE": "678-111-1234"
}'',
*/
, Language=''en'' --fr
, TimestampOpt=''2023-04-02 11:37:49''
, Latitude=''38.8951'' , Longitude=''-77.0364'' --Washington DC
, Tags=''["tag1","tag2"]''
WHERE Id=''e9f73ced3b649f0ca829103bcacb2846''
WITH (ListId=''a4d24015f8'',SkipMergeValidation=''false'')';
EXEC (@MyQuery) AT [LS_TO_MAILCHIMP_IN_GATEWAY];
update_list_member
endpoint belongs to
ListMembers
, ListMembersBulk
table(s), and can therefore be used via those table(s).