Mailchimp Connector
Documentation
Version: 1
Documentation
Home » API Integration Hub » Mailchimp Connector » EndPoints > Get List of Campaigns

EndPoint Get List of Campaigns

Name

get_campaigns

Description

Get all campaigns in an account. [API Help]

Parameters

Parameter Label Required Options Description
type Campaign type NO
Option Value
regular regular
plaintext plaintext
absplit absplit
rss rss
variate variate
The campaign type. Possible values: regular, plaintext, absplit, rss, or variate.
status Status of the campaign NO
Option Value
save save
paused paused
schedule schedule
sending sending
sent sent
The status of the campaign. Possible values: save, paused, schedule, sending, or sent.
before_send_time Campaign sent before (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_send_time Campaign sent after (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
before_create_time Campaign created before (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
since_create_time Campaign created after (Format: 2015-10-21T15:41:36) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
list_id Using list Id NO The unique id for the list.
folder_id Using folder Id NO The unique folder id.
member_id To customer NO Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address.

Output Columns

Label DataType Length Raw Description
Id DT_WSTR 100 False
WebId DT_I4 0 False
Type DT_WSTR 100 False
CreateTime DT_DBTIMESTAMP 0 False
ArchiveUrl DT_WSTR 500 False
LongArchiveUrl DT_WSTR 1024 False
Status DT_WSTR 100 False
EmailsSent DT_I4 0 False
SendTime DT_WSTR 500 False
ContentType DT_WSTR 100 False
NeedsBlockRefresh DT_BOOL 0 False
Resendable DT_BOOL 0 False
RecipientsListId DT_WSTR 100 False
RecipientsListIsActive DT_BOOL 0 False
RecipientsListName DT_WSTR 500 False
RecipientsSegmentText DT_WSTR 4000 False
RecipientsRecipientCount DT_I4 0 False
SettingsSubjectLine DT_WSTR 1000 False
SettingsTitle DT_WSTR 1000 False
SettingsFromName DT_WSTR 500 False
SettingsReplyTo DT_WSTR 500 False
SettingsUseConversation DT_BOOL 0 False
SettingsToName DT_WSTR 500 False
SettingsFolderId DT_WSTR 500 False
SettingsAuthenticate DT_BOOL 0 False
SettingsAutoFooter DT_BOOL 0 False
SettingsInlineCss DT_BOOL 0 False
SettingsAutoTweet DT_BOOL 0 False
SettingsFbComments DT_BOOL 0 False
SettingsTimeWarp DT_BOOL 0 False
SettingsTemplateId DT_I4 0 False
SettingsDragAndDrop DT_BOOL 0 False
TrackingOpens DT_BOOL 0 False
TrackingHtmlClicks DT_BOOL 0 False
TrackingTextClicks DT_BOOL 0 False
TrackingGoalTracking DT_BOOL 0 False
TrackingEcomm360 DT_BOOL 0 False
TrackingGoogleAnalytics DT_WSTR 4000 False
TrackingClicktale DT_WSTR 4000 False
DeliveryStatusEnabled DT_BOOL 0 False

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.