EndPoint Update List Details
Name
update_list
Description
Update the settings for a specific list.
[API Help]
Parameters
Parameter |
Label |
Required |
Options |
Description |
Id |
List Id |
YES |
|
The ID of the list for which data should be updated.
|
Output Columns
Label |
DataType |
Length |
Raw |
Description |
Id |
DT_WSTR |
100 |
False |
|
WebId |
DT_I4 |
0 |
False |
|
Name |
DT_WSTR |
100 |
False |
|
Company |
DT_WSTR |
500 |
False |
|
Address1 |
DT_WSTR |
500 |
False |
|
Address2 |
DT_WSTR |
500 |
False |
|
City |
DT_WSTR |
100 |
False |
|
State |
DT_WSTR |
100 |
False |
|
Zip |
DT_WSTR |
100 |
False |
|
Country |
DT_WSTR |
100 |
False |
|
Phone |
DT_WSTR |
100 |
False |
|
PermissionReminder |
DT_WSTR |
4000 |
False |
|
UseArchiveBar |
DT_BOOL |
0 |
False |
|
CampaignDefaultFromName |
DT_WSTR |
100 |
False |
|
CampaignDefaultFromEmail |
DT_WSTR |
500 |
False |
|
CampaignDefaultSubject |
DT_WSTR |
500 |
False |
|
CampaignDefaultLanguage |
DT_WSTR |
100 |
False |
|
NotifyOnSubscribe |
DT_WSTR |
500 |
False |
|
NotifyOnUnsubscribe |
DT_WSTR |
500 |
False |
|
DateCreated |
DT_DBTIMESTAMP |
0 |
False |
|
ListRating |
DT_I4 |
0 |
False |
|
EmailTypeOption |
DT_BOOL |
0 |
False |
|
SubscribeUrlShort |
DT_WSTR |
512 |
False |
|
SubscribeUrlLong |
DT_WSTR |
1024 |
False |
|
BeamerAddress |
DT_WSTR |
500 |
False |
|
Visibility |
DT_WSTR |
100 |
False |
|
DoubleOptin |
DT_BOOL |
0 |
False |
|
HasWelcome |
DT_BOOL |
0 |
False |
|
MarketingPermissions |
DT_BOOL |
0 |
False |
|
Modules |
DT_WSTR |
500 |
False |
|
MemberCount |
DT_I4 |
0 |
False |
|
UnsubscribeCount |
DT_I4 |
0 |
False |
|
CleanedCount |
DT_I4 |
0 |
False |
|
MemberCountSinceSend |
DT_I4 |
0 |
False |
|
UnsubscribeCountSinceSend |
DT_I4 |
0 |
False |
|
CleanedCountSinceSend |
DT_I4 |
0 |
False |
|
CampaignCount |
DT_I4 |
0 |
False |
|
CampaignLastSent |
DT_WSTR |
500 |
False |
|
MergeFieldCount |
DT_I4 |
0 |
False |
|
AvgSubRate |
DT_I4 |
0 |
False |
|
AvgUnsubRate |
DT_I4 |
0 |
False |
|
TargetSubRate |
DT_I4 |
0 |
False |
|
OpenRate |
DT_I4 |
0 |
False |
|
ClickRate |
DT_I4 |
0 |
False |
|
LastSubDate |
DT_DBTIMESTAMP |
0 |
False |
|
LastUnsubDate |
DT_DBTIMESTAMP |
0 |
False |
|
Input Columns
Label |
DataType |
Length |
Raw |
Description |
Name |
DT_WSTR |
200 |
False |
The name of the list. |
Company |
DT_WSTR |
200 |
False |
The company name for the list. |
Address1 |
DT_WSTR |
200 |
False |
Line 1 of the street address for the list contact. |
Address2 |
DT_WSTR |
200 |
False |
Line 2 of the street address for the list contact. |
City |
DT_WSTR |
200 |
False |
The city for the list contact. |
State |
DT_WSTR |
20 |
False |
The state for the list contact. |
Zip |
DT_WSTR |
20 |
False |
The postal or zip code for the list contact. |
Country |
DT_WSTR |
200 |
False |
A two-character ISO3166 country code. Defaults to US if invalid. |
Phone |
DT_WSTR |
30 |
False |
The phone number for the list contact. |
PermissionReminder |
DT_WSTR |
500 |
False |
The permission reminder for the list. |
UseArchiveBar |
DT_WSTR |
4000 |
True |
Whether campaigns for this list use the Archive Bar in archives by default. |
CampaignDefaultFromName |
DT_WSTR |
200 |
False |
The default from name for campaigns sent to this list. |
CampaignDefaultFromEmail |
DT_WSTR |
200 |
False |
The default from email for campaigns sent to this list. |
CampaignDefaultSubject |
DT_WSTR |
200 |
False |
The default subject line for campaigns sent to this list. |
CampaignDefaultLanguage |
DT_WSTR |
200 |
False |
The default language for this lists's forms. |
NotifyOnSubscribe |
DT_WSTR |
200 |
False |
The email address to send subscribe notifications to. |
NotifyOnUnsubscribe |
DT_WSTR |
200 |
False |
The email address to send unsubscribe notifications to. |
EmailTypeOption |
DT_WSTR |
4000 |
True |
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 |
4000 |
True |
Whether or not to require the subscriber to confirm subscription via email. |
MarketingPermissions |
DT_WSTR |
4000 |
True |
Whether or not the list has marketing permissions (eg. GDPR) enabled. |
Id |
DT_WSTR |
100 |
False |
The ID of the list for which data should be updated. |