Module mailchimp.marketing
ballerinax/mailchimp.marketing Ballerina library
1.0.0
Overview
Mailchimp Marketing Email is a powerful and user-friendly platform provided by Intuit Mailchimp, designed for creating, managing, and optimizing targeted email campaigns. It enables businesses to engage customers with personalized marketing emails, automated workflows, and insightful analytics to drive growth and build lasting relationships.
The ballerinax/mailchimp.marketing package provides APIs to connect and interact with the Mailchimp Marketing API v3.0.85, enabling seamless integration with applications to manage marketing email sending, templates, messages, and more.
Setup guide
To use the Mailchimp Marketing Email connector, you need to have a Mailchimp account and access to a API key. Follow the steps below to set up your account and generate the required API key.
Step 1: Create a Mailchimp Account
-
Go to the Mailchimp Sign Up Page and create a Mailchimp account.
-
Once signed in, click on your profile icon in the bottom-left corner to access the account menu.
Step 2: Generate a API Key
-
In the menu, go to Extras section and click on API keys.
-
Choose Create A Key (not the Mandril API key). You will be redirected to the API Key Generate Dashboard.
-
In the API Key dashboard, add a API key name and click Generate Key to generate your key.
-
Copy the generated API key. You will need this to authenticate your connector.
Quickstart
To use the Mailchimp Marketing connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the mailchimp.marketing module.
import ballerinax/mailchimp.marketing;
Step 2: Configure the API Key
Create a Config.toml file and add your API key obtained from the setup process:
mailchimpApiKey = "<your-mailchimp-marketing-access-token>"
Step 3: Run the Ballerina application
bal run
Examples
The MailChimp Marketing Emails connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Add Mailchimp Subscriber – Add a new subscriber to a specific Mailchimp audience list.
- List Mailchimp Audiences – Fetch and display a list of all your Mailchimp audience lists.
Clients
mailchimp.marketing: Client
Isolated
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://server.api.mailchimp.com/3.0" - URL of the target service
get .
Isolated FunctionResource Function
List api root resources
Parameters
- queries *GetRootQueries - Queries to be sent with the request
get activity-feed/chimp-chatter
Isolated FunctionResource Function
function get activity\-feed/chimp\-chatter(map<string|string[]> headers, *GetActivityFeedChimpChatterQueries queries) returns InlineResponse200|errorGet latest chimp chatter
Parameters
- queries *GetActivityFeedChimpChatterQueries - Queries to be sent with the request
Return Type
- InlineResponse200|error - ChimpChatter Collection
get account-exports
Isolated FunctionResource Function
function get account\-exports(map<string|string[]> headers, *GetAccountExportsQueries queries) returns InlineResponse2001|errorList account exports
Parameters
- queries *GetAccountExportsQueries - Queries to be sent with the request
post account-exports
Isolated FunctionResource Function
function post account\-exports(CreateAnAccountExport payload, map<string|string[]> headers) returns InlineResponse2002|errorAdd export
Parameters
- payload CreateAnAccountExport -
get account-exports/[string exportId]
Isolated FunctionResource Function
function get account\-exports/[string exportId](map<string|string[]> headers, *GetAccountExportIdQueries queries) returns InlineResponse2002|errorGet account export info
Parameters
- queries *GetAccountExportIdQueries - Queries to be sent with the request
get authorized-apps
Isolated FunctionResource Function
function get authorized\-apps(map<string|string[]> headers, *GetAuthorizedAppsQueries queries) returns InlineResponse2003|errorList authorized apps
Parameters
- queries *GetAuthorizedAppsQueries - Queries to be sent with the request
get authorized-apps/[string appId]
Isolated FunctionResource Function
function get authorized\-apps/[string appId](map<string|string[]> headers, *GetAuthorizedAppsIdQueries queries) returns InlineResponse2004|errorGet authorized app info
Parameters
- queries *GetAuthorizedAppsIdQueries - Queries to be sent with the request
get automations
Isolated FunctionResource Function
function get automations(map<string|string[]> headers, *GetAutomationsQueries queries) returns InlineResponse2005|errorList automations
Parameters
- queries *GetAutomationsQueries - Queries to be sent with the request
post automations
Isolated FunctionResource Function
function post automations(AutomationWorkflow payload, map<string|string[]> headers) returns AutomationWorkflow1|errorAdd automation
Parameters
- payload AutomationWorkflow -
get automations/[string workflowId]
Isolated FunctionResource Function
function get automations/[string workflowId](map<string|string[]> headers, *GetAutomationsIdQueries queries) returns AutomationWorkflow1|errorGet automation info
Parameters
- queries *GetAutomationsIdQueries - Queries to be sent with the request
post automations/[string workflowId]/actions/pause-all-emails
Isolated FunctionResource Function
function post automations/[string workflowId]/actions/pause\-all\-emails(map<string|string[]> headers) returns error?Pause automation emails
Return Type
- error? - Empty Response
post automations/[string workflowId]/actions/start-all-emails
Isolated FunctionResource Function
function post automations/[string workflowId]/actions/start\-all\-emails(map<string|string[]> headers) returns error?Start automation emails
Return Type
- error? - Empty Response
post automations/[string workflowId]/actions/archive
Isolated FunctionResource Function
function post automations/[string workflowId]/actions/archive(map<string|string[]> headers) returns error?Archive automation
Return Type
- error? - Empty Response
get automations/[string workflowId]/emails
Isolated FunctionResource Function
function get automations/[string workflowId]/emails(map<string|string[]> headers) returns AutomationEmails|errorList automated emails
get automations/[string workflowId]/emails/[string workflowEmailId]
Isolated FunctionResource Function
function get automations/[string workflowId]/emails/[string workflowEmailId](map<string|string[]> headers) returns AutomationWorkflowEmail|errorGet workflow email info
delete automations/[string workflowId]/emails/[string workflowEmailId]
Isolated FunctionResource Function
function delete automations/[string workflowId]/emails/[string workflowEmailId](map<string|string[]> headers) returns error?Delete workflow email
Return Type
- error? - Empty Response
patch automations/[string workflowId]/emails/[string workflowEmailId]
Isolated FunctionResource Function
function patch automations/[string workflowId]/emails/[string workflowEmailId](UpdateInformationAboutASpecificWorkflowEmail payload, map<string|string[]> headers) returns AutomationWorkflowEmail|errorUpdate workflow email
Parameters
get automations/[string workflowId]/emails/[string workflowEmailId]/queue
Isolated FunctionResource Function
function get automations/[string workflowId]/emails/[string workflowEmailId]/queue(map<string|string[]> headers) returns InlineResponse2006|errorList automated email subscribers
post automations/[string workflowId]/emails/[string workflowEmailId]/queue
Isolated FunctionResource Function
function post automations/[string workflowId]/emails/[string workflowEmailId]/queue(SubscriberInAutomationQueue payload, map<string|string[]> headers) returns SubscriberInAutomationQueue1|errorAdd subscriber to workflow email
Parameters
- payload SubscriberInAutomationQueue -
get automations/[string workflowId]/emails/[string workflowEmailId]/queue/[string subscriberHash]
Isolated FunctionResource Function
function get automations/[string workflowId]/emails/[string workflowEmailId]/queue/[string subscriberHash](map<string|string[]> headers) returns SubscriberInAutomationQueue1|errorGet automated email subscriber
post automations/[string workflowId]/emails/[string workflowEmailId]/actions/pause
Isolated FunctionResource Function
function post automations/[string workflowId]/emails/[string workflowEmailId]/actions/pause(map<string|string[]> headers) returns error?Pause automated email
Return Type
- error? - Empty Response
post automations/[string workflowId]/emails/[string workflowEmailId]/actions/'start
Isolated FunctionResource Function
function post automations/[string workflowId]/emails/[string workflowEmailId]/actions/'start(map<string|string[]> headers) returns error?Start automated email
Return Type
- error? - Empty Response
get automations/[string workflowId]/removed-subscribers
Isolated FunctionResource Function
function get automations/[string workflowId]/removed\-subscribers(map<string|string[]> headers) returns RemovedSubscribers|errorList subscribers removed from workflow
post automations/[string workflowId]/removed-subscribers
Isolated FunctionResource Function
function post automations/[string workflowId]/removed\-subscribers(SubscriberInAutomationQueue payload, map<string|string[]> headers) returns SubscriberRemovedFromAutomationWorkflow|errorRemove subscriber from workflow
Parameters
- payload SubscriberInAutomationQueue -
get automations/[string workflowId]/removed-subscribers/[string subscriberHash]
Isolated FunctionResource Function
function get automations/[string workflowId]/removed\-subscribers/[string subscriberHash](map<string|string[]> headers) returns SubscriberRemovedFromAutomationWorkflow|errorGet subscriber removed from workflow
get batches
Isolated FunctionResource Function
function get batches(map<string|string[]> headers, *GetBatchesQueries queries) returns BatchOperations|errorList batch requests
Parameters
- queries *GetBatchesQueries - Queries to be sent with the request
post batches
Isolated FunctionResource Function
Start batch operation
Parameters
- payload BatchesBody -
get batches/[string batchId]
Isolated FunctionResource Function
function get batches/[string batchId](map<string|string[]> headers, *GetBatchesIdQueries queries) returns Batch|errorGet batch operation status
Parameters
- queries *GetBatchesIdQueries - Queries to be sent with the request
delete batches/[string batchId]
Isolated FunctionResource Function
Delete batch request
Return Type
- error? - Empty Response
get batch-webhooks
Isolated FunctionResource Function
function get batch\-webhooks(map<string|string[]> headers, *GetBatchWebhooksQueries queries) returns BatchWebhooks|errorList batch webhooks
Parameters
- queries *GetBatchWebhooksQueries - Queries to be sent with the request
post batch-webhooks
Isolated FunctionResource Function
function post batch\-webhooks(BatchWebhook payload, map<string|string[]> headers) returns BatchWebhook1|errorAdd batch webhook
Parameters
- payload BatchWebhook -
get batch-webhooks/[string batchWebhookId]
Isolated FunctionResource Function
function get batch\-webhooks/[string batchWebhookId](map<string|string[]> headers, *GetBatchWebhookQueries queries) returns BatchWebhook1|errorGet batch webhook info
Parameters
- queries *GetBatchWebhookQueries - Queries to be sent with the request
delete batch-webhooks/[string batchWebhookId]
Isolated FunctionResource Function
function delete batch\-webhooks/[string batchWebhookId](map<string|string[]> headers) returns error?Delete batch webhook
Return Type
- error? - Empty Response
patch batch-webhooks/[string batchWebhookId]
Isolated FunctionResource Function
function patch batch\-webhooks/[string batchWebhookId](BatchWebhook2 payload, map<string|string[]> headers) returns BatchWebhook1|errorUpdate batch webhook
Parameters
- payload BatchWebhook2 -
get template-folders
Isolated FunctionResource Function
function get template\-folders(map<string|string[]> headers, *GetTemplateFoldersQueries queries) returns TemplateFolders|errorList template folders
Parameters
- queries *GetTemplateFoldersQueries - Queries to be sent with the request
post template-folders
Isolated FunctionResource Function
function post template\-folders(TemplateFolder payload, map<string|string[]> headers) returns TemplateFolder1|errorAdd template folder
Parameters
- payload TemplateFolder -
get template-folders/[string folderId]
Isolated FunctionResource Function
function get template\-folders/[string folderId](map<string|string[]> headers, *GetTemplateFoldersIdQueries queries) returns TemplateFolder1|errorGet template folder
Parameters
- queries *GetTemplateFoldersIdQueries - Queries to be sent with the request
delete template-folders/[string folderId]
Isolated FunctionResource Function
Delete template folder
Return Type
- error? - Empty Response
patch template-folders/[string folderId]
Isolated FunctionResource Function
function patch template\-folders/[string folderId](TemplateFolder payload, map<string|string[]> headers) returns TemplateFolder1|errorUpdate template folder
Parameters
- payload TemplateFolder -
get campaign-folders
Isolated FunctionResource Function
function get campaign\-folders(map<string|string[]> headers, *GetCampaignFoldersQueries queries) returns CampaignFolders|errorList campaign folders
Parameters
- queries *GetCampaignFoldersQueries - Queries to be sent with the request
post campaign-folders
Isolated FunctionResource Function
function post campaign\-folders(CampaignFolder payload, map<string|string[]> headers) returns CampaignFolder1|errorAdd campaign folder
Parameters
- payload CampaignFolder -
get campaign-folders/[string folderId]
Isolated FunctionResource Function
function get campaign\-folders/[string folderId](map<string|string[]> headers, *GetCampaignFoldersIdQueries queries) returns CampaignFolder1|errorGet campaign folder
Parameters
- queries *GetCampaignFoldersIdQueries - Queries to be sent with the request
delete campaign-folders/[string folderId]
Isolated FunctionResource Function
Delete campaign folder
Return Type
- error? - Empty Response
patch campaign-folders/[string folderId]
Isolated FunctionResource Function
function patch campaign\-folders/[string folderId](CampaignFolder payload, map<string|string[]> headers) returns CampaignFolder1|errorUpdate campaign folder
Parameters
- payload CampaignFolder -
get campaigns
Isolated FunctionResource Function
function get campaigns(map<string|string[]> headers, *GetCampaignsQueries queries) returns InlineResponse2007|errorList campaigns
Parameters
- queries *GetCampaignsQueries - Queries to be sent with the request
post campaigns
Isolated FunctionResource Function
Add campaign
Parameters
- payload Campaign -
get campaigns/[string campaignId]
Isolated FunctionResource Function
function get campaigns/[string campaignId](map<string|string[]> headers, *GetCampaignsIdQueries queries) returns Campaign1|errorGet campaign info
Parameters
- queries *GetCampaignsIdQueries - Queries to be sent with the request
delete campaigns/[string campaignId]
Isolated FunctionResource Function
Delete campaign
Return Type
- error? - Empty Response
patch campaigns/[string campaignId]
Isolated FunctionResource Function
function patch campaigns/[string campaignId](Campaign2 payload, map<string|string[]> headers) returns Campaign1|errorUpdate campaign settings
Parameters
- payload Campaign2 -
post campaigns/[string campaignId]/actions/cancel-send
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/cancel\-send(map<string|string[]> headers) returns error?Cancel campaign
Return Type
- error? - Empty Response
post campaigns/[string campaignId]/actions/replicate
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/replicate(map<string|string[]> headers) returns Campaign3|errorReplicate campaign
post campaigns/[string campaignId]/actions/send
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/send(map<string|string[]> headers) returns error?Send campaign
Return Type
- error? - Empty Response
post campaigns/[string campaignId]/actions/schedule
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/schedule(ActionsScheduleBody payload, map<string|string[]> headers) returns error?Schedule campaign
Parameters
- payload ActionsScheduleBody -
Return Type
- error? - Empty Response
post campaigns/[string campaignId]/actions/unschedule
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/unschedule(map<string|string[]> headers) returns error?Unschedule campaign
Return Type
- error? - Empty Response
post campaigns/[string campaignId]/actions/test
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/test(ActionsTestBody payload, map<string|string[]> headers) returns error?Send test email
Parameters
- payload ActionsTestBody -
Return Type
- error? - Empty Response
post campaigns/[string campaignId]/actions/pause
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/pause(map<string|string[]> headers) returns error?Pause rss campaign
Return Type
- error? - Empty Response
post campaigns/[string campaignId]/actions/resume
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/resume(map<string|string[]> headers) returns error?Resume rss campaign
Return Type
- error? - Empty Response
post campaigns/[string campaignId]/actions/create-resend
Isolated FunctionResource Function
function post campaigns/[string campaignId]/actions/create\-resend(ActionsCreateResendBody payload, map<string|string[]> headers) returns Campaign3|errorResend campaign
Parameters
- payload ActionsCreateResendBody -
get campaigns/[string campaignId]/content
Isolated FunctionResource Function
function get campaigns/[string campaignId]/content(map<string|string[]> headers, *GetCampaignsIdContentQueries queries) returns CampaignContent|errorGet campaign content
Parameters
- queries *GetCampaignsIdContentQueries - Queries to be sent with the request
put campaigns/[string campaignId]/content
Isolated FunctionResource Function
function put campaigns/[string campaignId]/content(CampaignContent1 payload, map<string|string[]> headers) returns CampaignContent|errorSet campaign content
Parameters
- payload CampaignContent1 -
get campaigns/[string campaignId]/feedback
Isolated FunctionResource Function
function get campaigns/[string campaignId]/feedback(map<string|string[]> headers, *GetCampaignsIdFeedbackQueries queries) returns CampaignReports|errorList campaign feedback
Parameters
- queries *GetCampaignsIdFeedbackQueries - Queries to be sent with the request
post campaigns/[string campaignId]/feedback
Isolated FunctionResource Function
function post campaigns/[string campaignId]/feedback(CampaignFeedback payload, map<string|string[]> headers) returns CampaignFeedback1|errorAdd campaign feedback
Parameters
- payload CampaignFeedback -
get campaigns/[string campaignId]/feedback/[string feedbackId]
Isolated FunctionResource Function
function get campaigns/[string campaignId]/feedback/[string feedbackId](map<string|string[]> headers, *GetCampaignsIdFeedbackIdQueries queries) returns CampaignFeedback1|errorGet campaign feedback message
Parameters
- queries *GetCampaignsIdFeedbackIdQueries - Queries to be sent with the request
delete campaigns/[string campaignId]/feedback/[string feedbackId]
Isolated FunctionResource Function
function delete campaigns/[string campaignId]/feedback/[string feedbackId](map<string|string[]> headers) returns error?Delete campaign feedback message
Return Type
- error? - Empty Response
patch campaigns/[string campaignId]/feedback/[string feedbackId]
Isolated FunctionResource Function
function patch campaigns/[string campaignId]/feedback/[string feedbackId](CampaignFeedback2 payload, map<string|string[]> headers) returns CampaignFeedback1|errorUpdate campaign feedback message
Parameters
- payload CampaignFeedback2 -
get campaigns/[string campaignId]/send-checklist
Isolated FunctionResource Function
function get campaigns/[string campaignId]/send\-checklist(map<string|string[]> headers, *GetCampaignsIdSendChecklistQueries queries) returns SendChecklist|errorGet campaign send checklist
Parameters
- queries *GetCampaignsIdSendChecklistQueries - Queries to be sent with the request
get connected-sites
Isolated FunctionResource Function
function get connected\-sites(map<string|string[]> headers, *GetConnectedSitesQueries queries) returns ConnectedSites|errorList connected sites
Parameters
- queries *GetConnectedSitesQueries - Queries to be sent with the request
post connected-sites
Isolated FunctionResource Function
function post connected\-sites(ConnectedSite payload, map<string|string[]> headers) returns ConnectedSite1|errorAdd connected site
Parameters
- payload ConnectedSite -
get connected-sites/[string connectedSiteId]
Isolated FunctionResource Function
function get connected\-sites/[string connectedSiteId](map<string|string[]> headers, *GetConnectedSitesIdQueries queries) returns ConnectedSite1|errorGet connected site
Parameters
- queries *GetConnectedSitesIdQueries - Queries to be sent with the request
delete connected-sites/[string connectedSiteId]
Isolated FunctionResource Function
function delete connected\-sites/[string connectedSiteId](map<string|string[]> headers) returns error?Delete connected site
Return Type
- error? - Empty Response
post connected-sites/[string connectedSiteId]/actions/verify-script-installation
Isolated FunctionResource Function
function post connected\-sites/[string connectedSiteId]/actions/verify\-script\-installation(map<string|string[]> headers) returns error?Verify connected site script
Return Type
- error? - Empty Response
get conversations
DeprecatedIsolated FunctionResource Function
function get conversations(map<string|string[]> headers, *GetConversationsQueries queries) returns TrackedConversations|errorList conversations
Parameters
- queries *GetConversationsQueries - Queries to be sent with the request
Deprecated
get conversations/[string conversationId]
DeprecatedIsolated FunctionResource Function
function get conversations/[string conversationId](map<string|string[]> headers, *GetConversationsIdQueries queries) returns Conversation|errorGet conversation
Parameters
- queries *GetConversationsIdQueries - Queries to be sent with the request
Deprecated
get conversations/[string conversationId]/messages
DeprecatedIsolated FunctionResource Function
function get conversations/[string conversationId]/messages(map<string|string[]> headers, *GetConversationsIdMessagesQueries queries) returns CollectionOfConversationMessages|errorList messages
Parameters
- queries *GetConversationsIdMessagesQueries - Queries to be sent with the request
Deprecated
get conversations/[string conversationId]/messages/[string messageId]
DeprecatedIsolated FunctionResource Function
function get conversations/[string conversationId]/messages/[string messageId](map<string|string[]> headers, *GetConversationsIdMessagesIdQueries queries) returns ConversationMessage|errorGet message
Parameters
- queries *GetConversationsIdMessagesIdQueries - Queries to be sent with the request
Deprecated
post customer-journeys/journeys/[int journeyId]/steps/[int stepId]/actions/trigger
Isolated FunctionResource Function
function post customer\-journeys/journeys/[int journeyId]/steps/[int stepId]/actions/trigger(SubscriberInCustomerJourneysAudience payload, map<string|string[]> headers) returns record {}|errorCustomer Journeys API trigger for a contact
Parameters
- payload SubscriberInCustomerJourneysAudience -
Return Type
- record {}|error - An empty response
get file-manager/files
Isolated FunctionResource Function
function get file\-manager/files(map<string|string[]> headers, *GetFileManagerFilesQueries queries) returns FileManager|errorList stored files
Parameters
- queries *GetFileManagerFilesQueries - Queries to be sent with the request
post file-manager/files
Isolated FunctionResource Function
function post file\-manager/files(GalleryFile payload, map<string|string[]> headers) returns GalleryFile1|errorAdd file
Parameters
- payload GalleryFile -
get file-manager/files/[string fileId]
Isolated FunctionResource Function
function get file\-manager/files/[string fileId](map<string|string[]> headers, *GetFileManagerFilesIdQueries queries) returns GalleryFile1|errorGet file
Parameters
- queries *GetFileManagerFilesIdQueries - Queries to be sent with the request
delete file-manager/files/[string fileId]
Isolated FunctionResource Function
Delete file
Return Type
- error? - Empty Response
patch file-manager/files/[string fileId]
Isolated FunctionResource Function
function patch file\-manager/files/[string fileId](GalleryFile2 payload, map<string|string[]> headers) returns GalleryFile1|errorUpdate file
Parameters
- payload GalleryFile2 -
get file-manager/folders
Isolated FunctionResource Function
function get file\-manager/folders(map<string|string[]> headers, *GetFileManagerFoldersQueries queries) returns FileManagerFolders|errorList folders
Parameters
- queries *GetFileManagerFoldersQueries - Queries to be sent with the request
post file-manager/folders
Isolated FunctionResource Function
function post file\-manager/folders(GalleryFolder payload, map<string|string[]> headers) returns GalleryFolder1|errorAdd folder
Parameters
- payload GalleryFolder -
get file-manager/folders/[string folderId]
Isolated FunctionResource Function
function get file\-manager/folders/[string folderId](map<string|string[]> headers, *GetFileManagerFoldersIdQueries queries) returns GalleryFolder1|errorGet folder
Parameters
- queries *GetFileManagerFoldersIdQueries - Queries to be sent with the request
delete file-manager/folders/[string folderId]
Isolated FunctionResource Function
function delete file\-manager/folders/[string folderId](map<string|string[]> headers) returns error?Delete folder
Return Type
- error? - Empty Response
patch file-manager/folders/[string folderId]
Isolated FunctionResource Function
function patch file\-manager/folders/[string folderId](GalleryFolder payload, map<string|string[]> headers) returns GalleryFolder1|errorUpdate folder
Parameters
- payload GalleryFolder -
get file-manager/folders/[string folderId]/files
Isolated FunctionResource Function
function get file\-manager/folders/[string folderId]/files(map<string|string[]> headers, *GetFileManagerFoldersFilesQueries queries) returns FileManager|errorList stored files
Parameters
- queries *GetFileManagerFoldersFilesQueries - Queries to be sent with the request
get lists
Isolated FunctionResource Function
function get lists(map<string|string[]> headers, *GetListsQueries queries) returns SubscriberLists|errorGet lists info
Parameters
- queries *GetListsQueries - Queries to be sent with the request
post lists
Isolated FunctionResource Function
function post lists(SubscriberList payload, map<string|string[]> headers) returns SubscriberList1|errorAdd list
Parameters
- payload SubscriberList -
get lists/[string listId]
Isolated FunctionResource Function
function get lists/[string listId](map<string|string[]> headers, *GetListsIdQueries queries) returns SubscriberList1|errorGet list info
Parameters
- queries *GetListsIdQueries - Queries to be sent with the request
post lists/[string listId]
Isolated FunctionResource Function
function post lists/[string listId](MembersToSubscribeUnsubscribeTofromAListInBatch payload, map<string|string[]> headers, *PostListsIdQueries queries) returns BatchUpdateListMembers|errorBatch subscribe or unsubscribe
Parameters
- queries *PostListsIdQueries - Queries to be sent with the request
delete lists/[string listId]
Isolated FunctionResource Function
Delete list
Return Type
- error? - Empty Response
patch lists/[string listId]
Isolated FunctionResource Function
function patch lists/[string listId](SubscriberList2 payload, map<string|string[]> headers) returns SubscriberList1|errorUpdate lists
Parameters
- payload SubscriberList2 -
get lists/[string listId]/abuse-reports
Isolated FunctionResource Function
function get lists/[string listId]/abuse\-reports(map<string|string[]> headers, *GetListsIdAbuseReportsQueries queries) returns AbuseComplaints|errorList abuse reports
Parameters
- queries *GetListsIdAbuseReportsQueries - Queries to be sent with the request
get lists/[string listId]/abuse-reports/[string reportId]
Isolated FunctionResource Function
function get lists/[string listId]/abuse\-reports/[string reportId](map<string|string[]> headers, *GetListsIdAbuseReportsIdQueries queries) returns AbuseComplaint|errorGet merge field
Parameters
- queries *GetListsIdAbuseReportsIdQueries - Queries to be sent with the request
get lists/[string listId]/activity
Isolated FunctionResource Function
function get lists/[string listId]/activity(map<string|string[]> headers, *GetListsIdActivityQueries queries) returns ListActivity|errorList recent activity
Parameters
- queries *GetListsIdActivityQueries - Queries to be sent with the request
get lists/[string listId]/clients
Isolated FunctionResource Function
function get lists/[string listId]/clients(map<string|string[]> headers, *GetListsIdClientsQueries queries) returns EmailClients|errorList top email clients
Parameters
- queries *GetListsIdClientsQueries - Queries to be sent with the request
get lists/[string listId]/growth-history
Isolated FunctionResource Function
function get lists/[string listId]/growth\-history(map<string|string[]> headers, *GetListsIdGrowthHistoryQueries queries) returns GrowthHistory|errorList growth history data
Parameters
- queries *GetListsIdGrowthHistoryQueries - Queries to be sent with the request
get lists/[string listId]/growth-history/[string month]
Isolated FunctionResource Function
function get lists/[string listId]/growth\-history/[string month](map<string|string[]> headers, *GetListsIdGrowthHistoryIdQueries queries) returns GrowthHistory1|errorGet merge field
Parameters
- queries *GetListsIdGrowthHistoryIdQueries - Queries to be sent with the request
get lists/[string listId]/interest-categories
Isolated FunctionResource Function
function get lists/[string listId]/interest\-categories(map<string|string[]> headers, *GetListsIdInterestCategoriesQueries queries) returns InterestGroupings|errorList interest categories
Parameters
- queries *GetListsIdInterestCategoriesQueries - Queries to be sent with the request
post lists/[string listId]/interest-categories
Isolated FunctionResource Function
function post lists/[string listId]/interest\-categories(InterestCategory payload, map<string|string[]> headers) returns InterestCategory1|errorAdd interest category
Parameters
- payload InterestCategory -
get lists/[string listId]/interest-categories/[string interestCategoryId]
Isolated FunctionResource Function
function get lists/[string listId]/interest\-categories/[string interestCategoryId](map<string|string[]> headers, *GetListsIdInterestCategoriesIdQueries queries) returns InterestCategory1|errorGet merge field
Parameters
- queries *GetListsIdInterestCategoriesIdQueries - Queries to be sent with the request
delete lists/[string listId]/interest-categories/[string interestCategoryId]
Isolated FunctionResource Function
function delete lists/[string listId]/interest\-categories/[string interestCategoryId](map<string|string[]> headers) returns error?Delete merge field
Return Type
- error? - Empty Response
patch lists/[string listId]/interest-categories/[string interestCategoryId]
Isolated FunctionResource Function
function patch lists/[string listId]/interest\-categories/[string interestCategoryId](InterestCategory payload, map<string|string[]> headers) returns InterestCategory1|errorUpdate merge field
Parameters
- payload InterestCategory -
get lists/[string listId]/interest-categories/[string interestCategoryId]/interests
Isolated FunctionResource Function
function get lists/[string listId]/interest\-categories/[string interestCategoryId]/interests(map<string|string[]> headers, *GetListsIdInterestCategoriesIdInterestsQueries queries) returns Interests|errorList interests in category
Parameters
- queries *GetListsIdInterestCategoriesIdInterestsQueries - Queries to be sent with the request
post lists/[string listId]/interest-categories/[string interestCategoryId]/interests
Isolated FunctionResource Function
function post lists/[string listId]/interest\-categories/[string interestCategoryId]/interests(Interest payload, map<string|string[]> headers) returns Interest1|errorAdd interest in category
Parameters
- payload Interest -
get lists/[string listId]/interest-categories/[string interestCategoryId]/interests/[string interestId]
Isolated FunctionResource Function
function get lists/[string listId]/interest\-categories/[string interestCategoryId]/interests/[string interestId](map<string|string[]> headers, *GetListsIdInterestCategoriesIdInterestsIdQueries queries) returns Interest1|errorGet interest in category
Parameters
- queries *GetListsIdInterestCategoriesIdInterestsIdQueries - Queries to be sent with the request
delete lists/[string listId]/interest-categories/[string interestCategoryId]/interests/[string interestId]
Isolated FunctionResource Function
function delete lists/[string listId]/interest\-categories/[string interestCategoryId]/interests/[string interestId](map<string|string[]> headers) returns error?Delete interest in category
Return Type
- error? - Empty Response
patch lists/[string listId]/interest-categories/[string interestCategoryId]/interests/[string interestId]
Isolated FunctionResource Function
function patch lists/[string listId]/interest\-categories/[string interestCategoryId]/interests/[string interestId](Interest payload, map<string|string[]> headers) returns Interest1|errorUpdate interest in category
Parameters
- payload Interest -
get lists/[string listId]/segments
Isolated FunctionResource Function
function get lists/[string listId]/segments(map<string|string[]> headers, *PreviewASegmentQueries queries) returns CollectionOfSegments|errorList segments
Parameters
- queries *PreviewASegmentQueries - Queries to be sent with the request
post lists/[string listId]/segments
Isolated FunctionResource Function
function post lists/[string listId]/segments(List3 payload, map<string|string[]> headers) returns List4|errorAdd segment
Parameters
- payload List3 -
get lists/[string listId]/segments/[string segmentId]
Isolated FunctionResource Function
function get lists/[string listId]/segments/[string segmentId](map<string|string[]> headers, *GetListsIdSegmentsIdQueries queries) returns List4|errorGet segment info
Parameters
- queries *GetListsIdSegmentsIdQueries - Queries to be sent with the request
post lists/[string listId]/segments/[string segmentId]
Isolated FunctionResource Function
function post lists/[string listId]/segments/[string segmentId](MembersToAddremoveTofromAStaticSegment payload, map<string|string[]> headers) returns BatchAddremoveListMembersTofromStaticSegment|errorBatch add or remove members
Parameters
- payload MembersToAddremoveTofromAStaticSegment -
delete lists/[string listId]/segments/[string segmentId]
Isolated FunctionResource Function
function delete lists/[string listId]/segments/[string segmentId](map<string|string[]> headers) returns error?Delete segment
Return Type
- error? - Empty Response
patch lists/[string listId]/segments/[string segmentId]
Isolated FunctionResource Function
function patch lists/[string listId]/segments/[string segmentId](List5 payload, map<string|string[]> headers) returns List4|errorUpdate segment
Parameters
- payload List5 -
get lists/[string listId]/segments/[string segmentId]/members
Isolated FunctionResource Function
function get lists/[string listId]/segments/[string segmentId]/members(map<string|string[]> headers, *GetListsIdSegmentsIdMembersQueries queries) returns SegmentMembers|errorList members in segment
Parameters
- queries *GetListsIdSegmentsIdMembersQueries - Queries to be sent with the request
post lists/[string listId]/segments/[string segmentId]/members
Isolated FunctionResource Function
function post lists/[string listId]/segments/[string segmentId]/members(SegmentIdMembersBody payload, map<string|string[]> headers) returns ListMembers|errorAdd member to segment
Parameters
- payload SegmentIdMembersBody -
delete lists/[string listId]/segments/[string segmentId]/members/[string subscriberHash]
Isolated FunctionResource Function
function delete lists/[string listId]/segments/[string segmentId]/members/[string subscriberHash](map<string|string[]> headers) returns error?Remove list member from segment
Return Type
- error? - Empty Response
get lists/[string listId]/tag-search
Isolated FunctionResource Function
function get lists/[string listId]/tag\-search(map<string|string[]> headers, *SearchTagsByNameQueries queries) returns TagSearchResults|errorSearch for tags on a list by name.
Parameters
- queries *SearchTagsByNameQueries - Queries to be sent with the request
get lists/[string listId]/members
Isolated FunctionResource Function
function get lists/[string listId]/members(map<string|string[]> headers, *GetListsIdMembersQueries queries) returns ListMembers1|errorList members info
Parameters
- queries *GetListsIdMembersQueries - Queries to be sent with the request
post lists/[string listId]/members
Isolated FunctionResource Function
function post lists/[string listId]/members(AddListMembers1 payload, map<string|string[]> headers, *PostListsIdMembersQueries queries) returns ListMembers2|errorAdd member to list
Parameters
- payload AddListMembers1 -
- queries *PostListsIdMembersQueries - Queries to be sent with the request
get lists/[string listId]/members/[string subscriberHash]
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash](map<string|string[]> headers, *GetListsIdMembersIdQueries queries) returns ListMembers2|errorGet member info
Parameters
- queries *GetListsIdMembersIdQueries - Queries to be sent with the request
put lists/[string listId]/members/[string subscriberHash]
Isolated FunctionResource Function
function put lists/[string listId]/members/[string subscriberHash](AddListMembers2 payload, map<string|string[]> headers, *PutListsIdMembersIdQueries queries) returns ListMembers2|errorAdd or update list member
Parameters
- payload AddListMembers2 -
- queries *PutListsIdMembersIdQueries - Queries to be sent with the request
delete lists/[string listId]/members/[string subscriberHash]
Isolated FunctionResource Function
function delete lists/[string listId]/members/[string subscriberHash](map<string|string[]> headers) returns error?Archive list member
Return Type
- error? - Empty Response
patch lists/[string listId]/members/[string subscriberHash]
Isolated FunctionResource Function
function patch lists/[string listId]/members/[string subscriberHash](AddListMembers3 payload, map<string|string[]> headers, *PatchListsIdMembersIdQueries queries) returns ListMembers2|errorUpdate list member
Parameters
- payload AddListMembers3 -
- queries *PatchListsIdMembersIdQueries - Queries to be sent with the request
get lists/[string listId]/members/[string subscriberHash]/activity
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash]/activity(map<string|string[]> headers, *GetListsIdMembersIdActivityQueries queries) returns MemberActivityEvents|errorView recent activity 50
Parameters
- queries *GetListsIdMembersIdActivityQueries - Queries to be sent with the request
get lists/[string listId]/members/[string subscriberHash]/activity-feed
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash]/activity\-feed(map<string|string[]> headers, *GetListsIdMembersIdActivityFeedQueries queries) returns MemberActivityEvents1|errorView recent activity
Parameters
- queries *GetListsIdMembersIdActivityFeedQueries - Queries to be sent with the request
get lists/[string listId]/members/[string subscriberHash]/tags
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash]/tags(map<string|string[]> headers, *GetListMemberTagsQueries queries) returns CollectionOfTags|errorList member tags
Parameters
- queries *GetListMemberTagsQueries - Queries to be sent with the request
post lists/[string listId]/members/[string subscriberHash]/tags
Isolated FunctionResource Function
function post lists/[string listId]/members/[string subscriberHash]/tags(MemberTags payload, map<string|string[]> headers) returns error?Add or remove member tags
Parameters
- payload MemberTags -
Return Type
- error? - Empty Response
get lists/[string listId]/members/[string subscriberHash]/events
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash]/events(map<string|string[]> headers, *GetListsIdMembersIdEventsQueries queries) returns CollectionOfEvents|errorList member events
Parameters
- queries *GetListsIdMembersIdEventsQueries - Queries to be sent with the request
post lists/[string listId]/members/[string subscriberHash]/events
Isolated FunctionResource Function
function post lists/[string listId]/members/[string subscriberHash]/events(Events payload, map<string|string[]> headers) returns error?Add event
Parameters
- payload Events -
Return Type
- error? - Empty Response
get lists/[string listId]/members/[string subscriberHash]/goals
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash]/goals(map<string|string[]> headers, *GetListsIdMembersIdGoalsQueries queries) returns CollectionOfMemberActivityEvents|errorList member goal events
Parameters
- queries *GetListsIdMembersIdGoalsQueries - Queries to be sent with the request
get lists/[string listId]/members/[string subscriberHash]/notes
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash]/notes(map<string|string[]> headers, *GetListsIdMembersIdNotesQueries queries) returns CollectionOfNotes|errorList recent member notes
Parameters
- queries *GetListsIdMembersIdNotesQueries - Queries to be sent with the request
post lists/[string listId]/members/[string subscriberHash]/notes
Isolated FunctionResource Function
function post lists/[string listId]/members/[string subscriberHash]/notes(MemberNotes payload, map<string|string[]> headers) returns MemberNotes1|errorAdd member note
Parameters
- payload MemberNotes -
get lists/[string listId]/members/[string subscriberHash]/notes/[string noteId]
Isolated FunctionResource Function
function get lists/[string listId]/members/[string subscriberHash]/notes/[string noteId](map<string|string[]> headers, *GetListsIdMembersIdNotesIdQueries queries) returns MemberNotes1|errorGet member note
Parameters
- queries *GetListsIdMembersIdNotesIdQueries - Queries to be sent with the request
delete lists/[string listId]/members/[string subscriberHash]/notes/[string noteId]
Isolated FunctionResource Function
function delete lists/[string listId]/members/[string subscriberHash]/notes/[string noteId](map<string|string[]> headers) returns error?Delete note
Return Type
- error? - Empty Response
patch lists/[string listId]/members/[string subscriberHash]/notes/[string noteId]
Isolated FunctionResource Function
function patch lists/[string listId]/members/[string subscriberHash]/notes/[string noteId](MemberNotes payload, map<string|string[]> headers) returns MemberNotes1|errorUpdate note
Parameters
- payload MemberNotes -
post lists/[string listId]/members/[string subscriberHash]/actions/delete-permanent
Isolated FunctionResource Function
function post lists/[string listId]/members/[string subscriberHash]/actions/delete\-permanent(map<string|string[]> headers) returns error?Delete list member
Return Type
- error? - Empty Response
get lists/[string listId]/merge-fields
Isolated FunctionResource Function
function get lists/[string listId]/merge\-fields(map<string|string[]> headers, *GetListsIdMergeFieldsQueries queries) returns CollectionOfMergeFields|errorList merge fields
Parameters
- queries *GetListsIdMergeFieldsQueries - Queries to be sent with the request
post lists/[string listId]/merge-fields
Isolated FunctionResource Function
function post lists/[string listId]/merge\-fields(MergeField payload, map<string|string[]> headers) returns MergeField1|errorAdd merge field
Parameters
- payload MergeField -
get lists/[string listId]/merge-fields/[string mergeId]
Isolated FunctionResource Function
function get lists/[string listId]/merge\-fields/[string mergeId](map<string|string[]> headers, *GetListsIdMergeFieldsIdQueries queries) returns MergeField1|errorGet merge field
Parameters
- queries *GetListsIdMergeFieldsIdQueries - Queries to be sent with the request
delete lists/[string listId]/merge-fields/[string mergeId]
Isolated FunctionResource Function
function delete lists/[string listId]/merge\-fields/[string mergeId](map<string|string[]> headers) returns error?Delete merge field
Return Type
- error? - Empty Response
patch lists/[string listId]/merge-fields/[string mergeId]
Isolated FunctionResource Function
function patch lists/[string listId]/merge\-fields/[string mergeId](MergeField2 payload, map<string|string[]> headers) returns MergeField1|errorUpdate merge field
Parameters
- payload MergeField2 -
get lists/[string listId]/webhooks
Isolated FunctionResource Function
function get lists/[string listId]/webhooks(map<string|string[]> headers) returns ListWebhooks|errorList webhooks
post lists/[string listId]/webhooks
Isolated FunctionResource Function
function post lists/[string listId]/webhooks(AddWebhook payload, map<string|string[]> headers) returns ListWebhooks1|errorAdd webhook
Parameters
- payload AddWebhook -
get lists/[string listId]/webhooks/[string webhookId]
Isolated FunctionResource Function
function get lists/[string listId]/webhooks/[string webhookId](map<string|string[]> headers) returns ListWebhooks1|errorGet webhook info
delete lists/[string listId]/webhooks/[string webhookId]
Isolated FunctionResource Function
function delete lists/[string listId]/webhooks/[string webhookId](map<string|string[]> headers) returns error?Delete webhook
Return Type
- error? - Empty Response
patch lists/[string listId]/webhooks/[string webhookId]
Isolated FunctionResource Function
function patch lists/[string listId]/webhooks/[string webhookId](AddWebhook payload, map<string|string[]> headers) returns ListWebhooks1|errorUpdate webhook
Parameters
- payload AddWebhook -
get lists/[string listId]/signup-forms
Isolated FunctionResource Function
function get lists/[string listId]/signup\-forms(map<string|string[]> headers) returns ListSignupForms|errorList signup forms
post lists/[string listId]/signup-forms
Isolated FunctionResource Function
function post lists/[string listId]/signup\-forms(SignupForm payload, map<string|string[]> headers) returns SignupForm1|errorCustomize signup form
Parameters
- payload SignupForm -
get lists/[string listId]/locations
Isolated FunctionResource Function
function get lists/[string listId]/locations(map<string|string[]> headers, *GetListsIdLocationsQueries queries) returns ListLocations|errorList locations
Parameters
- queries *GetListsIdLocationsQueries - Queries to be sent with the request
get lists/[string listId]/surveys
Isolated FunctionResource Function
Get information about all surveys for a list
get lists/[string listId]/surveys/[string surveyId]
Isolated FunctionResource Function
function get lists/[string listId]/surveys/[string surveyId](map<string|string[]> headers) returns error?Get survey
post lists/[string listId]/surveys/[string surveyId]/actions/publish
Isolated FunctionResource Function
function post lists/[string listId]/surveys/[string surveyId]/actions/publish(map<string|string[]> headers) returns error?Publish a Survey
Return Type
- error? - Survey Published
post lists/[string listId]/surveys/[string surveyId]/actions/unpublish
Isolated FunctionResource Function
function post lists/[string listId]/surveys/[string surveyId]/actions/unpublish(map<string|string[]> headers) returns error?Unpublish a Survey
Return Type
- error? - Survey Instance
post lists/[string listId]/surveys/[string surveyId]/actions/create-email
Isolated FunctionResource Function
function post lists/[string listId]/surveys/[string surveyId]/actions/create\-email(map<string|string[]> headers) returns Campaign3|errorCreate a Survey Campaign
get landing-pages
Isolated FunctionResource Function
function get landing\-pages(map<string|string[]> headers, *GetAllLandingPagesQueries queries) returns InlineResponse2008|errorList landing pages
Parameters
- queries *GetAllLandingPagesQueries - Queries to be sent with the request
Return Type
- InlineResponse2008|error - Landing Pages Collection
post landing-pages
Isolated FunctionResource Function
function post landing\-pages(LandingPage payload, map<string|string[]> headers, *PostAllLandingPagesQueries queries) returns LandingPage1|errorAdd landing page
Parameters
- payload LandingPage -
- queries *PostAllLandingPagesQueries - Queries to be sent with the request
get landing-pages/[string pageId]
Isolated FunctionResource Function
function get landing\-pages/[string pageId](map<string|string[]> headers, *GetLandingPageIdQueries queries) returns LandingPage1|errorGet landing page info
Parameters
- queries *GetLandingPageIdQueries - Queries to be sent with the request
Return Type
- LandingPage1|error - Landing Pages Instance
delete landing-pages/[string pageId]
Isolated FunctionResource Function
Delete landing page
Return Type
- error? - Empty Response
patch landing-pages/[string pageId]
Isolated FunctionResource Function
function patch landing\-pages/[string pageId](LandingPage2 payload, map<string|string[]> headers) returns LandingPage1|errorUpdate landing page
Parameters
- payload LandingPage2 -
post landing-pages/[string pageId]/actions/publish
Isolated FunctionResource Function
function post landing\-pages/[string pageId]/actions/publish(map<string|string[]> headers) returns error?Publish landing page
Return Type
- error? - Empty Response
post landing-pages/[string pageId]/actions/unpublish
Isolated FunctionResource Function
function post landing\-pages/[string pageId]/actions/unpublish(map<string|string[]> headers) returns error?Unpublish landing page
Return Type
- error? - Empty Response
get landing-pages/[string pageId]/content
Isolated FunctionResource Function
function get landing\-pages/[string pageId]/content(map<string|string[]> headers, *GetLandingPageIdContentQueries queries) returns LandingPageContent|errorGet landing page content
Parameters
- queries *GetLandingPageIdContentQueries - Queries to be sent with the request
get reports
Isolated FunctionResource Function
function get reports(map<string|string[]> headers, *GetReportsQueries queries) returns CampaignReports1|errorList campaign reports
Parameters
- queries *GetReportsQueries - Queries to be sent with the request
get reports/[string campaignId]
Isolated FunctionResource Function
function get reports/[string campaignId](map<string|string[]> headers, *GetReportsIdQueries queries) returns CampaignReport|errorGet campaign report
Parameters
- queries *GetReportsIdQueries - Queries to be sent with the request
get reports/[string campaignId]/abuse-reports
Isolated FunctionResource Function
function get reports/[string campaignId]/abuse\-reports(map<string|string[]> headers, *GetReportsIdAbuseReportsIdQueries queries) returns AbuseComplaints1|errorList abuse reports
Parameters
- queries *GetReportsIdAbuseReportsIdQueries - Queries to be sent with the request
get reports/[string campaignId]/abuse-reports/[string reportId]
Isolated FunctionResource Function
function get reports/[string campaignId]/abuse\-reports/[string reportId](map<string|string[]> headers, *GetReportsIdAbuseReportsIdIdQueries queries) returns AbuseComplaint1|errorGet campaign recipient info
Parameters
- queries *GetReportsIdAbuseReportsIdIdQueries - Queries to be sent with the request
get reports/[string campaignId]/advice
Isolated FunctionResource Function
function get reports/[string campaignId]/advice(map<string|string[]> headers, *GetReportsIdAdviceQueries queries) returns CampaignAdviceReport|errorList campaign feedback
Parameters
- queries *GetReportsIdAdviceQueries - Queries to be sent with the request
get reports/[string campaignId]/click-details
Isolated FunctionResource Function
function get reports/[string campaignId]/click\-details(map<string|string[]> headers, *GetReportsIdClickDetailsQueries queries) returns ClickDetailReport|errorList campaign details
Parameters
- queries *GetReportsIdClickDetailsQueries - Queries to be sent with the request
get reports/[string campaignId]/click-details/[string linkId]
Isolated FunctionResource Function
function get reports/[string campaignId]/click\-details/[string linkId](map<string|string[]> headers, *GetReportsIdClickDetailsIdQueries queries) returns ClickDetailReport1|errorGet campaign recipient info
Parameters
- queries *GetReportsIdClickDetailsIdQueries - Queries to be sent with the request
get reports/[string campaignId]/click-details/[string linkId]/members
Isolated FunctionResource Function
function get reports/[string campaignId]/click\-details/[string linkId]/members(map<string|string[]> headers, *GetReportsIdClickDetailsIdMembersQueries queries) returns ClickDetailMembers|errorList clicked link subscribers
Parameters
- queries *GetReportsIdClickDetailsIdMembersQueries - Queries to be sent with the request
get reports/[string campaignId]/click-details/[string linkId]/members/[string subscriberHash]
Isolated FunctionResource Function
function get reports/[string campaignId]/click\-details/[string linkId]/members/[string subscriberHash](map<string|string[]> headers, *GetReportsIdClickDetailsIdMembersIdQueries queries) returns ClickDetailMember|errorGet clicked link subscriber
Parameters
- queries *GetReportsIdClickDetailsIdMembersIdQueries - Queries to be sent with the request
get reports/[string campaignId]/open-details
Isolated FunctionResource Function
function get reports/[string campaignId]/open\-details(map<string|string[]> headers, *GetReportsIdOpenDetailsQueries queries) returns OpenDetailReport|errorList campaign open details
Parameters
- queries *GetReportsIdOpenDetailsQueries - Queries to be sent with the request
get reports/[string campaignId]/open-details/[string subscriberHash]
Isolated FunctionResource Function
function get reports/[string campaignId]/open\-details/[string subscriberHash](map<string|string[]> headers, *GetReportsIdOpenDetailsIdMembersIdQueries queries) returns OpenActivity|errorGet campaign recipient info
Parameters
- queries *GetReportsIdOpenDetailsIdMembersIdQueries - Queries to be sent with the request
get reports/[string campaignId]/domain-performance
Isolated FunctionResource Function
function get reports/[string campaignId]/domain\-performance(map<string|string[]> headers, *GetReportsIdDomainPerformanceQueries queries) returns DomainPerformance|errorList domain performance stats
Parameters
- queries *GetReportsIdDomainPerformanceQueries - Queries to be sent with the request
get reports/[string campaignId]/eepurl
Isolated FunctionResource Function
function get reports/[string campaignId]/eepurl(map<string|string[]> headers, *GetReportsIdEepurlQueries queries) returns EepurlActivity|errorList EepURL activity
Parameters
- queries *GetReportsIdEepurlQueries - Queries to be sent with the request
get reports/[string campaignId]/email-activity
Isolated FunctionResource Function
function get reports/[string campaignId]/email\-activity(map<string|string[]> headers, *GetReportsIdEmailActivityQueries queries) returns EmailActivity|errorList email activity
Parameters
- queries *GetReportsIdEmailActivityQueries - Queries to be sent with the request
get reports/[string campaignId]/email-activity/[string subscriberHash]
Isolated FunctionResource Function
function get reports/[string campaignId]/email\-activity/[string subscriberHash](map<string|string[]> headers, *GetReportsIdEmailActivityIdQueries queries) returns EmailActivity1|errorGet campaign recipient info
Parameters
- queries *GetReportsIdEmailActivityIdQueries - Queries to be sent with the request
get reports/[string campaignId]/locations
Isolated FunctionResource Function
function get reports/[string campaignId]/locations(map<string|string[]> headers, *GetReportsIdLocationsQueries queries) returns OpenLocations|errorList top open activities
Parameters
- queries *GetReportsIdLocationsQueries - Queries to be sent with the request
get reports/[string campaignId]/sent-to
Isolated FunctionResource Function
function get reports/[string campaignId]/sent\-to(map<string|string[]> headers, *GetReportsIdSentToQueries queries) returns SentTo|errorList campaign recipients
Parameters
- queries *GetReportsIdSentToQueries - Queries to be sent with the request
get reports/[string campaignId]/sent-to/[string subscriberHash]
Isolated FunctionResource Function
function get reports/[string campaignId]/sent\-to/[string subscriberHash](map<string|string[]> headers, *GetReportsIdSentToIdQueries queries) returns SentTo1|errorGet campaign recipient info
Parameters
- queries *GetReportsIdSentToIdQueries - Queries to be sent with the request
get reports/[string campaignId]/sub-reports
Isolated FunctionResource Function
function get reports/[string campaignId]/sub\-reports(map<string|string[]> headers, *GetReportsIdSubReportsIdQueries queries) returns CampaignSubReports|errorList child campaign reports
Parameters
- queries *GetReportsIdSubReportsIdQueries - Queries to be sent with the request
get reports/[string campaignId]/unsubscribed
Isolated FunctionResource Function
function get reports/[string campaignId]/unsubscribed(map<string|string[]> headers, *GetReportsIdUnsubscribedQueries queries) returns Unsubscribes|errorList unsubscribed members
Parameters
- queries *GetReportsIdUnsubscribedQueries - Queries to be sent with the request
get reports/[string campaignId]/unsubscribed/[string subscriberHash]
Isolated FunctionResource Function
function get reports/[string campaignId]/unsubscribed/[string subscriberHash](map<string|string[]> headers, *GetReportsIdUnsubscribedIdQueries queries) returns Unsubscribes1|errorGet unsubscribed member
Parameters
- queries *GetReportsIdUnsubscribedIdQueries - Queries to be sent with the request
get reports/[string campaignId]/ecommerce-product-activity
Isolated FunctionResource Function
function get reports/[string campaignId]/ecommerce\-product\-activity(map<string|string[]> headers, *GetReportsIdEcommerceProductActivityQueries queries) returns InlineResponse2009|errorList campaign product activity
Parameters
- queries *GetReportsIdEcommerceProductActivityQueries - Queries to be sent with the request
Return Type
- InlineResponse2009|error - Ecommerce Product Activity Instance
get templates
Isolated FunctionResource Function
function get templates(map<string|string[]> headers, *GetTemplatesQueries queries) returns Templates|errorList templates
Parameters
- queries *GetTemplatesQueries - Queries to be sent with the request
post templates
Isolated FunctionResource Function
function post templates(TemplateInstance payload, map<string|string[]> headers) returns TemplateInstance1|errorAdd template
Parameters
- payload TemplateInstance -
get templates/[string templateId]
Isolated FunctionResource Function
function get templates/[string templateId](map<string|string[]> headers, *GetTemplatesIdQueries queries) returns TemplateInstance1|errorGet template info
Parameters
- queries *GetTemplatesIdQueries - Queries to be sent with the request
delete templates/[string templateId]
Isolated FunctionResource Function
Delete template
Return Type
- error? - Empty Response
patch templates/[string templateId]
Isolated FunctionResource Function
function patch templates/[string templateId](TemplateInstance payload, map<string|string[]> headers) returns TemplateInstance1|errorUpdate template
Parameters
- payload TemplateInstance -
get templates/[string templateId]/default-content
Isolated FunctionResource Function
function get templates/[string templateId]/default\-content(map<string|string[]> headers, *GetTemplatesIdDefaultContentQueries queries) returns TemplateDefaultContent|errorView default content
Parameters
- queries *GetTemplatesIdDefaultContentQueries - Queries to be sent with the request
get ecommerce/orders
Isolated FunctionResource Function
function get ecommerce/orders(map<string|string[]> headers, *GetEcommerceOrdersQueries queries) returns Orders|errorList account orders
Parameters
- queries *GetEcommerceOrdersQueries - Queries to be sent with the request
get ecommerce/stores
Isolated FunctionResource Function
function get ecommerce/stores(map<string|string[]> headers, *GetEcommerceStoresQueries queries) returns ECommerceStores|errorList stores
Parameters
- queries *GetEcommerceStoresQueries - Queries to be sent with the request
post ecommerce/stores
Isolated FunctionResource Function
function post ecommerce/stores(ECommerceStore payload, map<string|string[]> headers) returns ECommerceStore1|errorAdd store
Parameters
- payload ECommerceStore -
get ecommerce/stores/[string storeId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId](map<string|string[]> headers, *GetEcommerceStoresIdQueries queries) returns ECommerceStore1|errorGet store info
Parameters
- queries *GetEcommerceStoresIdQueries - Queries to be sent with the request
delete ecommerce/stores/[string storeId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId](map<string|string[]> headers) returns record {}|errorDelete store
Return Type
- record {}|error - Empty Response
patch ecommerce/stores/[string storeId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId](ECommerceStore2 payload, map<string|string[]> headers) returns ECommerceStore1|errorUpdate store
Parameters
- payload ECommerceStore2 -
get ecommerce/stores/[string storeId]/carts
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/carts(map<string|string[]> headers, *GetEcommerceStoresIdCartsQueries queries) returns Carts|errorList carts
Parameters
- queries *GetEcommerceStoresIdCartsQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/carts
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/carts(ECommerceCart payload, map<string|string[]> headers) returns ECommerceCart1|errorAdd cart
Parameters
- payload ECommerceCart -
get ecommerce/stores/[string storeId]/carts/[string cartId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/carts/[string cartId](map<string|string[]> headers, *GetEcommerceStoresIdCartsIdQueries queries) returns ECommerceCart1|errorGet cart info
Parameters
- queries *GetEcommerceStoresIdCartsIdQueries - Queries to be sent with the request
delete ecommerce/stores/[string storeId]/carts/[string cartId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/carts/[string cartId](map<string|string[]> headers) returns error?Delete cart
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/carts/[string cartId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/carts/[string cartId](ECommerceCart2 payload, map<string|string[]> headers) returns ECommerceCart1|errorUpdate cart
Parameters
- payload ECommerceCart2 -
get ecommerce/stores/[string storeId]/carts/[string cartId]/lines
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/carts/[string cartId]/lines(map<string|string[]> headers, *GetEcommerceStoresIdCartsIdLinesQueries queries) returns CartLines|errorList cart line items
Parameters
- queries *GetEcommerceStoresIdCartsIdLinesQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/carts/[string cartId]/lines
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/carts/[string cartId]/lines(ECommerceCartLineItem payload, map<string|string[]> headers) returns ECommerceCartLineItem2|errorAdd cart line item
Parameters
- payload ECommerceCartLineItem -
get ecommerce/stores/[string storeId]/carts/[string cartId]/lines/[string lineId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/carts/[string cartId]/lines/[string lineId](map<string|string[]> headers, *GetEcommerceStoresIdCartsIdLinesIdQueries queries) returns ECommerceCartLineItem2|errorGet cart line item
Parameters
- queries *GetEcommerceStoresIdCartsIdLinesIdQueries - Queries to be sent with the request
delete ecommerce/stores/[string storeId]/carts/[string cartId]/lines/[string lineId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/carts/[string cartId]/lines/[string lineId](map<string|string[]> headers) returns error?Delete cart line item
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/carts/[string cartId]/lines/[string lineId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/carts/[string cartId]/lines/[string lineId](ECommerceCartLineItem1 payload, map<string|string[]> headers) returns ECommerceCartLineItem2|errorUpdate cart line item
Parameters
- payload ECommerceCartLineItem1 -
get ecommerce/stores/[string storeId]/customers
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/customers(map<string|string[]> headers, *GetEcommerceStoresIdCustomersQueries queries) returns Customers|errorList customers
Parameters
- queries *GetEcommerceStoresIdCustomersQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/customers
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/customers(ECommerceCustomer2 payload, map<string|string[]> headers) returns ECommerceCustomer3|errorAdd customer
Parameters
- payload ECommerceCustomer2 -
get ecommerce/stores/[string storeId]/customers/[string customerId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/customers/[string customerId](map<string|string[]> headers, *GetEcommerceStoresIdCustomersIdQueries queries) returns ECommerceCustomer3|errorGet customer info
Parameters
- queries *GetEcommerceStoresIdCustomersIdQueries - Queries to be sent with the request
put ecommerce/stores/[string storeId]/customers/[string customerId]
Isolated FunctionResource Function
function put ecommerce/stores/[string storeId]/customers/[string customerId](ECommerceCustomer4 payload, map<string|string[]> headers) returns ECommerceCustomer3|errorAdd or update customer
Parameters
- payload ECommerceCustomer4 -
delete ecommerce/stores/[string storeId]/customers/[string customerId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/customers/[string customerId](map<string|string[]> headers) returns error?Delete customer
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/customers/[string customerId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/customers/[string customerId](ECommerceCustomer1 payload, map<string|string[]> headers) returns ECommerceCustomer3|errorUpdate customer
Parameters
- payload ECommerceCustomer1 -
get ecommerce/stores/[string storeId]/promo-rules
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/promo\-rules(map<string|string[]> headers, *GetEcommerceStoresIdPromorulesQueries queries) returns PromoRules|errorList promo rules
Parameters
- queries *GetEcommerceStoresIdPromorulesQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/promo-rules
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/promo\-rules(ECommercePromoRule payload, map<string|string[]> headers) returns ECommercePromoRule1|errorAdd promo rule
Parameters
- payload ECommercePromoRule -
get ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId](map<string|string[]> headers, *GetEcommerceStoresIdPromorulesIdQueries queries) returns ECommercePromoRule1|errorGet promo rule
Parameters
- queries *GetEcommerceStoresIdPromorulesIdQueries - Queries to be sent with the request
delete ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId](map<string|string[]> headers) returns error?Delete promo rule
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId](ECommercePromoRule2 payload, map<string|string[]> headers) returns ECommercePromoRule1|errorUpdate promo rule
Parameters
- payload ECommercePromoRule2 -
get ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]/promo-codes
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId]/promo\-codes(map<string|string[]> headers, *GetEcommerceStoresIdPromocodesQueries queries) returns PromoCodes|errorList promo codes
Parameters
- queries *GetEcommerceStoresIdPromocodesQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]/promo-codes
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId]/promo\-codes(ECommercePromoCode payload, map<string|string[]> headers) returns ECommercePromoCode1|errorAdd promo code
Parameters
- payload ECommercePromoCode -
get ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]/promo-codes/[string promoCodeId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId]/promo\-codes/[string promoCodeId](map<string|string[]> headers, *GetEcommerceStoresIdPromocodesIdQueries queries) returns ECommercePromoCode1|errorGet promo code
Parameters
- queries *GetEcommerceStoresIdPromocodesIdQueries - Queries to be sent with the request
delete ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]/promo-codes/[string promoCodeId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId]/promo\-codes/[string promoCodeId](map<string|string[]> headers) returns error?Delete promo code
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/promo-rules/[string promoRuleId]/promo-codes/[string promoCodeId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/promo\-rules/[string promoRuleId]/promo\-codes/[string promoCodeId](ECommercePromoCode2 payload, map<string|string[]> headers) returns ECommercePromoCode1|errorUpdate promo code
Parameters
- payload ECommercePromoCode2 -
get ecommerce/stores/[string storeId]/orders
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/orders(map<string|string[]> headers, *GetEcommerceStoresIdOrdersQueries queries) returns Orders1|errorList orders
Parameters
- queries *GetEcommerceStoresIdOrdersQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/orders
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/orders(ECommerceOrder payload, map<string|string[]> headers) returns ECommerceOrder1|errorAdd order
Parameters
- payload ECommerceOrder -
get ecommerce/stores/[string storeId]/orders/[string orderId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/orders/[string orderId](map<string|string[]> headers, *GetEcommerceStoresIdOrdersIdQueries queries) returns ECommerceOrder1|errorGet order info
Parameters
- queries *GetEcommerceStoresIdOrdersIdQueries - Queries to be sent with the request
put ecommerce/stores/[string storeId]/orders/[string orderId]
Isolated FunctionResource Function
function put ecommerce/stores/[string storeId]/orders/[string orderId](ECommerceOrder2 payload, map<string|string[]> headers) returns ECommerceOrder1|errorAdd or update order
Parameters
- payload ECommerceOrder2 -
delete ecommerce/stores/[string storeId]/orders/[string orderId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/orders/[string orderId](map<string|string[]> headers) returns error?Delete order
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/orders/[string orderId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/orders/[string orderId](ECommerceOrder3 payload, map<string|string[]> headers) returns ECommerceOrder1|errorUpdate order
Parameters
- payload ECommerceOrder3 -
get ecommerce/stores/[string storeId]/orders/[string orderId]/lines
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/orders/[string orderId]/lines(map<string|string[]> headers, *GetEcommerceStoresIdOrdersIdLinesQueries queries) returns OrderLines|errorList order line items
Parameters
- queries *GetEcommerceStoresIdOrdersIdLinesQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/orders/[string orderId]/lines
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/orders/[string orderId]/lines(ECommerceOrderLineItem payload, map<string|string[]> headers) returns ECommerceOrderLineItem3|errorAdd order line item
Parameters
- payload ECommerceOrderLineItem -
get ecommerce/stores/[string storeId]/orders/[string orderId]/lines/[string lineId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/orders/[string orderId]/lines/[string lineId](map<string|string[]> headers, *GetEcommerceStoresIdOrdersIdLinesIdQueries queries) returns ECommerceOrderLineItem3|errorGet order line item
Parameters
- queries *GetEcommerceStoresIdOrdersIdLinesIdQueries - Queries to be sent with the request
delete ecommerce/stores/[string storeId]/orders/[string orderId]/lines/[string lineId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/orders/[string orderId]/lines/[string lineId](map<string|string[]> headers) returns error?Delete order line item
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/orders/[string orderId]/lines/[string lineId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/orders/[string orderId]/lines/[string lineId](ECommerceOrderLineItem2 payload, map<string|string[]> headers) returns ECommerceOrderLineItem3|errorUpdate order line item
Parameters
- payload ECommerceOrderLineItem2 -
get ecommerce/stores/[string storeId]/products
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/products(map<string|string[]> headers, *GetEcommerceStoresIdProductsQueries queries) returns Products|errorList product
Parameters
- queries *GetEcommerceStoresIdProductsQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/products
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/products(ECommerceProduct payload, map<string|string[]> headers) returns ECommerceProduct2|errorAdd product
Parameters
- payload ECommerceProduct -
get ecommerce/stores/[string storeId]/products/[string productId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/products/[string productId](map<string|string[]> headers, *GetEcommerceStoresIdProductsIdQueries queries) returns ECommerceProduct2|errorGet product info
Parameters
- queries *GetEcommerceStoresIdProductsIdQueries - Queries to be sent with the request
put ecommerce/stores/[string storeId]/products/[string productId]
Isolated FunctionResource Function
function put ecommerce/stores/[string storeId]/products/[string productId](ECommerceProduct1 payload, map<string|string[]> headers) returns ECommerceProduct2|errorCreate or update product
Parameters
- payload ECommerceProduct1 -
delete ecommerce/stores/[string storeId]/products/[string productId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/products/[string productId](map<string|string[]> headers) returns error?Delete product
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/products/[string productId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/products/[string productId](ECommerceProduct3 payload, map<string|string[]> headers) returns ECommerceProduct2|errorUpdate product
Parameters
- payload ECommerceProduct3 -
get ecommerce/stores/[string storeId]/products/[string productId]/variants
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/products/[string productId]/variants(map<string|string[]> headers, *GetEcommerceStoresIdProductsIdVariantsQueries queries) returns EcommerceProductVariants|errorList product variants
Parameters
- queries *GetEcommerceStoresIdProductsIdVariantsQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/products/[string productId]/variants
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/products/[string productId]/variants(ECommerceProductVariant payload, map<string|string[]> headers) returns ECommerceProductVariant2|errorAdd product variant
Parameters
- payload ECommerceProductVariant -
get ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId](map<string|string[]> headers, *GetEcommerceStoresIdProductsIdVariantsIdQueries queries) returns ECommerceProductVariant2|errorGet product variant info
Parameters
- queries *GetEcommerceStoresIdProductsIdVariantsIdQueries - Queries to be sent with the request
put ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId]
Isolated FunctionResource Function
function put ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId](ECommerceProductVariant payload, map<string|string[]> headers) returns ECommerceProductVariant2|errorAdd or update product variant
Parameters
- payload ECommerceProductVariant -
delete ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId](map<string|string[]> headers) returns error?Delete product variant
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/products/[string productId]/variants/[string variantId](ECommerceProductVariant1 payload, map<string|string[]> headers) returns ECommerceProductVariant2|errorUpdate product variant
Parameters
- payload ECommerceProductVariant1 -
get ecommerce/stores/[string storeId]/products/[string productId]/images
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/products/[string productId]/images(map<string|string[]> headers, *GetEcommerceStoresIdProductsIdImagesQueries queries) returns EcommerceProductImages|errorList product images
Parameters
- queries *GetEcommerceStoresIdProductsIdImagesQueries - Queries to be sent with the request
post ecommerce/stores/[string storeId]/products/[string productId]/images
Isolated FunctionResource Function
function post ecommerce/stores/[string storeId]/products/[string productId]/images(ECommerceProductImage payload, map<string|string[]> headers) returns ECommerceProductImage2|errorAdd product image
Parameters
- payload ECommerceProductImage -
get ecommerce/stores/[string storeId]/products/[string productId]/images/[string imageId]
Isolated FunctionResource Function
function get ecommerce/stores/[string storeId]/products/[string productId]/images/[string imageId](map<string|string[]> headers, *GetEcommerceStoresIdProductsIdImagesIdQueries queries) returns ECommerceProductImage2|errorGet product image info
Parameters
- queries *GetEcommerceStoresIdProductsIdImagesIdQueries - Queries to be sent with the request
delete ecommerce/stores/[string storeId]/products/[string productId]/images/[string imageId]
Isolated FunctionResource Function
function delete ecommerce/stores/[string storeId]/products/[string productId]/images/[string imageId](map<string|string[]> headers) returns error?Delete product image
Return Type
- error? - Empty Response
patch ecommerce/stores/[string storeId]/products/[string productId]/images/[string imageId]
Isolated FunctionResource Function
function patch ecommerce/stores/[string storeId]/products/[string productId]/images/[string imageId](ECommerceProductImage1 payload, map<string|string[]> headers) returns ECommerceProductImage2|errorUpdate product image
Parameters
- payload ECommerceProductImage1 -
get search-campaigns
Isolated FunctionResource Function
function get search\-campaigns(map<string|string[]> headers, *GetSearchCampaignsQueries queries) returns Campaigns|errorSearch campaigns
Parameters
- queries *GetSearchCampaignsQueries - Queries to be sent with the request
get search-members
Isolated FunctionResource Function
function get search\-members(map<string|string[]> headers, *GetSearchMembersQueries queries) returns Members|errorSearch members
Parameters
- queries *GetSearchMembersQueries - Queries to be sent with the request
get ping
Isolated FunctionResource Function
function get ping(map<string|string[]> headers) returns APIHealthStatus|errorPing
get facebook-ads
Isolated FunctionResource Function
function get facebook\-ads(map<string|string[]> headers, *GetAllFacebookAdsQueries queries) returns InlineResponse20010|errorList facebook ads
Parameters
- queries *GetAllFacebookAdsQueries - Queries to be sent with the request
Return Type
- InlineResponse20010|error - List of Facebook Ad Instances
get facebook-ads/[string outreachId]
Isolated FunctionResource Function
function get facebook\-ads/[string outreachId](map<string|string[]> headers, *GetFacebookAdsIdQueries queries) returns InlineResponse20011|errorGet facebook ad info
Parameters
- queries *GetFacebookAdsIdQueries - Queries to be sent with the request
Return Type
- InlineResponse20011|error - Facebook Ad Instance
get reporting/facebook-ads
Isolated FunctionResource Function
function get reporting/facebook\-ads(map<string|string[]> headers, *GetReportingFacebookAdsQueries queries) returns InlineResponse20012|errorList facebook ads reports
Parameters
- queries *GetReportingFacebookAdsQueries - Queries to be sent with the request
Return Type
- InlineResponse20012|error - List of Facebook Ad Report Instances
get reporting/facebook-ads/[string outreachId]
Isolated FunctionResource Function
function get reporting/facebook\-ads/[string outreachId](map<string|string[]> headers, *GetReportingFacebookAdsIdQueries queries) returns InlineResponse20013|errorGet landing page report
Parameters
- queries *GetReportingFacebookAdsIdQueries - Queries to be sent with the request
Return Type
- InlineResponse20013|error - Landing Page Report Instance
get reporting/facebook-ads/[string outreachId]/ecommerce-product-activity
Isolated FunctionResource Function
function get reporting/facebook\-ads/[string outreachId]/ecommerce\-product\-activity(map<string|string[]> headers, *GetReportingFacebookAdsIdEcommerceProductActivityQueries queries) returns InlineResponse2009|errorList facebook ecommerce report
Parameters
- queries *GetReportingFacebookAdsIdEcommerceProductActivityQueries - Queries to be sent with the request
Return Type
- InlineResponse2009|error - Ecommerce Product Activity Instance
get reporting/landing-pages/[string outreachId]
Isolated FunctionResource Function
function get reporting/landing\-pages/[string outreachId](map<string|string[]> headers, *GetReportingLandingPagesIdQueries queries) returns LandingPageReport|errorGet landing page report
Parameters
- queries *GetReportingLandingPagesIdQueries - Queries to be sent with the request
Return Type
- LandingPageReport|error - Landing Page Report Instance
get reporting/landing-pages
Isolated FunctionResource Function
function get reporting/landing\-pages(map<string|string[]> headers, *GetReportingLandingPagesQueries queries) returns InlineResponse20014|errorList landing pages reports
Parameters
- queries *GetReportingLandingPagesQueries - Queries to be sent with the request
Return Type
- InlineResponse20014|error - List of Landing Page Report Instances
get reporting/surveys
Isolated FunctionResource Function
function get reporting/surveys(map<string|string[]> headers, *GetReportingSurveysQueries queries) returns InlineResponse20015|errorList survey reports
Parameters
- queries *GetReportingSurveysQueries - Queries to be sent with the request
Return Type
- InlineResponse20015|error - List of Survey Report Instances
get reporting/surveys/[string surveyId]
Isolated FunctionResource Function
function get reporting/surveys/[string surveyId](map<string|string[]> headers, *GetReportingSurveysIdQueries queries) returns SurveyReport|errorGet survey report
Parameters
- queries *GetReportingSurveysIdQueries - Queries to be sent with the request
Return Type
- SurveyReport|error - Survey Report Instance
get reporting/surveys/[string surveyId]/questions
Isolated FunctionResource Function
function get reporting/surveys/[string surveyId]/questions(map<string|string[]> headers, *GetReportingSurveysIdQuestionsQueries queries) returns InlineResponse20016|errorList survey question reports
Parameters
- queries *GetReportingSurveysIdQuestionsQueries - Queries to be sent with the request
Return Type
- InlineResponse20016|error - List of Survey Question Report Instances
get reporting/surveys/[string surveyId]/questions/[string questionId]
Isolated FunctionResource Function
function get reporting/surveys/[string surveyId]/questions/[string questionId](map<string|string[]> headers, *GetReportingSurveysIdQuestionsIdQueries queries) returns SurveyQuestionReport|errorGet survey question report
Parameters
- queries *GetReportingSurveysIdQuestionsIdQueries - Queries to be sent with the request
Return Type
- SurveyQuestionReport|error - Survey Question Report Instance
get reporting/surveys/[string surveyId]/questions/[string questionId]/answers
Isolated FunctionResource Function
function get reporting/surveys/[string surveyId]/questions/[string questionId]/answers(map<string|string[]> headers, *GetReportingSurveysIdQuestionsIdAnswersQueries queries) returns InlineResponse20017|errorList answers for question
Parameters
- queries *GetReportingSurveysIdQuestionsIdAnswersQueries - Queries to be sent with the request
Return Type
- InlineResponse20017|error - List of Survey Question Answers
get reporting/surveys/[string surveyId]/responses
Isolated FunctionResource Function
function get reporting/surveys/[string surveyId]/responses(map<string|string[]> headers, *GetReportingSurveysIdResponsesQueries queries) returns InlineResponse20018|errorList survey responses
Parameters
- queries *GetReportingSurveysIdResponsesQueries - Queries to be sent with the request
Return Type
- InlineResponse20018|error - List of survey responses
get reporting/surveys/[string surveyId]/responses/[string responseId]
Isolated FunctionResource Function
function get reporting/surveys/[string surveyId]/responses/[string responseId](map<string|string[]> headers) returns SurveyResponse|errorGet survey response
Return Type
- SurveyResponse|error - Get a single survey response
get verified-domains/[string domainName]
Isolated FunctionResource Function
function get verified\-domains/[string domainName](map<string|string[]> headers) returns VerifiedDomains|errorGet domain info
delete verified-domains/[string domainName]
Isolated FunctionResource Function
Delete domain
Return Type
- error? - Empty Response
post verified-domains/[string domainName]/actions/verify
Isolated FunctionResource Function
function post verified\-domains/[string domainName]/actions/verify(VerifyADomainForSending payload, map<string|string[]> headers) returns VerifiedDomains|errorVerify domain
Parameters
- payload VerifyADomainForSending -
Return Type
- VerifiedDomains|error - The domain being verified for sending
get verified-domains
Isolated FunctionResource Function
function get verified\-domains(map<string|string[]> headers) returns VerifiedDomains1|errorList sending domains
Return Type
- VerifiedDomains1|error - The domains on the account
post verified-domains
Isolated FunctionResource Function
function post verified\-domains(VerifiedDomains2 payload, map<string|string[]> headers) returns VerifiedDomains|errorAdd domain to account
Parameters
- payload VerifiedDomains2 -
Return Type
- VerifiedDomains|error - The newly-created domain
Records
mailchimp.marketing: AbandonedBrowseAutomation
abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web
Fields
- isSupported? boolean - Whether this store supports the abandonedBrowse automation
- id? string - Unique ID of automation parent campaign
- status? "save"|"sending"|"paused" - Status of the abandonedBrowse automation
mailchimp.marketing: AbandonedCartAutomation
abandonedCart automation details
Fields
- isSupported? boolean - Whether this store supports the abandonedCart automation
- id? string - Unique ID of automation parent campaign
- status? "save"|"sending"|"paused" - Status of the abandonedCart automation
mailchimp.marketing: ABSplit
A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns
Fields
- a? GroupA - Stats for Group A
- b? GroupB - Stats for Group B
mailchimp.marketing: ABSplitStats
General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns
Fields
- a? CampaignA - Stats for Campaign A
- b? CampaignB - Stats for Campaign B
mailchimp.marketing: ABTestingOptions
A/B Testing options for a campaign
Fields
- pickWinner? "opens"|"clicks"|"manual" - How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'
- waitTime? int - The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent
- waitUnits? "hours"|"days" - How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent
- subjectB? string - For campaigns split on 'Subject Line', the subject line for Group B
- subjectA? string - For campaigns split on 'Subject Line', the subject line for Group A
- splitTest? "subject"|"from_name"|"schedule" - The type of AB split to run
- fromNameA? string - For campaigns split on 'From Name', the name for Group A
- fromNameB? string - For campaigns split on 'From Name', the name for Group B
- sendTimeWinner? string - The send time for the winning version
- replyEmailB? string - For campaigns split on 'From Name', the reply-to address for Group B
- replyEmailA? string - For campaigns split on 'From Name', the reply-to address for Group A
- sendTimeA? string - The send time for Group A
- sendTimeB? string - The send time for Group B
- splitSize? int - The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50
mailchimp.marketing: ABTestOptions
The settings specific to A/B test campaigns
Fields
- sendTimes? string[] - The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored
- waitTime? int - The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes
- subjectLines? string[] - The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used
- testSize? int - The percentage of recipients to send the test combinations to, must be a value between 10 and 100
- replyToAddresses? string[] - The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used
- winnerCriteria "opens"|"clicks"|"manual"|"total_revenue" - The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application
- fromNames? string[] - The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used
mailchimp.marketing: ABTestOptions1
The settings specific to A/B test campaigns
Fields
- sendTimes? string[] - The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored
- combinations? ABTestOptions1Combinations[] - Combinations of possible variables used to build emails
- waitTime? int - The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes
- subjectLines? string[] - The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used
- contents? string[] - Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'
- testSize? int - The percentage of recipients to send the test combinations to, must be a value between 10 and 100
- winningCombinationId? string - ID for the winning combination
- replyToAddresses? string[] - The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used
- winnerCriteria "opens"|"clicks"|"manual"|"total_revenue" - The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application
- winningCampaignId? string - ID of the campaign that was sent to the remaining recipients based on the winning combination
- fromNames? string[] - The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used
mailchimp.marketing: ABTestOptions1Combinations
Fields
- subjectLine? int - The index of
variate_settings.subject_linesused
- sendTime? int - The index of
variate_settings.send_timesused
- replyTo? int - The index of
variate_settings.reply_to_addressesused
- recipients? int - The number of recipients for this combination
- id? string - Unique ID for the combination
- fromName? int - The index of
variate_settings.from_namesused
- contentDescription? int - The index of
variate_settings.contentsused
mailchimp.marketing: ABTestOptions2
The settings specific to A/B test campaigns
Fields
- sendTimes? string[] - The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored
- combinations? ABTestOptions1Combinations[] - Combinations of possible variables used to build emails
- waitTime? int - The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes
- subjectLines? string[] - The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used
- contents? string[] - Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'
- testSize? int - The percentage of recipients to send the test combinations to, must be a value between 10 and 100
- winningCombinationId? string - ID for the winning combination
- replyToAddresses? string[] - The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used
- winnerCriteria? "opens"|"clicks"|"manual"|"total_revenue" - The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application
- winningCampaignId? string - ID of the campaign that was sent to the remaining recipients based on the winning combination
- fromNames? string[] - The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used
mailchimp.marketing: AbuseComplaint
Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- date? string - Date for the abuse report
- emailAddress? string - Email address for a subscriber
- listId? string - The list id for the abuse report
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- id? int - The id for the abuse report
- vip? boolean - VIP status for subscriber
- campaignId? string - The campaign id for the abuse report
mailchimp.marketing: AbuseComplaint1
Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- date? string - Date for the abuse report
- emailAddress? string - Email address for a subscriber
- listId? string - The unique id of the list for the abuse report
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- id? int - The id for the abuse report
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- vip? boolean - VIP status for subscriber
- campaignId? string - The campaign id for the abuse report
mailchimp.marketing: AbuseComplaint2
Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- date? string - Date for the abuse report
- emailAddress? string - Email address for a subscriber
- listId? string - The list id for the abuse report
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- id? int - The id for the abuse report
- vip? boolean - VIP status for subscriber
- campaignId? string - The campaign id for the abuse report
mailchimp.marketing: AbuseComplaint3
Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- date? string - Date for the abuse report
- emailAddress? string - Email address for a subscriber
- listId? string - The unique id of the list for the abuse report
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- id? int - The id for the abuse report
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- vip? boolean - VIP status for subscriber
- campaignId? string - The campaign id for the abuse report
mailchimp.marketing: AbuseComplaints
A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program
Fields
- listId? string - The list id for the abuse report
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- abuseReports? AbuseComplaint2[] - An array of objects, each representing an abuse report resource
mailchimp.marketing: AbuseComplaints1
A list of abuse complaints for a specific list
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- abuseReports? AbuseComplaint3[] - An array of objects, each representing an abuse report resource
- campaignId? string - The campaign id
mailchimp.marketing: AccountContact
Information about the account contact
Fields
- zip? string - The zip code for the account contact
- country? string - The country for the account contact
- addr2? string - The street address for the account contact
- addr1? string - The street address for the account contact
- city? string - The city for the account contact
- company? string - The company name for the account
- state? string - The state for the account contact
mailchimp.marketing: ActionsCreateResendBody
Fields
- shortcutType? "to_non_openers"|"to_new_subscribers"|"to_non_clickers"|"to_non_purchasers" - Which campaign resend shortcut to use. Default is
to_non_openers
mailchimp.marketing: ActionsScheduleBody
Fields
- scheduleTime string - The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45)
- batchDelivery? BatchDelivery -
- timewarp? boolean - Choose whether the campaign should use Timewarp when sending. Campaigns scheduled with Timewarp are localized based on the recipients' time zones. For example, a Timewarp campaign with a
schedule_timeof 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set totruefor campaigns using Batch Delivery
mailchimp.marketing: ActionsTestBody
Fields
- testEmails string[] - An array of email addresses to send the test email to
- sendType "html"|"plaintext" - Choose the type of test email to send
mailchimp.marketing: AddListMembers
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- emailAddress? string - Email address for a subscriber
- emailType? string - Type of email this member asked to get ('html' or 'text')
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- language? string - If set/detected, the subscriber's language
- location? Location - Subscriber location information
- ipSignup? string - IP address the subscriber signed up from
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- vip? boolean - VIP status for subscriber
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional" - Subscriber's current status
mailchimp.marketing: AddListMembers1
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- marketingPermissions? MarketingPermission[] - The marketing permissions for the subscriber
- emailType? string - Type of email this member asked to get ('html' or 'text')
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- language? string - If set/detected, the subscriber's language
- ipSignup? string - IP address the subscriber signed up from
- emailAddress string - Email address for a subscriber
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- location? Location - Subscriber location information
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- vip? boolean - VIP status for subscriber
- status "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional" - Subscriber's current status
mailchimp.marketing: AddListMembers2
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- marketingPermissions? MarketingPermission[] - The marketing permissions for the subscriber
- emailType? string - Type of email this member asked to get ('html' or 'text')
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- language? string - If set/detected, the subscriber's language
- ipSignup? string - IP address the subscriber signed up from
- emailAddress string - Email address for a subscriber. This value is required only if the email address is not already present on the list
- statusIfNew "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional" - Subscriber's status. This value is required only if the email address is not already present on the list
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- location? Location - Subscriber location information
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- vip? boolean - VIP status for subscriber
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional" - Subscriber's current status
mailchimp.marketing: AddListMembers3
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- marketingPermissions? MarketingPermission[] - The marketing permissions for the subscriber
- emailType? string - Type of email this member asked to get ('html' or 'text')
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- language? string - If set/detected, the subscriber's language
- ipSignup? string - IP address the subscriber signed up from
- emailAddress? string - Email address for a subscriber
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- location? Location - Subscriber location information
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- vip? boolean - VIP status for subscriber
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending" - Subscriber's current status
mailchimp.marketing: Address
The store address
Fields
- country? string - The store's country
- countryCode? string - The two-letter code for to the store's country
- province? string - The store's state name or normalized province
- address2? string - An additional field for the store's mailing address
- city? string - The city the store is located in
- address1? string - The store's mailing address
- latitude? decimal - The latitude of the store location
- provinceCode? string - The two-letter code for the store's province or state
- postalCode? string - The store's postal or zip code
- longitude? decimal - The longitude of the store location
mailchimp.marketing: Address1
The customer's address
Fields
- country? string - The customer's country
- countryCode? string - The two-letter code for the customer's country
- province? string - The customer's state name or normalized province
- address2? string - An additional field for the customer's mailing address
- city? string - The city the customer is located in
- address1? string - The mailing address of the customer
- provinceCode? string - The two-letter code for the customer's province or state
- postalCode? string - The customer's postal or zip code
mailchimp.marketing: Address2
The customer's address
Fields
- country? string - The customer's country
- countryCode? string - The two-letter code for the customer's country
- province? string - The customer's state name or normalized province
- address2? string - An additional field for the customer's mailing address
- city? string - The city the customer is located in
- address1? string - The mailing address of the customer
- provinceCode? string - The two-letter code for the customer's province or state
- postalCode? string - The customer's postal or zip code
mailchimp.marketing: AddWebhook
Configure a webhook for the given list
Fields
- sources? Sources - The possible sources of any events that can trigger the webhook and whether they are enabled
- url? string - A valid URL for the Webhook
- events? Events1 - The events that can trigger the webhook and whether they are enabled
mailchimp.marketing: AnOptionForSignupFormStyles
An option for Signup Form Styles
Fields
- property? string - A string that identifies the property
- value? string - A string that identifies value of the property
mailchimp.marketing: APIHealthStatus
API health status
Fields
- healthStatus? string - This will return a constant string value if the request is successful. Ex. "Everything's Chimpy!"
mailchimp.marketing: APIRoot
The API root resource links to all other resources available in the API
Fields
- memberSince? string - The date and time that the account was created in ISO 8601 format
- loginId? string - The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account
- proEnabled? boolean - Legacy - whether the account includes Mailchimp Pro
- firstPayment? string - Date of first payment for monthly plans
- pricingPlanType? "monthly"|"pay_as_you_go"|"forever_free" - The type of pricing plan the account is on
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- lastLogin? string - The date and time of the last login for this account in ISO 8601 format
- lastName? string - The last name tied to the account
- industryStats? IndustryStats1 -
- accountId? string - The Mailchimp account ID
- avatarUrl? string - URL of the avatar for the user
- accountName? string - The name of the account
- contact? AccountContact - Information about the account contact
- accountIndustry? string - The user-specified industry associated with the account
- firstName? string - The first name tied to the account
- email? string - The account email address
- accountTimezone? string - The timezone currently set for the account
- totalSubscribers? int - The total number of subscribers across all lists in the account
- username? string - The username tied to the account
mailchimp.marketing: AutomationCampaignSettings
The settings for the Automation workflow
Fields
- replyTo? string - The reply-to email address for the Automation
- fromName? string - The 'from' name for the Automation (not an email address)
mailchimp.marketing: AutomationCampaignSettings1
The settings for the Automation workflow
Fields
- useConversation? boolean - Whether to use Mailchimp Conversation feature to manage replies
- authenticate? boolean - Whether Mailchimp authenticated the Automation. Defaults to
true
- replyTo? string - The reply-to email address for the Automation
- toName? string - The Automation's custom 'To' name, typically the first name audience field
- inlineCss? boolean - Whether to automatically inline the CSS included with the Automation content
- title? string - The title of the Automation
- fromName? string - The 'from' name for the Automation (not an email address)
mailchimp.marketing: AutomationDelay
The delay settings for an automation email
Fields
- amount? int - The delay amount for an automation email
- action "signup"|"ecomm_abandoned_browse"|"ecomm_abandoned_cart" - The action that triggers the delay of an automation emails
- 'type? "now"|"day"|"hour"|"week" - The type of delay for an automation email
- direction? "after" - Whether the delay settings describe before or after the delay action of an automation email
mailchimp.marketing: AutomationDelay1
The delay settings for an Automation email
Fields
- amount? int - The delay amount for an Automation email
- fullDescription? string - The user-friendly description of the delay and trigger action settings for an Automation email
- actionDescription? string - The user-friendly description of the action that triggers an Automation email
- action? "previous_campaign_sent"|"previous_campaign_opened"|"previous_campaign_not_opened"|"previous_campaign_clicked_any"|"previous_campaign_not_clicked_any"|"previous_campaign_specific_clicked"|"ecomm_bought_any"|"ecomm_bought_product"|"ecomm_bought_category"|"ecomm_not_bought_any"|"ecomm_abandoned_cart"|"campaign_sent"|"opened_email"|"not_opened_email"|"clicked_email"|"not_clicked_email"|"campaign_specific_clicked"|"manual"|"signup"|"merge_changed"|"group_add"|"group_remove"|"mandrill_sent"|"mandrill_opened"|"mandrill_clicked"|"mandrill_any"|"api"|"goal"|"annual"|"birthday"|"date"|"date_added"|"tag_add" - The action that triggers the delay of an Automation email
- 'type? "now"|"day"|"hour"|"week" - The type of delay for an Automation email
- direction? "before"|"after" - Whether the delay settings describe before or after the delay action of an Automation email
mailchimp.marketing: AutomationEmails
A summary of the emails in an Automation workflow
Fields
- emails? AutomationWorkflowEmail1[] - An array of objects, each representing an email in an Automation workflow
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: Automations
Details for the automations attached to this store
Fields
- abandonedBrowse? AbandonedBrowseAutomation -
- abandonedCart? AbandonedCartAutomation -
mailchimp.marketing: AutomationTrackingOptions
The tracking options for the Automation
Fields
- salesforce? SalesforceCRMTracking1 - Deprecated
- goalTracking? boolean - Deprecated
- capsule? CapsuleCRMTracking2 - Deprecated
- textClicks? boolean - Whether to track clicks in the plain-text version of the Automation. Defaults to
true
- ecomm360? boolean - Whether to enable e-commerce tracking
- opens? boolean - Whether to track opens. Defaults to
true
- googleAnalytics? string - The custom slug for Google Analytics tracking (max of 50 bytes)
- htmlClicks? boolean - Whether to track clicks in the HTML version of the Automation. Defaults to
true
mailchimp.marketing: AutomationTrigger
Trigger settings for the Automation
Fields
- workflowType string - The type of Automation workflow. Currently only supports 'abandonedCart'
mailchimp.marketing: AutomationTrigger1
Available triggers for Automation workflows
Fields
- runtime? AutomationWorkflowRuntimeSettings - A workflow's runtime settings for an Automation
- workflowEmailsCount? int - The number of emails in the Automation workflow
- workflowType "abandonedBrowse"|"abandonedCart"|"api"|"bestCustomers"|"categoryFollowup"|"dateAdded"|"emailFollowup"|"emailSeries"|"groupAdd"|"groupRemove"|"mandrill"|"productFollowup"|"purchaseFollowup"|"recurringEvent"|"specialEvent"|"visitUrl"|"welcomeSeries" - The type of Automation workflow
- workflowTitle? string - The title of the workflow type
mailchimp.marketing: AutomationWorkflow
A summary of an individual Automation workflow's settings and content
Fields
- settings? AutomationCampaignSettings - The settings for the Automation workflow
- recipients List - List settings for the Automation
- triggerSettings AutomationTrigger -
mailchimp.marketing: AutomationWorkflow1
A summary of an individual Automation workflow's settings and content
Fields
- startTime? string - The date and time the Automation was started in ISO 8601 format
- settings? AutomationCampaignSettings1 - The settings for the Automation workflow
- createTime? string - The date and time the Automation was created in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- recipients? List10 - List settings for the Automation
- emailsSent? int - The total number of emails sent for the Automation
- triggerSettings? AutomationTrigger1 -
- id? string - A string that identifies the Automation
- tracking? AutomationTrackingOptions - The tracking options for the Automation
- status? "save"|"paused"|"sending" - The current status of the Automation
- reportSummary? CampaignReportSummary3 -
mailchimp.marketing: AutomationWorkflow2
A summary of an individual Automation workflow's settings and content
Fields
- startTime? string - The date and time the Automation was started in ISO 8601 format
- settings? AutomationCampaignSettings1 - The settings for the Automation workflow
- createTime? string - The date and time the Automation was created in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- recipients? List10 - List settings for the Automation
- emailsSent? int - The total number of emails sent for the Automation
- triggerSettings? AutomationTrigger1 -
- id? string - A string that identifies the Automation
- tracking? AutomationTrackingOptions - The tracking options for the Automation
- status? "save"|"paused"|"sending" - The current status of the Automation
- reportSummary? CampaignReportSummary3 -
mailchimp.marketing: AutomationWorkflowEmail
A summary of an individual Automation workflow email
Fields
- archiveUrl? string - The link to the campaign's archive version in ISO 8601 format
- settings? CampaignSettings3 - Settings for the campaign including the email subject, from name, and from email address
- workflowId? string - A string that uniquely identifies an Automation workflow
- createTime? string - The date and time the campaign was created in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- triggerSettings? AutomationTrigger1 -
- webId? int - The ID used in the Mailchimp web application. View this automation in your Mailchimp account at
https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- tracking? CampaignTrackingOptions1 - The tracking options for a campaign
- needsBlockRefresh? boolean - Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor
- startTime? string - The date and time the campaign was started in ISO 8601 format
- delay? AutomationDelay1 - The delay settings for an Automation email
- sendTime? string - The date and time a campaign was sent in ISO 8601 format
- contentType? string - How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')
- recipients? List6 - List settings for the campaign
- emailsSent? int - The total number of emails sent for this campaign
- id? string - A string that uniquely identifies the Automation email
- position? int - The position of an Automation email in a workflow
- hasLogoMergeTag? boolean - Determines if the campaign contains the |BRAND:LOGO| merge tag
- status? "save"|"paused"|"sending" - The current status of the campaign
- reportSummary? CampaignReportSummary -
mailchimp.marketing: AutomationWorkflowEmail1
A summary of an individual Automation workflow email
Fields
- archiveUrl? string - The link to the campaign's archive version in ISO 8601 format
- settings? CampaignSettings3 - Settings for the campaign including the email subject, from name, and from email address
- workflowId? string - A string that uniquely identifies an Automation workflow
- createTime? string - The date and time the campaign was created in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- triggerSettings? AutomationTrigger1 -
- webId? int - The ID used in the Mailchimp web application. View this automation in your Mailchimp account at
https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- tracking? CampaignTrackingOptions1 - The tracking options for a campaign
- needsBlockRefresh? boolean - Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor
- startTime? string - The date and time the campaign was started in ISO 8601 format
- delay? AutomationDelay1 - The delay settings for an Automation email
- sendTime? string - The date and time a campaign was sent in ISO 8601 format
- contentType? string - How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')
- recipients? List6 - List settings for the campaign
- emailsSent? int - The total number of emails sent for this campaign
- id? string - A string that uniquely identifies the Automation email
- position? int - The position of an Automation email in a workflow
- hasLogoMergeTag? boolean - Determines if the campaign contains the |BRAND:LOGO| merge tag
- status? "save"|"paused"|"sending" - The current status of the campaign
- reportSummary? CampaignReportSummary -
mailchimp.marketing: AutomationWorkflowRuntimeSettings
A workflow's runtime settings for an Automation
Fields
- hours? Hours - The hours an Automation workflow can send
- days? ("sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday")[] - The days an Automation workflow can send
mailchimp.marketing: Batch
The status of a batch request
Fields
- finishedOperations? int - The number of completed operations. This includes operations that returned an error
- completedAt? string - The date and time when all operations in the batch request completed in ISO 8601 format
- submittedAt? string - The date and time when the server received the batch request in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalOperations? int - The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation
- erroredOperations? int - The number of completed operations that returned an error
- id? string - A string that uniquely identifies this batch request
- responseBodyUrl? string - The URL of the gzipped archive of the results of all the operations
- status? "pending"|"preprocessing"|"started"|"finalizing"|"finished" - The status of the batch call. Learn more about the batch operation status
mailchimp.marketing: Batch1
The status of a batch request
Fields
- finishedOperations? int - The number of completed operations. This includes operations that returned an error
- completedAt? string - The date and time when all operations in the batch request completed in ISO 8601 format
- submittedAt? string - The date and time when the server received the batch request in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalOperations? int - The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation
- erroredOperations? int - The number of completed operations that returned an error
- id? string - A string that uniquely identifies this batch request
- responseBodyUrl? string - The URL of the gzipped archive of the results of all the operations
- status? "pending"|"preprocessing"|"started"|"finalizing"|"finished" - The status of the batch call. Learn more about the batch operation status
mailchimp.marketing: BatchAddremoveListMembersTofromStaticSegment
Batch add/remove List members to/from static segment
Fields
- membersRemoved? ListMembers5[] - An array of objects, each representing an existing list member that got deleted from the static segment
- totalAdded? int - The total number of items matching the query, irrespective of pagination
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- membersAdded? ListMembers5[] - An array of objects, each representing a new member that was added to the static segment
- totalRemoved? int - The total number of items matching the query, irrespective of pagination
- errorCount? int - The total number of items matching the query, irrespective of pagination
- errors? BatchAddremoveListMembersTofromStaticSegmentErrors[] - An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details
mailchimp.marketing: BatchAddremoveListMembersTofromStaticSegmentErrors
Fields
- emailAddresses? string[] - Email addresses added to the static segment or removed
- 'error? string - The error message indicating why the email addresses could not be added or updated
mailchimp.marketing: BatchDelivery
Choose whether the campaign should use Batch Delivery. Cannot be set to true for campaigns using Timewarp
Fields
- batchDelay int - The delay, in minutes, between batches
- batchCount int - The number of batches for the campaign send
mailchimp.marketing: BatchesBody
Fields
- operations Operations[] - An array of objects that describes operations to perform
mailchimp.marketing: BatchOperations
A summary of batch requests that have been made
Fields
- batches? Batch1[] - An array of objects representing batch calls
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: BatchUpdateListMembers
Batch update list members
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- newMembers? ListMembers5[] - An array of objects, each representing a new member that was added to the list
- updatedMembers? ListMembers5[] - An array of objects, each representing an existing list member whose subscription status was updated
- totalCreated? int - The total number of items matching the query, irrespective of pagination
- errorCount? int - The total number of items matching the query, irrespective of pagination
- errors? BatchUpdateListMembersErrors[] - An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details
- totalUpdated? int - The total number of items matching the query, irrespective of pagination
mailchimp.marketing: BatchUpdateListMembersErrors
Fields
- emailAddress? string - The email address that could not be added or updated
- 'field? string - If the error is field-related, information about which field is at issue
- errorCode? "ERROR_CONTACT_EXISTS"|"ERROR_GENERIC" - A unique code that identifies this specifc error
- 'error? string - The error message indicating why the email address could not be added or updated
- fieldMessage? string - Message indicating how to resolve a field-related error
mailchimp.marketing: BatchWebhook
Add a new Batch Webook
Fields
- url string - A valid URL for the Webhook
- enabled? boolean - Whether the webhook receives requests or not
mailchimp.marketing: BatchWebhook1
A webhook configured for batch status updates
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - A string that uniquely identifies this Batch Webhook
- url? string - A valid URL for the Webhook
- enabled? boolean - Whether the webhook receives requests or not
mailchimp.marketing: BatchWebhook2
Update an existing Batch Webook
Fields
- url? string - A valid URL for the Webhook
- enabled? boolean - Whether the webhook receives requests or not
mailchimp.marketing: BatchWebhook3
A webhook configured for batch status updates
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - A string that uniquely identifies this Batch Webhook
- url? string - A valid URL for the Webhook
- enabled? boolean - Whether the webhook receives requests or not
mailchimp.marketing: BatchWebhooks
Manage webhooks for batch requests
Fields
- webhooks? BatchWebhook3[] - An array of objects, each representing a Batch Webhook
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: BillingAddress
The billing address for the order
Fields
- country? string - The country in the billing address
- address2? string - An additional field for the billing address
- city? string - The city in the billing address
- address1? string - The billing address for the order
- latitude? decimal - The latitude for the billing address location
- provinceCode? string - The two-letter code for the province in the billing address
- countryCode? string - The two-letter code for the country in the billing address
- province? string - The state or normalized province in the billing address
- phone? string - The phone number for the billing address
- name? string - The name associated with the billing address
- company? string - The company associated with the billing address
- postalCode? string - The postal or zip code in the billing address
- longitude? decimal - The longitude for the billing address location
mailchimp.marketing: BillingAddress1
The billing address for the order
Fields
- country? string - The country in the billing address
- address2? string - An additional field for the billing address
- city? string - The city in the billing address
- address1? string - The billing address for the order
- latitude? decimal - The latitude for the billing address location
- provinceCode? string - The two-letter code for the province in the billing address
- countryCode? string - The two-letter code for the country in the billing address
- province? string - The state or normalized province in the billing address
- phone? string - The phone number for the billing address
- name? string - The name associated with the billing address
- company? string - The company associated with the billing address
- postalCode? string - The postal or zip code in the billing address
- longitude? decimal - The longitude for the billing address location
mailchimp.marketing: BillingAddress2
The billing address for the order
Fields
- country? string - The country in the billing address
- address2? string - An additional field for the billing address
- city? string - The city in the billing address
- address1? string - The billing address for the order
- latitude? decimal - The latitude for the billing address location
- provinceCode? string - The two-letter code for the province or state in the billing address
- countryCode? string - The two-letter code for the country in the billing address
- province? string - The state or normalized province in the billing address
- phone? string - The phone number for the billing address
- name? string - The name associated with an order's billing address
- company? string - The company associated with the billing address
- postalCode? string - The postal or zip code in the billing address
- longitude? decimal - The longitude for the billing address location
mailchimp.marketing: Bounces
An object describing the bounce summary for the campaign
Fields
- hardBounces? int - The total number of hard bounced email addresses
- syntaxErrors? int - The total number of addresses that were syntax-related bounces
- softBounces? int - The total number of soft bounced email addresses
mailchimp.marketing: Campaign
A summary of an individual campaign's settings and content
Fields
- settings? CampaignSettings1 - The settings for your campaign, including subject, from name, reply-to address, and more
- variateSettings? ABTestOptions -
- rssOpts? RSSOptions -
- contentType? "template"|"multichannel" - How the campaign's content is put together. The old drag and drop editor uses 'template' while the new editor uses 'multichannel'. Defaults to template
- recipients? List1 - List settings for the campaign
- 'type "regular"|"plaintext"|"absplit"|"rss"|"variate" - There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead
- tracking? CampaignTrackingOptions - The tracking options for a campaign
mailchimp.marketing: Campaign1
A summary of an individual campaign's settings and content
Fields
- resendable? boolean - Determines if the campaign qualifies to be resent to non-openers
- abSplitOpts? ABTestingOptions -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- resendShortcutUsage? ResendShortcutUsage -
- 'type? "regular"|"plaintext"|"absplit"|"rss"|"variate" - There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead
- tracking? CampaignTrackingOptions - The tracking options for a campaign
- parentCampaignId? string - If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children
- contentType? "template"|"html"|"url"|"multichannel" - How the campaign's content is put together
- emailsSent? int - The total number of emails sent for this campaign
- id? string - A string that uniquely identifies this campaign
- longArchiveUrl? string - The original link to the campaign's archive version
- archiveUrl? string - The link to the campaign's archive version in ISO 8601 format
- settings? CampaignSettings5 - The settings for your campaign, including subject, from name, reply-to address, and more
- variateSettings? ABTestOptions2 -
- createTime? string - The date and time the campaign was created in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at
https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- needsBlockRefresh? boolean - Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false
- sendTime? string - The date and time a campaign was sent
- rssOpts? RSSOptions3 -
- recipients? List8 - List settings for the campaign
- deliveryStatus? CampaignDeliveryStatus -
- status? "save"|"paused"|"schedule"|"sending"|"sent"|"canceled"|"canceling"|"archived" - The current status of the campaign
- reportSummary? CampaignReportSummary2 -
- resendShortcutEligibility? ResendShortcutEligibility -
mailchimp.marketing: Campaign2
A summary of an individual campaign's settings and content
Fields
- settings CampaignSettings2 - The settings for your campaign, including subject, from name, reply-to address, and more
- variateSettings? ABTestOptions -
- rssOpts? RSSOptions1 -
- recipients? List2 - List settings for the campaign
- tracking? CampaignTrackingOptions - The tracking options for a campaign
mailchimp.marketing: Campaign3
A summary of an individual campaign's settings and content
Fields
- archiveUrl? string - The link to the campaign's archive version
- resendable? boolean - Determines if the campaign qualifies to be resent to non-openers
- settings? CampaignSettings4 - The settings for your campaign, including subject, from name, reply-to address, and more
- variateSettings? ABTestOptions1 -
- abSplitOpts? ABTestingOptions -
- createTime? string - The date and time the campaign was created in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- webId? int - The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at
https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- 'type "regular"|"plaintext"|"absplit"|"rss"|"variate" - There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead
- tracking? CampaignTrackingOptions - The tracking options for a campaign
- needsBlockRefresh? boolean - Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false
- sendTime? string - The date and time a campaign was sent in ISO 8601 format
- rssOpts? RSSOptions2 -
- parentCampaignId? string - If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children
- contentType? string - How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')
- recipients? List7 - List settings for the campaign
- emailsSent? int - The total number of emails sent for this campaign
- id? string - A string that uniquely identifies this campaign
- deliveryStatus? CampaignDeliveryStatus -
- longArchiveUrl? string - The original link to the campaign's archive version
- status? "save"|"paused"|"schedule"|"sending"|"sent"|"canceled"|"canceling"|"archived" - The current status of the campaign
- reportSummary? CampaignReportSummary1 -
mailchimp.marketing: Campaign4
A summary of an individual campaign's settings and content
Fields
- resendable? boolean - Determines if the campaign qualifies to be resent to non-openers
- abSplitOpts? ABTestingOptions -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- resendShortcutUsage? ResendShortcutUsage -
- 'type? "regular"|"plaintext"|"absplit"|"rss"|"variate" - There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead
- tracking? CampaignTrackingOptions - The tracking options for a campaign
- parentCampaignId? string - If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children
- contentType? "template"|"html"|"url"|"multichannel" - How the campaign's content is put together
- emailsSent? int - The total number of emails sent for this campaign
- id? string - A string that uniquely identifies this campaign
- longArchiveUrl? string - The original link to the campaign's archive version
- archiveUrl? string - The link to the campaign's archive version in ISO 8601 format
- settings? CampaignSettings5 - The settings for your campaign, including subject, from name, reply-to address, and more
- variateSettings? ABTestOptions2 -
- createTime? string - The date and time the campaign was created in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at
https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- needsBlockRefresh? boolean - Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false
- sendTime? string - The date and time a campaign was sent
- rssOpts? RSSOptions3 -
- recipients? List8 - List settings for the campaign
- deliveryStatus? CampaignDeliveryStatus -
- status? "save"|"paused"|"schedule"|"sending"|"sent"|"canceled"|"canceling"|"archived" - The current status of the campaign
- reportSummary? CampaignReportSummary2 -
- resendShortcutEligibility? ResendShortcutEligibility -
mailchimp.marketing: CampaignA
Stats for Campaign A
Fields
- forwards? int - Forwards for Campaign A
- unsubs? int - Unsubscribes for Campaign A
- opens? int - Opens for Campaign A
- bounces? int - Bounces for Campaign A
- recipientClicks? int - Recipient Clicks for Campaign A
- forwardsOpens? int - Opens from forwards for Campaign A
- lastOpen? string - The last open for Campaign A
- abuseReports? int - Abuse reports for Campaign A
- uniqueOpens? int - Unique opens for Campaign A
mailchimp.marketing: CampaignAdvice
Campaign feedback details
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- 'type? "negative"|"positive"|"neutral" - The sentiment type for a feedback message
- message? string - The advice message
mailchimp.marketing: CampaignAdviceReport
A list of feedback based on a campaign's statistics
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- advice? CampaignAdvice[] - An array of objects, each representing a point of campaign feedback
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The campaign id
mailchimp.marketing: CampaignB
Stats for Campaign B
Fields
- forwards? int - Forwards for Campaign B
- unsubs? int - Unsubscribes for Campaign B
- opens? int - Opens for Campaign B
- bounces? int - Bounces for Campaign B
- recipientClicks? int - Recipients clicks for Campaign B
- forwardsOpens? int - Opens for forwards from Campaign B
- lastOpen? string - The last open for Campaign B
- abuseReports? int - Abuse reports for Campaign B
- uniqueOpens? int - Unique opens for Campaign B
mailchimp.marketing: CampaignContent
The HTML and plain-text content for a campaign
Fields
- archiveHtml? string - The Archive HTML for the campaign
- plainText? string - The plain-text portion of the campaign. If left unspecified, we'll generate this automatically
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- variateContents? CampaignContentVariateContents[] - Content options for multivariate campaigns
- html? string - The raw HTML for the campaign
mailchimp.marketing: CampaignContent1
The HTML and plain-text content for a campaign
Fields
- template? TemplateContent - Use this template to generate the HTML content of the campaign
- plainText? string - The plain-text portion of the campaign. If left unspecified, we'll generate this automatically
- variateContents? CampaignscampaignIdcontentVariateContents[] - Content options for Multivariate Campaigns. Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided
- html? string - The raw HTML for the campaign
- archive? UploadArchive - Available when uploading an archive to create campaign content. The archive should include all campaign content and images. Learn more
- url? string - When importing a campaign, the URL where the HTML lives
mailchimp.marketing: CampaignContentVariateContents
Fields
- contentLabel? string - Label used to identify the content option
- plainText? string - The plain-text portion of the campaign. If left unspecified, we'll generate this automatically
- html? string - The raw HTML for the campaign
mailchimp.marketing: CampaignDefaults
Default values for campaigns created for this list
Fields
- fromEmail string - The default from email for campaigns sent to this list
- subject string - The default subject line for campaigns sent to this list
- language string - The default language for this lists's forms
- fromName string - The default from name for campaigns sent to this list
mailchimp.marketing: CampaignDefaults1
Default values for campaigns created for this list
Fields
- fromEmail? string - The default from email for campaigns sent to this list
- subject? string - The default subject line for campaigns sent to this list
- language? string - The default language for this lists's forms
- fromName? string - The default from name for campaigns sent to this list
mailchimp.marketing: CampaignDeliveryStatus
Updates on campaigns in the process of sending
Fields
- emailsSent? int - The total number of emails confirmed sent for this campaign so far
- canCancel? boolean - Whether a campaign send can be canceled
- emailsCanceled? int - The total number of emails canceled for this campaign
- enabled? boolean - Whether Campaign Delivery Status is enabled for this account and campaign
- status? "delivering"|"delivered"|"canceling"|"canceled" - The current state of a campaign delivery
mailchimp.marketing: CampaignFeedback
A specific feedback message from a specific campaign
Fields
- isComplete? boolean - The status of feedback
- message string - The content of the feedback
- blockId? int - The block id for the editable block that the feedback addresses
mailchimp.marketing: CampaignFeedback1
A specific feedback message from a specific campaign
Fields
- updatedAt? string - The date and time the feedback was last updated in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- parentId? int - If a reply, the id of the parent feedback item
- feedbackId? int - The individual id for the feedback item
- createdAt? string - The date and time the feedback item was created in ISO 8601 format
- isComplete? boolean - The status of feedback
- 'source? "api"|"email"|"sms"|"web"|"ios"|"android" - The source of the feedback
- message? string - The content of the feedback
- createdBy? string - The login name of the user who created the feedback
- blockId? int - The block id for the editable block that the feedback addresses
- campaignId? string - The unique id for the campaign
mailchimp.marketing: CampaignFeedback2
A specific feedback message from a specific campaign
Fields
- isComplete? boolean - The status of feedback
- message? string - The content of the feedback
- blockId? int - The block id for the editable block that the feedback addresses
mailchimp.marketing: CampaignFeedback3
A specific feedback message from a specific campaign
Fields
- updatedAt? string - The date and time the feedback was last updated in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- parentId? int - If a reply, the id of the parent feedback item
- feedbackId? int - The individual id for the feedback item
- createdAt? string - The date and time the feedback item was created in ISO 8601 format
- isComplete? boolean - The status of feedback
- 'source? "api"|"email"|"sms"|"web"|"ios"|"android" - The source of the feedback
- message string - The content of the feedback
- createdBy? string - The login name of the user who created the feedback
- blockId? int - The block id for the editable block that the feedback addresses
- campaignId? string - The unique id for the campaign
mailchimp.marketing: CampaignFolder
A folder used to organize campaigns
Fields
- name string - Name to associate with the folder
mailchimp.marketing: CampaignFolder1
A folder used to organize campaigns
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the folder
- count? int - The number of campaigns in the folder
- id? string - A string that uniquely identifies this campaign folder
mailchimp.marketing: CampaignFolder2
A folder used to organize campaigns
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the folder
- count? int - The number of campaigns in the folder
- id? string - A string that uniquely identifies this campaign folder
mailchimp.marketing: CampaignFolders
A list of campaign folders
Fields
- folders? CampaignFolder2[] - An array of objects representing campaign folders
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: CampaignReport
Report details about a sent campaign
Fields
- forwards? Forwards - An object describing the forwards and forward activity for the campaign
- previewText? string - The preview text for the campaign
- listId? string - The unique list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- rssLastSend? string - For RSS campaigns, the date and time of the last send in ISO 8601 format
- listName? string - The name of the list
- 'type? string - The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- industryStats? IndustryStats -
- listStats? ListStats -
- campaignTitle? string - The title of the campaign
- facebookLikes? FacebookLikes -
- timeseries? CampaignSubReportsTimeseries[] - An hourly breakdown of the performance of the campaign over the first 24 hours
- emailsSent? int - The total number of emails sent for this campaign
- ecommerce? ECommerceReport - E-Commerce stats for a campaign
- id? string - A string that uniquely identifies this campaign
- bounces? Bounces - An object describing the bounce summary for the campaign
- subjectLine? string - The subject line for the campaign
- abSplit? ABSplitStats -
- timewarp? CampaignSubReportsTimewarp[] - An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp
- unsubscribed? int - The total number of unsubscribed members for this campaign
- sendTime? string - The date and time a campaign was sent in ISO 8601 format
- opens? Opens - An object describing the open activity for the campaign
- clicks? Clicks - An object describing the click activity for the campaign
- abuseReports? int - The number of abuse reports generated for this campaign
- deliveryStatus? CampaignDeliveryStatus -
mailchimp.marketing: CampaignReport1
Report details about a sent campaign
Fields
- forwards? Forwards - An object describing the forwards and forward activity for the campaign
- previewText? string - The preview text for the campaign
- listId? string - The unique list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- rssLastSend? string - For RSS campaigns, the date and time of the last send in ISO 8601 format
- listName? string - The name of the list
- 'type? string - The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- industryStats? IndustryStats -
- listStats? ListStats -
- campaignTitle? string - The title of the campaign
- facebookLikes? FacebookLikes -
- timeseries? CampaignSubReportsTimeseries[] - An hourly breakdown of the performance of the campaign over the first 24 hours
- emailsSent? int - The total number of emails sent for this campaign
- ecommerce? ECommerceReport - E-Commerce stats for a campaign
- id? string - A string that uniquely identifies this campaign
- bounces? Bounces - An object describing the bounce summary for the campaign
- subjectLine? string - The subject line for the campaign
- abSplit? ABSplitStats -
- timewarp? CampaignSubReportsTimewarp[] - An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp
- unsubscribed? int - The total number of unsubscribed members for this campaign
- sendTime? string - The date and time a campaign was sent in ISO 8601 format
- opens? Opens - An object describing the open activity for the campaign
- clicks? Clicks - An object describing the click activity for the campaign
- abuseReports? int - The number of abuse reports generated for this campaign
- deliveryStatus? CampaignDeliveryStatus -
mailchimp.marketing: CampaignReports
A summary of the comment feedback for a specific campaign
Fields
- feedback? CampaignFeedback3[] - A collection of feedback items for a campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The unique id for the campaign
mailchimp.marketing: CampaignReports1
A list of reports containing campaigns marked as Sent
Fields
- reports? CampaignReport1[] - An array of objects, each representing a report resource
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: CampaignReportSummary
For sent campaigns, a summary of opens and clicks
Fields
- subscriberClicks? int - The number of unique clicks
- clickRate? decimal - The number of unique clicks divided by the total number of successful deliveries
- opens? int - The total number of opens for a campaign
- clicks? int - The total number of clicks for an campaign
- uniqueOpens? int - The number of unique opens
- openRate? decimal - The number of unique opens divided by the total number of successful deliveries
mailchimp.marketing: CampaignReportSummary1
For sent campaigns, a summary of opens and clicks
Fields
- subscriberClicks? int - The number of unique clicks
- clickRate? decimal - The number of unique clicks divided by the total number of successful deliveries
- ecommerce? ECommerceReport1 - E-Commerce stats for a campaign
- opens? int - The total number of opens for a campaign
- clicks? int - The total number of clicks for an campaign
- uniqueOpens? int - The number of unique opens
- openRate? decimal - The number of unique opens divided by the total number of successful deliveries
mailchimp.marketing: CampaignReportSummary2
For sent campaigns, a summary of opens, clicks, and e-commerce data
Fields
- subscriberClicks? int - The number of unique clicks
- clickRate? decimal - The number of unique clicks divided by the total number of successful deliveries
- ecommerce? ECommerceReport1 - E-Commerce stats for a campaign
- opens? int - The total number of opens for a campaign
- clicks? int - The total number of clicks for an campaign
- uniqueOpens? int - The number of unique opens
- openRate? decimal - The number of unique opens divided by the total number of successful deliveries
mailchimp.marketing: CampaignReportSummary3
A summary of opens and clicks for sent campaigns
Fields
- subscriberClicks? int - The number of unique clicks
- clickRate? decimal - The number of unique clicks, divided by the total number of successful deliveries
- opens? int - The total number of opens for a campaign
- clicks? int - The total number of clicks for an campaign
- uniqueOpens? int - The number of unique opens
- openRate? decimal - The number of unique opens divided by the total number of successful deliveries
mailchimp.marketing: Campaigns
Campaigns and Snippets found for given search term
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- results? CampaignsResults[] - An array of matching campaigns and snippets
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: CampaignscampaignIdcontentVariateContents
Fields
- contentLabel string - The label used to identify the content option
- template? TemplateContent1 - Use this template to generate the HTML content for the campaign
- plainText? string - The plain-text portion of the campaign. If left unspecified, we'll generate this automatically
- html? string - The raw HTML for the campaign
- archive? UploadArchive - Available when uploading an archive to create campaign content. The archive should include all campaign content and images. Learn more
- url? string - When importing a campaign, the URL for the HTML
mailchimp.marketing: CampaignSettings
Settings for the campaign including the email subject, from name, and from email address
Fields
- subjectLine? string - The subject line for the campaign
- previewText? string - The preview text for the campaign
- replyTo? string - The reply-to email address for the Automation
- title? string - The title of the Automation
- fromName? string - The 'from' name for the Automation (not an email address)
mailchimp.marketing: CampaignSettings1
The settings for your campaign, including subject, from name, reply-to address, and more
Fields
- subjectLine? string - The subject line for the campaign
- previewText? string - The preview text for the campaign
- useConversation? boolean - Use Mailchimp Conversation feature to manage out-of-office replies
- authenticate? boolean - Whether Mailchimp authenticated the campaign. Defaults to
true
- toName? string - The campaign's custom 'To' name. Typically the first name audience field
- title? string - The title of the campaign
- fromName? string - The 'from' name on the campaign (not an email address)
- autoTweet? boolean - Automatically tweet a link to the campaign archive page when the campaign is sent
- fbComments? boolean - Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to
true
- replyTo? string - The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending
- inlineCss? boolean - Automatically inline the CSS included with the campaign content
- templateId? int - The id of the template to use
- folderId? string - If the campaign is listed in a folder, the id for that folder
mailchimp.marketing: CampaignSettings2
The settings for your campaign, including subject, from name, reply-to address, and more
Fields
- subjectLine string - The subject line for the campaign
- previewText? string - The preview text for the campaign
- useConversation? boolean - Use Mailchimp Conversation feature to manage out-of-office replies
- authenticate? boolean - Whether Mailchimp authenticated the campaign. Defaults to
true
- toName? string - The campaign's custom 'To' name. Typically the first name audience field
- title? string - The title of the campaign
- fromName string - The 'from' name on the campaign (not an email address)
- autoTweet? boolean - Automatically tweet a link to the campaign archive page when the campaign is sent
- fbComments? boolean - Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to
true
- replyTo string - The reply-to email address for the campaign
- inlineCss? boolean - Automatically inline the CSS included with the campaign content
- templateId? int - The id of the template to use
- folderId? string - If the campaign is listed in a folder, the id for that folder
mailchimp.marketing: CampaignSettings3
Settings for the campaign including the email subject, from name, and from email address
Fields
- subjectLine? string - The subject line for the campaign
- previewText? string - The preview text for the campaign
- authenticate? boolean - Whether Mailchimp authenticated the campaign. Defaults to
true
- title? string - The title of the campaign
- fromName? string - The 'from' name on the campaign (not an email address)
- autoTweet? boolean - Automatically tweet a link to the campaign archive page when the campaign is sent
- fbComments? boolean - Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to
true
- dragAndDrop? boolean - Whether the campaign uses the drag-and-drop editor
- replyTo? string - The reply-to email address for the campaign
- inlineCss? boolean - Automatically inline the CSS included with the campaign content
- templateId? int - The id for the template used in this campaign
mailchimp.marketing: CampaignSettings4
The settings for your campaign, including subject, from name, reply-to address, and more
Fields
- subjectLine? string - The subject line for the campaign
- previewText? string - The preview text for the campaign
- useConversation? boolean - Use Mailchimp Conversation feature to manage replies
- authenticate? boolean - Whether Mailchimp authenticated the campaign. Defaults to
true
- toName? string - The campaign's custom 'To' name. Typically the first name audience field
- title? string - The title of the campaign
- fromName? string - The 'from' name on the campaign (not an email address)
- autoTweet? boolean - Automatically tweet a link to the campaign archive page when the campaign is sent
- fbComments? boolean - Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to
true
- dragAndDrop? boolean - Whether the campaign uses the drag-and-drop editor
- replyTo? string - The reply-to email address for the campaign
- inlineCss? boolean - Automatically inline the CSS included with the campaign content
- templateId? int - The id for the template used in this campaign
- folderId? string - If the campaign is listed in a folder, the id for that folder
mailchimp.marketing: CampaignSettings5
The settings for your campaign, including subject, from name, reply-to address, and more
Fields
- subjectLine? string - The subject line for the campaign
- previewText? string - The preview text for the campaign
- useConversation? boolean - Use Mailchimp Conversation feature to manage out-of-office replies
- authenticate? boolean - Whether Mailchimp authenticated the campaign. Defaults to
true
- toName? string - The campaign's custom 'To' name. Typically the first name audience field
- title? string - The title of the campaign
- fromName? string - The 'from' name on the campaign (not an email address)
- autoTweet? boolean - Automatically tweet a link to the campaign archive page when the campaign is sent
- fbComments? boolean - Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to
true
- dragAndDrop? boolean - Whether the campaign uses the drag-and-drop editor
- replyTo? string - The reply-to email address for the campaign
- inlineCss? boolean - Automatically inline the CSS included with the campaign content
- templateId? int - The id for the template used in this campaign
- folderId? string - If the campaign is listed in a folder, the id for that folder
mailchimp.marketing: CampaignSocialCard
The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more
Fields
- imageUrl? string - The url for the header image for the card
- description? string - A short summary of the campaign to display
- title? string - The title for the card. Typically the subject line of the campaign
mailchimp.marketing: CampaignsResults
Fields
- snippet? string -
- campaign? Campaign4 - A summary of an individual campaign's settings and content
mailchimp.marketing: CampaignSubReports
A list of reports containing child campaigns for a specific campaign
Fields
- reports? CampaignReport1[] - An array of objects, each representing a report resource
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - Unique identifier of the parent campaign
mailchimp.marketing: CampaignSubReportsTimeseries
Fields
- emailsSent? int - The number of emails sent in the timeseries
- recipientsClicks? int - The number of clicks in the timeseries
- proxyExcludedUniqueOpens? int - The number of unique opens in the timeseries, excluding opens from email clients that use proxies
- uniqueOpens? int - The number of unique opens in the timeseries
- timestamp? string - The date and time for the series in ISO 8601 format
mailchimp.marketing: CampaignSubReportsTimewarp
Fields
- uniqueClicks? int - The number of unique clicks
- opens? int - The number of opens
- clicks? int - The number of clicks
- lastClick? string - The date and time of the last click in ISO 8601 format
- gmtOffset? int - For campaigns sent with timewarp, the time zone group the member is apart of
- bounces? int - The number of bounces
- lastOpen? string - The date and time of the last open in ISO 8601 format
- uniqueOpens? int - The number of unique opens
mailchimp.marketing: CampaignTrackingOptions
The tracking options for a campaign
Fields
- salesforce? SalesforceCRMTracking - Deprecated
- goalTracking? boolean - Deprecated
- capsule? CapsuleCRMTracking - Deprecated
- textClicks? boolean - Whether to track clicks in the plain-text version of the campaign. Defaults to
true. Cannot be set to false for variate campaigns
- ecomm360? boolean - Whether to enable e-commerce tracking
- opens? boolean - Whether to track opens. Defaults to
true. Cannot be set to false for variate campaigns
- googleAnalytics? string - The custom slug for Google Analytics tracking (max of 50 bytes)
- htmlClicks? boolean - Whether to track clicks in the HTML version of the campaign. Defaults to
true. Cannot be set to false for variate campaigns
mailchimp.marketing: CampaignTrackingOptions1
The tracking options for a campaign
Fields
- salesforce? SalesforceCRMTracking1 - Deprecated
- goalTracking? boolean - Deprecated
- capsule? CapsuleCRMTracking1 - Deprecated
- clicktale? string - The custom slug for Click Tale tracking (max of 50 bytes)
- textClicks? boolean - Whether to track clicks in the plain-text version of the campaign. Defaults to
true
- ecomm360? boolean - Whether to enable e-commerce tracking
- opens? boolean - Whether to track opens. Defaults to
true
- googleAnalytics? string - The custom slug for Google Analytics tracking (max of 50 bytes)
- htmlClicks? boolean - Whether to track clicks in the HTML version of the campaign. Defaults to
true
mailchimp.marketing: CapsuleCRMTracking
Deprecated
Fields
- notes? boolean - Update contact notes for a campaign based on subscriber email addresses
mailchimp.marketing: CapsuleCRMTracking1
Deprecated
Fields
- notes? boolean - Update contact notes for a campaign based on a subscriber's email address
mailchimp.marketing: CapsuleCRMTracking2
Deprecated
Fields
- notes? boolean - Update contact notes for a campaign based on a subscriber's email addresses
mailchimp.marketing: CartLines
A collection of a cart's line items
Fields
- storeId? string - The store id
- cartId? string - The cart id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- lines? ECommerceCartLineItem3[] - An array of objects, each representing a cart's line item
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: Carts
A collection of a store's carts
Fields
- storeId? string - The store id
- carts? ECommerceCart3[] - An array of objects, each representing a cart
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ChimpChatter
A Chimp Chatter message
Fields
- updateTime? string - The date and time this activity was updated
- listId? string - If it exists, list ID for the associated list
- title? string -
- message? string -
- 'type? "lists:new-subscriber"|"lists:unsubscribes"|"lists:profile-updates"|"campaigns:facebook-likes"|"campaigns:forward-to-friend"|"lists:imports" - The type of activity
- url? string - URL to a report that includes this activity
- campaignId? string - If it exists, campaign ID for the associated campaign
mailchimp.marketing: ClickDetailMember
A subscriber who clicked a specific URL in a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- emailAddress? string - Email address for a subscriber
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- clicks? int - The total number of times the subscriber clicked on the link
- contactStatus? string - The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation
- urlId? string - The id for the tracked URL in the campaign
- vip? boolean - VIP status for subscriber
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- campaignId? string - The campaign id
mailchimp.marketing: ClickDetailMember1
A subscriber who clicked a specific URL in a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- emailAddress? string - Email address for a subscriber
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- clicks? int - The total number of times the subscriber clicked on the link
- contactStatus? string - The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation
- urlId? string - The id for the tracked URL in the campaign
- vip? boolean - VIP status for subscriber
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- campaignId? string - The campaign id
mailchimp.marketing: ClickDetailMembers
A collection of members who clicked on a specific link within a campaign
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- members? ClickDetailMember1[] - An array of objects, each representing a member who clicked a specific link within a campaign
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The campaign id
mailchimp.marketing: ClickDetailReport
A list of URLs and unique IDs included in HTML and plain-text versions of a campaign
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- urlsClicked? ClickDetailReport2[] - An array of objects, each representing a specific URL contained in the campaign
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The campaign id
mailchimp.marketing: ClickDetailReport1
A report of links clicked in a specific campaign
Fields
- uniqueClickPercentage? decimal - The percentage of unique clicks a link generated for a campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- uniqueClicks? int - Number of unique clicks for a link
- abSplit? ABSplit -
- clickPercentage? decimal - The percentage of total clicks a link generated for a campaign
- totalClicks? int - The number of total clicks for a link
- lastClick? string - The date and time for the last recorded click for a link in ISO 8601 format
- id? string - The unique id for the link
- url? string - The URL for the link in the campaign
- campaignId? string - The campaign id
mailchimp.marketing: ClickDetailReport2
A report of links clicked in a specific campaign
Fields
- uniqueClickPercentage? decimal - The percentage of unique clicks a link generated for a campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- uniqueClicks? int - Number of unique clicks for a link
- abSplit? ABSplit -
- clickPercentage? decimal - The percentage of total clicks a link generated for a campaign
- totalClicks? int - The number of total clicks for a link
- lastClick? string - The date and time for the last recorded click for a link in ISO 8601 format
- id? string - The unique id for the link
- url? string - The URL for the link in the campaign
- campaignId? string - The campaign id
mailchimp.marketing: Clicks
An object describing the click activity for the campaign
Fields
- clicksTotal? int - The total number of clicks for the campaign
- uniqueClicks? int - The total number of unique clicks for links across a campaign
- clickRate? decimal - The number of unique clicks divided by the total number of successful deliveries
- lastClick? string - The date and time of the last recorded click for the campaign in ISO 8601 format
- uniqueSubscriberClicks? int - The total number of subscribers who clicked on a campaign
mailchimp.marketing: ClickSummary
A summary of the click-throughs on the campaign's URL
Fields
- clicks? int - The total number of clicks to the campaign's URL
- lastClick? string - The timestamp for the last click to the URL
- locations? Location2[] - A summary of the top click locations
- firstClick? string - The timestamp for the first click to the URL
mailchimp.marketing: CollectionAuthorization
Do particular authorization constraints around this collection limit creation of new instances?
Fields
- mayCreate boolean - May the user create additional instances of this resource?
- currentTotalInstances? int - How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited
- maxInstances int - How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited
mailchimp.marketing: CollectionOfContentForListSignupForms
Collection of Content for List Signup Forms
Fields
- section? "signup_message"|"unsub_message"|"signup_thank_you_title" - The content section name
- value? string - The content section text
mailchimp.marketing: CollectionOfConversationMessages
Messages from a specific conversation
Fields
- conversationMessages? ConversationMessage1[] - An array of objects, each representing a conversation messages resources
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- conversationId? string - A string that identifies this conversation
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: CollectionOfElementStyleForListSignupForms
Collection of Element style for List Signup Forms
Fields
- options? AnOptionForSignupFormStyles[] - A collection of options for a selector
- selector? "page_background"|"page_header"|"page_outer_wrapper"|"body_background"|"body_link_style"|"forms_buttons"|"forms_buttons_hovered"|"forms_field_label"|"forms_field_text"|"forms_required"|"forms_required_legend"|"forms_help_text"|"forms_errors"|"monkey_rewards_badge" - A string that identifies the element selector
mailchimp.marketing: CollectionOfEvents
A collection of events for a given contact
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- events? Event[] - An array of objects, each representing an event
mailchimp.marketing: CollectionOfMemberActivityEvents
The last 50 Goal events for a member on a specific list
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- goals? Goal[] - The last 50 Goal events triggered by a member
mailchimp.marketing: CollectionOfMergeFields
The merge fields for an audience
Fields
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? MergeField3[] - An array of objects, each representing a merge field resource
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: CollectionOfNotes
The last 10 notes for a specific list member, based on date created
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- notes? MemberNotes2[] - An array of objects, each representing a note resource
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: CollectionOfSegments
A list of available segments
Fields
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- segments? List9[] - An array of objects, each representing a list segment
mailchimp.marketing: CollectionOfTags
A list of tags assigned to a list member
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: CollectionOfTagsTags
Fields
- dateAdded? string - The date and time the tag was added to the list member in ISO 8601 format
- name? string - The name of the tag
- id? int - The unique id for the tag
mailchimp.marketing: Conditions
The conditions of the segment. Static and fuzzy segments don't have conditions
Fields
- 'match? "any"|"all" - Match type
- conditions? record {}[] - Segment match conditions. There are multiple possible types, see the condition types documentation
mailchimp.marketing: Conditions1
The conditions of the segment. Static and fuzzy segments don't have conditions
Fields
- 'match? "any"|"all" - Match type
- conditions? record {}[][] - An array of segment conditions
mailchimp.marketing: Conditions2
The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions
Fields
- 'match? "any"|"all" - Match type
- conditions? record {}[] - Segment match conditions. There are multiple possible types, see the condition types documentation
mailchimp.marketing: ConnectedSite
Information about a specific connected site
Fields
- foreignId string - The unique identifier for the site
- domain string - The connected site domain
mailchimp.marketing: ConnectedSite1
Information about a specific connected site
Fields
- foreignId? string - The unique identifier for the site
- storeId? string - The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change
- updatedAt? string - The date and time the connected site was last updated in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- domain? string - The connected site domain
- siteScript? Script -
- createdAt? string - The date and time the connected site was created in ISO 8601 format
- platform? string - The platform of the connected site
mailchimp.marketing: ConnectedSite2
Information about a specific connected site
Fields
- foreignId? string - The unique identifier for the site
- storeId? string - The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change
- updatedAt? string - The date and time the connected site was last updated in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- domain? string - The connected site domain
- siteScript? Script -
- createdAt? string - The date and time the connected site was created in ISO 8601 format
- platform? string - The platform of the connected site
mailchimp.marketing: ConnectedSite3
The Connected Site associated with the store
Fields
- siteScript? Script1 -
- siteForeignId? string - The unique identifier for the connected site
mailchimp.marketing: ConnectedSites
A collection of connected sites in the account
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- sites? ConnectedSite2[] - An array of objects, each representing a connected site
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
mailchimp.marketing: Contact
Information about the contact
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- fullName? string - The contact's full name
- avatarUrl? string - URL for the contact's avatar or profile image
- phone? string - The contact's sms phone number
- contactId? string - The ID of this contact
- email? string - The contact's email address
- status? "Subscribed"|"Unsubscribed"|"Non-Subscribed"|"Cleaned"|"Archived" - The contact's current status
- consentsToOneToOneMessaging? boolean - Indicates whether a contact consents to 1:1 messaging
mailchimp.marketing: ContactCounts
For email question types, how many are new, known, or unknown contacts
Fields
- 'new? int - The number of new contacts that responded to this survey
- known? int - The number of known contacts that responded to this survey
- unknown? int - The number of unknown contacts that responded to this survey
mailchimp.marketing: Conversation
Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account
Fields
- fromEmail? string - A label representing the email of the sender of this message
- listId? string - The unique identifier of the list for this conversation
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- subject? string - The subject of the message
- unreadMessages? int - The number of unread messages in this conversation
- lastMessage? LastMessage -
- id? string - A string that uniquely identifies this conversation
- messageCount? int - The total number of messages in this conversation
- fromLabel? string - A label representing the sender of this message
- campaignId? string - The unique identifier of the campaign for this conversation
mailchimp.marketing: Conversation1
Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account
Fields
- fromEmail? string - A label representing the email of the sender of this message
- listId? string - The unique identifier of the list for this conversation
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- subject? string - The subject of the message
- unreadMessages? int - The number of unread messages in this conversation
- lastMessage? LastMessage -
- id? string - A string that uniquely identifies this conversation
- messageCount? int - The total number of messages in this conversation
- fromLabel? string - A label representing the sender of this message
- campaignId? string - The unique identifier of the campaign for this conversation
mailchimp.marketing: ConversationMessage
An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account
Fields
- fromEmail? string - A label representing the email of the sender of this message
- read? boolean - Whether this message has been marked as read
- listId? int - The list's web ID
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- conversationId? string - A string that identifies this message's conversation
- subject? string - The subject of this message
- id? string - A string that uniquely identifies this message
- message? string - The plain-text content of the message
- fromLabel? string - A label representing the sender of this message
- timestamp? string - The date and time the message was either sent or received in ISO 8601 format
mailchimp.marketing: ConversationMessage1
An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account
Fields
- fromEmail? string - A label representing the email of the sender of this message
- read? boolean - Whether this message has been marked as read
- listId? int - The list's web ID
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- conversationId? string - A string that identifies this message's conversation
- subject? string - The subject of this message
- id? string - A string that uniquely identifies this message
- message? string - The plain-text content of the message
- fromLabel? string - A label representing the sender of this message
- timestamp? string - The date and time the message was either sent or received in ISO 8601 format
mailchimp.marketing: CreateAnAccountExport
Creates an account export with the given parameters
Fields
- sinceTimestamp? string - An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit
- includeStages ("audiences"|"campaigns"|"events"|"gallery_files"|"reports"|"templates")[] - The stages of an account export to include
mailchimp.marketing: Customers
A collection of the store's customers
Fields
- storeId? string - The store id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- customers? ECommerceCustomer6[] - An array of objects, each representing a customer of a store
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: DailyClicksAndVisitsData
The clicks and visits data from the last seven days
Fields
- uniqueVisits? DailyClicksAndVisitsDataUniqueVisits[] -
- visits? DailyClicksAndVisitsDataVisits[] -
- clicks? DailyClicksAndVisitsDataClicks[] -
mailchimp.marketing: DailyClicksAndVisitsDataClicks
Fields
- date? string -
- val? int -
mailchimp.marketing: DailyClicksAndVisitsDataUniqueVisits
Fields
- date? string -
- val? int -
mailchimp.marketing: DailyClicksAndVisitsDataVisits
Fields
- date? string -
- val? int -
mailchimp.marketing: DailyListActivity
One day's worth of list activity. Doesn't include Automation activity
Fields
- softBounce? int - The number of soft bounces
- hardBounce? int - The number of hard bounces
- subs? int - The number of subscribes
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- emailsSent? int - The total number of emails sent on the date for the activity summary
- unsubs? int - The number of unsubscribes
- recipientClicks? int - The number of clicks
- otherAdds? int - The number of subscribers who may have been added outside of the double opt-in process, such as imports or API activity
- day? string - The date for the activity summary
- uniqueOpens? int - The number of unique opens
- otherRemoves? int - The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers)
mailchimp.marketing: DailySendingDays
The days of the week to send a daily RSS Campaign
Fields
- sunday? boolean - Sends the daily RSS Campaign on Sundays
- saturday? boolean - Sends the daily RSS Campaign on Saturdays
- tuesday? boolean - Sends the daily RSS Campaign on Tuesdays
- wednesday? boolean - Sends the daily RSS Campaign on Wednesdays
- thursday? boolean - Sends the daily RSS Campaign on Thursdays
- friday? boolean - Sends the daily RSS Campaign on Fridays
- monday? boolean - Sends the daily RSS Campaign on Mondays
mailchimp.marketing: DomainPerformance
Statistics for the top-performing email domains in a campaign
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalSent? int - The total number of emails sent for the campaign
- domains? EmailDomain[] - The top 5 email domains based on total delivered emails
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The unique id for the campaign
mailchimp.marketing: ECommerceCart
Information about a specific cart
Fields
- checkoutUrl? string - The URL for the cart. This parameter is required for Abandoned Cart automations
- taxTotal? decimal - The total tax for the cart
- orderTotal decimal - The order total for the cart
- id string - A unique identifier for the cart
- lines ECommerceCartLineItem[] - An array of the cart's line items
- campaignId? string - A string that uniquely identifies the campaign for a cart
- currencyCode string - The three-letter ISO 4217 code for the currency that the cart uses
- customer ECommerceCustomer - Information about a specific customer. For existing customers include only the
idparameter in thecustomerobject body
mailchimp.marketing: ECommerceCart1
Information about a specific cart
Fields
- checkoutUrl? string - The URL for the cart. This parameter is required for Abandoned Cart automations
- taxTotal? decimal - The total tax for the cart
- updatedAt? string - The date and time the cart was last updated in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- createdAt? string - The date and time the cart was created in ISO 8601 format
- orderTotal? decimal - The order total for the cart
- id? string - A unique identifier for the cart
- lines? ECommerceCartLineItem3[] - An array of the cart's line items
- campaignId? string - A string that uniquely identifies the campaign associated with a cart
- currencyCode? string - The three-letter ISO 4217 code for the currency that the cart uses
- customer? ECommerceCustomer6 - Information about a specific customer
mailchimp.marketing: ECommerceCart2
Information about a specific cart
Fields
- checkoutUrl? string - The URL for the cart. This parameter is required for Abandoned Cart automations
- taxTotal? decimal - The total tax for the cart
- orderTotal? decimal - The order total for the cart
- lines? ECommerceCartLineItem1[] - An array of the cart's line items
- campaignId? string - A string that uniquely identifies the campaign associated with a cart
- currencyCode? string - The three-letter ISO 4217 code for the currency that the cart uses
- customer? ECommerceCustomer1 - Information about a specific customer. Orders for existing customers should include only the
idparameter in thecustomerobject body
mailchimp.marketing: ECommerceCart3
Information about a specific cart
Fields
- checkoutUrl? string - The URL for the cart. This parameter is required for Abandoned Cart automations
- taxTotal? decimal - The total tax for the cart
- updatedAt? string - The date and time the cart was last updated in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- createdAt? string - The date and time the cart was created in ISO 8601 format
- orderTotal? decimal - The order total for the cart
- id? string - A unique identifier for the cart
- lines? ECommerceCartLineItem3[] - An array of the cart's line items
- campaignId? string - A string that uniquely identifies the campaign associated with a cart
- currencyCode? string - The three-letter ISO 4217 code for the currency that the cart uses
- customer? ECommerceCustomer6 - Information about a specific customer
mailchimp.marketing: ECommerceCartLineItem
Information about a specific cart line item
Fields
- quantity int - The quantity of a cart line item
- price decimal - The price of a cart line item
- productId string - A unique identifier for the product associated with the cart line item
- id string - A unique identifier for the cart line item
- productVariantId string - A unique identifier for the product variant associated with the cart line item
mailchimp.marketing: ECommerceCartLineItem1
Information about a specific cart line item
Fields
- quantity? int - The quantity of a cart line item
- price? decimal - The price of a cart line item
- productId? string - A unique identifier for the product associated with the cart line item
- productVariantId? string - A unique identifier for the product variant associated with the cart line item
mailchimp.marketing: ECommerceCartLineItem2
Information about a specific cart line item
Fields
- productVariantTitle? string - The name of the product variant for the cart line item
- quantity? int - The quantity of a cart line item
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- price? decimal - The price of a cart line item
- productId? string - A unique identifier for the product associated with the cart line item
- id? string - A unique identifier for the cart line item
- productVariantId? string - A unique identifier for the product variant associated with the cart line item
- productTitle? string - The name of the product for the cart line item
mailchimp.marketing: ECommerceCartLineItem3
Information about a specific cart line item
Fields
- productVariantTitle? string - The name of the product variant for the cart line item
- quantity? int - The quantity of a cart line item
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- price? decimal - The price of a cart line item
- productId? string - A unique identifier for the product associated with the cart line item
- id? string - A unique identifier for the cart line item
- productVariantId? string - A unique identifier for the product variant associated with the cart line item
- productTitle? string - The name of the product for the cart line item
mailchimp.marketing: ECommerceCustomer
Information about a specific customer. For existing customers include only the id parameter in the customer object body
Fields
- emailAddress? string - The customer's email address
- address? Address1 - The customer's address
- lastName? string - The customer's last name
- optInStatus? boolean - The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as
Transactionalmembers
- company? string - The customer's company
- id string - A unique identifier for the customer. Limited to 50 characters
- firstName? string - The customer's first name
mailchimp.marketing: ECommerceCustomer1
Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body
Fields
- address? Address1 - The customer's address
- lastName? string - The customer's last name
- optInStatus? boolean - The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as
Transactionalmembers
- company? string - The customer's company
- firstName? string - The customer's first name
mailchimp.marketing: ECommerceCustomer2
Information about a specific customer
Fields
- emailAddress? string - The customer's email address
- address? Address1 - The customer's address
- smsPhoneNumber? string - A US phone number for SMS contact
- lastName? string - The customer's last name
- optInStatus boolean - The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as
Transactionalmembers
- company? string - The customer's company
- id string - A unique identifier for the customer. Limited to 50 characters
- firstName? string - The customer's first name
mailchimp.marketing: ECommerceCustomer3
Information about a specific customer
Fields
- totalSpent? decimal - The total amount the customer has spent
- address? Address1 - The customer's address
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- lastName? string - The customer's last name
- createdAt? string - The date and time the customer was created in ISO 8601 format
- ordersCount? int - The customer's total order count
- emailAddress? string - The customer's email address
- smsPhoneNumber? string - A US phone number for SMS contact
- updatedAt? string - The date and time the customer was last updated in ISO 8601 format
- optInStatus? boolean - The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as
Transactionalmembers
- company? string - The customer's company
- id? string - A unique identifier for the customer
- firstName? string - The customer's first name
mailchimp.marketing: ECommerceCustomer4
Information about a specific customer. Orders for existing customers should include only the id parameter in the customer object body
Fields
- emailAddress? string - The customer's email address
- address? Address1 - The customer's address
- smsPhoneNumber? string - A US phone number for SMS contact
- lastName? string - The customer's last name
- optInStatus boolean - The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as
Transactionalmembers
- company? string - The customer's company
- id string - A unique identifier for the customer. Limited to 50 characters
- firstName? string - The customer's first name
mailchimp.marketing: ECommerceCustomer5
Information about a specific customer. For existing customers include only the id parameter in the customer object body
Fields
- emailAddress? string - The customer's email address
- address? Address2 - The customer's address
- lastName? string - The customer's last name
- optInStatus? boolean - The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as
Transactionalmembers
- company? string - The customer's company
- id string - A unique identifier for the customer. Limited to 50 characters
- firstName? string - The customer's first name
mailchimp.marketing: ECommerceCustomer6
Information about a specific customer
Fields
- totalSpent? decimal - The total amount the customer has spent
- address? Address1 - The customer's address
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- lastName? string - The customer's last name
- createdAt? string - The date and time the customer was created in ISO 8601 format
- ordersCount? int - The customer's total order count
- emailAddress? string - The customer's email address
- smsPhoneNumber? string - A US phone number for SMS contact
- updatedAt? string - The date and time the customer was last updated in ISO 8601 format
- optInStatus? boolean - The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as
Transactionalmembers
- company? string - The customer's company
- id? string - A unique identifier for the customer
- firstName? string - The customer's first name
mailchimp.marketing: ECommerceOrder
Information about a specific order
Fields
- discountTotal? decimal - The total amount of the discounts to be applied to the price of the order
- fulfillmentStatus? string - The fulfillment status for the order. Use this parameter to trigger Order Notifications
- taxTotal? decimal - The tax total for the order
- shippingTotal? decimal - The shipping total for the order
- outreach? Outreach - The outreach associated with this order. For example, an email campaign or Facebook ad
- processedAtForeign? string - The date and time the order was processed in ISO 8601 format
- billingAddress? BillingAddress -
- trackingCode? "prec" - The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs
- currencyCode string - The three-letter ISO 4217 code for the currency that the store accepts
- landingSite? string - The URL for the page where the buyer landed when entering the shop
- orderUrl? string - The URL for the order
- trackingCarrier? string - The tracking carrier associated with the order
- financialStatus? string - The order status. Use this parameter to trigger Order Notifications
- trackingNumber? string - The tracking number associated with the order
- orderTotal decimal - The total for the order
- id string - A unique identifier for the order
- shippingAddress? ShippingAddress -
- updatedAtForeign? string - The date and time the order was updated in ISO 8601 format
- lines ECommerceOrderLineItem[] - An array of the order's line items
- promos? EcommercestoresstoreIdordersPromos[] - The promo codes applied on the order
- trackingUrl? string - The tracking URL associated with the order
- campaignId? string - A string that uniquely identifies the campaign for an order
- customer ECommerceCustomer - Information about a specific customer. For existing customers include only the
idparameter in thecustomerobject body
- cancelledAtForeign? string - The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created
mailchimp.marketing: ECommerceOrder1
Information about a specific order
Fields
- discountTotal? decimal - The total amount of the discounts to be applied to the price of the order
- fulfillmentStatus? string - The fulfillment status for the order. Use this parameter to trigger Order Notifications
- taxTotal? decimal - The tax total associated with an order
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- processedAtForeign? string - The date and time the order was processed in ISO 8601 format
- billingAddress? BillingAddress2 -
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
- landingSite? string - The URL for the page where the buyer landed when entering the shop
- orderUrl? string - The URL for the order
- trackingNumber? string - The tracking number associated with the order
- id? string - A unique identifier for the order
- shippingAddress? ShippingAddress2 -
- updatedAtForeign? string - The date and time the order was updated in ISO 8601 format
- lines? ECommerceOrderLineItem4[] - An array of the order's line items
- promos? Orders1Promos[] - The promo codes applied on the order
- trackingUrl? string - The tracking URL associated with the order
- campaignId? string - A string that uniquely identifies the campaign associated with an order
- cancelledAtForeign? string - The date and time the order was cancelled in ISO 8601 format
- storeId? string - The unique identifier for the store
- shippingTotal? decimal - The shipping total for the order
- outreach? Outreach1 - The outreach associated with this order. For example, an email campaign or Facebook ad
- trackingCode? "prec" - The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs
- trackingCarrier? string - The tracking carrier associated with the order
- financialStatus? string - The order status. Use this parameter to trigger Order Notifications
- orderTotal? decimal - The order total associated with an order
- customer? ECommerceCustomer6 - Information about a specific customer
mailchimp.marketing: ECommerceOrder2
Information about a specific order
Fields
- discountTotal? decimal - The total amount of the discounts to be applied to the price of the order
- fulfillmentStatus? string - The fulfillment status for the order. Use this parameter to trigger Order Notifications
- taxTotal? decimal - The tax total for the order
- shippingTotal? decimal - The shipping total for the order
- outreach? Outreach - The outreach associated with this order. For example, an email campaign or Facebook ad
- processedAtForeign? string - The date and time the order was processed in ISO 8601 format
- billingAddress? BillingAddress1 -
- trackingCode? "prec" - The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
- landingSite? string - The URL for the page where the buyer landed when entering the shop
- orderUrl? string - The URL for the order
- trackingCarrier? string - The tracking carrier associated with the order
- financialStatus? string - The order status. Use this parameter to trigger Order Notifications
- trackingNumber? string - The tracking number associated with the order
- orderTotal? decimal - The total for the order
- id string - A unique identifier for the order
- shippingAddress? ShippingAddress1 -
- updatedAtForeign? string - The date and time the order was updated in ISO 8601 format
- lines? ECommerceOrderLineItem1[] - An array of the order's line items
- promos? EcommercestoresstoreIdordersPromos[] - The promo codes applied on the order
- trackingUrl? string - The tracking URL associated with the order
- campaignId? string - A string that uniquely identifies the campaign for an order
- customer? ECommerceCustomer5 - Information about a specific customer. For existing customers include only the
idparameter in thecustomerobject body
- cancelledAtForeign? string - The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created
mailchimp.marketing: ECommerceOrder3
Information about a specific order
Fields
- discountTotal? decimal - The total amount of the discounts to be applied to the price of the order
- fulfillmentStatus? string - The fulfillment status for the order. Use this parameter to trigger Order Notifications
- taxTotal? decimal - The tax total associated with an order
- shippingTotal? decimal - The shipping total for the order
- outreach? Outreach - The outreach associated with this order. For example, an email campaign or Facebook ad
- processedAtForeign? string - The date and time the order was processed in ISO 8601 format
- billingAddress? BillingAddress2 -
- trackingCode? "prec" - The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
- landingSite? string - The URL for the page where the buyer landed when entering the shop
- orderUrl? string - The URL for the order
- trackingCarrier? string - The tracking carrier associated with the order
- financialStatus? string - The order status. Use this parameter to trigger Order Notifications
- trackingNumber? string - The tracking number associated with the order
- orderTotal? decimal - The order total associated with an order
- shippingAddress? ShippingAddress2 -
- updatedAtForeign? string - The date and time the order was updated in ISO 8601 format
- lines? ECommerceOrderLineItem2[] - An array of the order's line items
- promos? EcommercestoresstoreIdordersPromos[] - The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided
- trackingUrl? string - The tracking URL associated with the order
- campaignId? string - A string that uniquely identifies the campaign associated with an order
- customer? ECommerceCustomer1 - Information about a specific customer. Orders for existing customers should include only the
idparameter in thecustomerobject body
- cancelledAtForeign? string - The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being edited
mailchimp.marketing: ECommerceOrder4
Information about a specific order
Fields
- discountTotal? decimal - The total amount of the discounts to be applied to the price of the order
- fulfillmentStatus? string - The fulfillment status for the order. Use this parameter to trigger Order Notifications
- taxTotal? decimal - The tax total associated with an order
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- processedAtForeign? string - The date and time the order was processed in ISO 8601 format
- billingAddress? BillingAddress2 -
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
- landingSite? string - The URL for the page where the buyer landed when entering the shop
- orderUrl? string - The URL for the order
- trackingNumber? string - The tracking number associated with the order
- id? string - A unique identifier for the order
- shippingAddress? ShippingAddress2 -
- updatedAtForeign? string - The date and time the order was updated in ISO 8601 format
- lines? ECommerceOrderLineItem4[] - An array of the order's line items
- promos? Orders1Promos[] - The promo codes applied on the order
- trackingUrl? string - The tracking URL associated with the order
- campaignId? string - A string that uniquely identifies the campaign associated with an order
- cancelledAtForeign? string - The date and time the order was cancelled in ISO 8601 format
- storeId? string - The unique identifier for the store
- shippingTotal? decimal - The shipping total for the order
- outreach? Outreach1 - The outreach associated with this order. For example, an email campaign or Facebook ad
- trackingCode? "prec" - The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs
- trackingCarrier? string - The tracking carrier associated with the order
- financialStatus? string - The order status. Use this parameter to trigger Order Notifications
- orderTotal? decimal - The order total associated with an order
- customer? ECommerceCustomer6 - Information about a specific customer
mailchimp.marketing: ECommerceOrderLineItem
Information about a specific order line
Fields
- product? ECommerceProduct - Information about a specific product
- quantity int - The quantity of an order line item
- price decimal - The price of an order line item
- productId string - A unique identifier for the product associated with the order line item
- discount? decimal - The total discount amount applied to this line item
- id string - A unique identifier for the order line item
- productVariantId string - A unique identifier for the product variant associated with the order line item
mailchimp.marketing: ECommerceOrderLineItem1
Information about a specific order line
Fields
- product? ECommerceProduct1 - Information about a specific product
- quantity? int - The quantity of an order line item
- price? decimal - The price of an order line item
- productId? string - A unique identifier for the product associated with the order line item
- discount? decimal - The total discount amount applied to this line item
- id string - A unique identifier for the order line item
- productVariantId? string - A unique identifier for the product variant associated with the order line item
mailchimp.marketing: ECommerceOrderLineItem2
Information about a specific order line
Fields
- quantity? int - The quantity of an order line item
- price? decimal - The price of an order line item
- productId? string - A unique identifier for the product associated with the order line item
- discount? decimal - The total discount amount applied to this line item
- productVariantId? string - A unique identifier for the product variant associated with the order line item
mailchimp.marketing: ECommerceOrderLineItem3
Information about a specific order line
Fields
- productVariantTitle? string - The name of the product variant for an order line item
- quantity? int - The order line item quantity
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- imageUrl? string - The image URL for a product
- price? decimal - The order line item price
- productId? string - A unique identifier for the product associated with an order line item
- discount? decimal - The total discount amount applied to a line item
- id? string - A unique identifier for an order line item
- productVariantId? string - A unique identifier for the product variant associated with an order line item
- productTitle? string - The name of the product for an order line item
mailchimp.marketing: ECommerceOrderLineItem4
Information about a specific order line
Fields
- productVariantTitle? string - The name of the product variant for an order line item
- quantity? int - The order line item quantity
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- imageUrl? string - The image URL for a product
- price? decimal - The order line item price
- productId? string - A unique identifier for the product associated with an order line item
- discount? decimal - The total discount amount applied to a line item
- id? string - A unique identifier for an order line item
- productVariantId? string - A unique identifier for the product variant associated with an order line item
- productTitle? string - The name of the product for an order line item
mailchimp.marketing: ECommerceProduct
Information about a specific product
Fields
- images? ECommerceProductImage[] - An array of the product's images
- vendor? string - The vendor for a product
- imageUrl? string - The image URL for a product
- description? string - The description of a product
- 'handle? string - The handle of a product
- publishedAtForeign? string - The date and time the product was published
- id string - A unique identifier for the product
- variants ECommerceProductVariant[] - An array of the product's variants. At least one variant is required for each product. A variant can use the same
idandtitleas the parent product
- title string - The title of a product
- 'type? string - The type of product
- url? string - The URL for a product
mailchimp.marketing: ECommerceProduct1
Information about a specific product
Fields
- images? ECommerceProductImage[] - An array of the product's images
- vendor? string - The vendor for a product
- imageUrl? string - The image URL for a product
- description? string - The description of a product
- 'handle? string - The handle of a product
- publishedAtForeign? string - The date and time the product was published
- id string - A unique identifier for the product
- variants? ECommerceProductVariant[] - An array of the product's variants. At least one variant is required for each product. A variant can use the same
idandtitleas the parent product
- title? string - The title of a product
- 'type? string - The type of product
- url? string - The URL for a product
mailchimp.marketing: ECommerceProduct2
Information about a specific product
Fields
- images? ECommerceProductImage3[] - An array of the product's images
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- imageUrl? string - The image URL for a product
- description? string - The description of a product
- 'handle? string - The handle of a product
- variants? ECommerceProductVariant3[] - Returns up to 50 of the product's variants. To retrieve all variants use Product Variants
- title? string - The title of a product
- 'type? string - The type of product
- currencyCode? string - The currency code
- url? string - The URL for a product
- vendor? string - The vendor for a product
- publishedAtForeign? string - The date and time the product was published in ISO 8601 format
- id? string - A unique identifier for the product
mailchimp.marketing: ECommerceProduct3
Information about a specific product
Fields
- images? ECommerceProductImage1[] - An array of the product's images
- vendor? string - The vendor for a product
- imageUrl? string - The image URL for a product
- description? string - The description of a product
- 'handle? string - The handle of a product
- publishedAtForeign? string - The date and time the product was published in ISO 8601 format
- variants? ECommerceProductVariant1[] - An array of the product's variants. At least one variant is required for each product. A variant can use the same
idandtitleas the parent product
- title? string - The title of a product
- 'type? string - The type of product
- url? string - The URL for a product
mailchimp.marketing: ECommerceProduct4
Information about a specific product
Fields
- images? ECommerceProductImage3[] - An array of the product's images
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- imageUrl? string - The image URL for a product
- description? string - The description of a product
- 'handle? string - The handle of a product
- variants? ECommerceProductVariant3[] - Returns up to 50 of the product's variants. To retrieve all variants use Product Variants
- title? string - The title of a product
- 'type? string - The type of product
- currencyCode? string - The currency code
- url? string - The URL for a product
- vendor? string - The vendor for a product
- publishedAtForeign? string - The date and time the product was published in ISO 8601 format
- id? string - A unique identifier for the product
mailchimp.marketing: ECommerceProductImage
Information about a specific product image
Fields
- variantIds? string[] - The list of product variants using the image
- id string - A unique identifier for the product image
- url string - The URL for a product image
mailchimp.marketing: ECommerceProductImage1
Information about a specific product image
Fields
- variantIds? string[] - The list of product variants using the image
- id? string - A unique identifier for the product image
- url? string - The URL for a product image
mailchimp.marketing: ECommerceProductImage2
Information about a specific product image
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- variantIds? string[] - The list of product variants using the image
- id? string - A unique identifier for the product image
- url? string - The URL for a product image
mailchimp.marketing: ECommerceProductImage3
Information about a specific product image
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- variantIds? string[] - The list of product variants using the image
- id? string - A unique identifier for the product image
- url? string - The URL for a product image
mailchimp.marketing: EcommerceProductImages
A collection of a product's images
Fields
- storeId? string - The store id
- images? ECommerceProductImage3[] - An array of objects, each representing a product image resource
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- productId? string - The product id
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ECommerceProductVariant
Information about a specific product variant
Fields
- inventoryQuantity? int - The inventory quantity of a product variant
- visibility? string - The visibility of a product variant
- backorders? string - The backorders of a product variant
- price? decimal - The price of a product variant
- imageUrl? string - The image URL for a product variant
- id string - A unique identifier for the product variant
- title string - The title of a product variant
- sku? string - The stock keeping unit (SKU) of a product variant
- url? string - The URL for a product variant
mailchimp.marketing: ECommerceProductVariant1
Information about a specific product variant
Fields
- inventoryQuantity? int - The inventory quantity of a product variant
- visibility? string - The visibility of a product variant
- backorders? string - The backorders of a product variant
- price? decimal - The price of a product variant
- imageUrl? string - The image URL for a product variant
- title? string - The title of a product variant
- sku? string - The stock keeping unit (SKU) of a product variant
- url? string - The URL for a product variant
mailchimp.marketing: ECommerceProductVariant2
Information about a specific product variant
Fields
- inventoryQuantity? int - The inventory quantity of a product variant
- visibility? string - The visibility of a product variant
- updatedAt? string - The date and time the product was last updated in ISO 8601 format
- backorders? string - The backorders of a product variant
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- price? decimal - The price of a product variant
- imageUrl? string - The image URL for a product variant
- createdAt? string - The date and time the product was created in ISO 8601 format
- id? string - A unique identifier for the product variant
- title? string - The title of a product variant
- sku? string - The stock keeping unit (SKU) of a product variant
- url? string - The URL for a product variant
mailchimp.marketing: ECommerceProductVariant3
Information about a specific product variant
Fields
- inventoryQuantity? int - The inventory quantity of a product variant
- visibility? string - The visibility of a product variant
- updatedAt? string - The date and time the product was last updated in ISO 8601 format
- backorders? string - The backorders of a product variant
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- price? decimal - The price of a product variant
- imageUrl? string - The image URL for a product variant
- createdAt? string - The date and time the product was created in ISO 8601 format
- id? string - A unique identifier for the product variant
- title? string - The title of a product variant
- sku? string - The stock keeping unit (SKU) of a product variant
- url? string - The URL for a product variant
mailchimp.marketing: EcommerceProductVariants
A collection of a product's variants
Fields
- storeId? string - The store id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- productId? string - The product id
- variants? ECommerceProductVariant3[] - An array of objects, each representing a product's variants
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ECommercePromoCode
Information about an Ecommerce Store's specific Promo Code
Fields
- usageCount? int - Number of times promo code has been used
- code string - The discount code. Restricted to UTF-8 characters with max length 50
- id string - A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- redemptionUrl string - The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000
- enabled? boolean - Whether the promo code is currently enabled
mailchimp.marketing: ECommercePromoCode1
Information about an Ecommerce Store's specific Promo Code
Fields
- usageCount? int - Number of times promo code has been used
- code? string - The discount code. Restricted to UTF-8 characters with max length 50
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - A unique identifier for the promo Code
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- redemptionUrl? string - The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000
- enabled? boolean - Whether the promo code is currently enabled
mailchimp.marketing: ECommercePromoCode2
Information about an Ecommerce Store's specific Promo Code
Fields
- usageCount? int - Number of times promo code has been used
- code? string - The discount code. Restricted to UTF-8 characters with max length 50
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- redemptionUrl? string - The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000
- enabled? boolean - Whether the promo code is currently enabled
mailchimp.marketing: ECommercePromoCode3
Information about an Ecommerce Store's specific Promo Code
Fields
- usageCount? int - Number of times promo code has been used
- code? string - The discount code. Restricted to UTF-8 characters with max length 50
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - A unique identifier for the promo Code
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- redemptionUrl? string - The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000
- enabled? boolean - Whether the promo code is currently enabled
mailchimp.marketing: ECommercePromoRule
Information about an Ecommerce Store's specific Promo Rule
Fields
- startsAt? string - The date and time when the promotion is in effect in ISO 8601 format
- amount float - The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive
- description string - The description of a promotion restricted to UTF-8 characters with max length 255
- id string - A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50
- endsAt? string - The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- title? string - The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes
- 'type "fixed"|"percentage" - Type of discount. For free shipping set type to fixed
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- enabled? boolean - Whether the promo rule is currently enabled
- target "per_item"|"total"|"shipping" - The target that the discount applies to
mailchimp.marketing: ECommercePromoRule1
Information about an Ecommerce Store's specific Promo Rule
Fields
- startsAt? string - The date and time when the promotion is in effect in ISO 8601 format
- amount? float - The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- description? string - The description of a promotion restricted to UTF-8 characters with max length 255
- id? string - A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50
- endsAt? string - The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- title? string - The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes
- 'type? "fixed"|"percentage" - Type of discount. For free shipping set type to fixed
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- enabled? boolean - Whether the promo rule is currently enabled
- target? "per_item"|"total"|"shipping" - The target that the discount applies to
mailchimp.marketing: ECommercePromoRule2
Information about an Ecommerce Store's specific Promo Rule
Fields
- startsAt? string - The date and time when the promotion is in effect in ISO 8601 format
- amount? float - The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive
- description? string - The description of a promotion restricted to UTF-8 characters with max length 255
- endsAt? string - The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- title? string - The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes
- 'type? "fixed"|"percentage" - Type of discount. For free shipping set type to fixed
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- enabled? boolean - Whether the promo rule is currently enabled
- target? "per_item"|"total"|"shipping" - The target that the discount applies to
mailchimp.marketing: ECommercePromoRule3
Information about an Ecommerce Store's specific Promo Rule
Fields
- startsAt? string - The date and time when the promotion is in effect in ISO 8601 format
- amount? float - The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- description? string - The description of a promotion restricted to UTF-8 characters with max length 255
- id? string - A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50
- endsAt? string - The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format
- createdAtForeign? string - The date and time the promotion was created in ISO 8601 format
- title? string - The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes
- 'type? "fixed"|"percentage" - Type of discount. For free shipping set type to fixed
- updatedAtForeign? string - The date and time the promotion was updated in ISO 8601 format
- enabled? boolean - Whether the promo rule is currently enabled
- target? "per_item"|"total"|"shipping" - The target that the discount applies to
mailchimp.marketing: ECommerceReport
E-Commerce stats for a campaign
Fields
- totalSpent? decimal - The total spent for a campaign. Calculated as the sum of all order totals with no deductions
- totalRevenue? decimal - The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals
- totalOrders? int - The total orders for a campaign
- currencyCode? string -
mailchimp.marketing: ECommerceReport1
E-Commerce stats for a campaign
Fields
- totalSpent? decimal - The total spent for a campaign. Calculated as the sum of all order totals with no deductions
- totalRevenue? decimal - The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals
- totalOrders? int - The total orders for a campaign
mailchimp.marketing: EcommerceStats
Ecommerce stats for the list member if the list is attached to a store
Fields
- totalRevenue? decimal - The total revenue the list member has brought in
- numberOfOrders? decimal - The total number of orders placed by the list member
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
mailchimp.marketing: ECommerceStore
An individual store in an account
Fields
- address? Address - The store address
- listId string - The unique identifier for the list associated with the store. The
list_idfor a specific store cannot change
- timezone? string - The timezone for the store
- primaryLocale? string - The primary locale for the store. For example:
en,de, etc
- platform? string - The e-commerce platform of the store
- currencyCode string - The three-letter ISO 4217 code for the currency that the store accepts
- moneyFormat? string - The currency format for the store. For example:
$,£, etc
- emailAddress? string - The email address for the store
- phone? string - The store phone number
- domain? string - The store domain. This parameter is required for Connected Sites and Google Ads
- name string - The name of the store
- id string - The unique identifier for the store
mailchimp.marketing: ECommerceStore1
An individual store in an account
Fields
- automations? Automations - Details for the automations attached to this store
- address? Address - The store address
- listId? string - The unique identifier for the list that's associated with the store. The
list_idfor a specific store can't change
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- timezone? string - The timezone for the store
- primaryLocale? string - The primary locale for the store. For example:
en,de, etc
- createdAt? string - The date and time the store was created in ISO 8601 format
- listIsActive? boolean - The status of the list connected to the store, namely if it's deleted or disabled
- platform? string - The e-commerce platform of the store
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
- moneyFormat? string - The currency format for the store. For example:
$,£, etc
- connectedSite? ConnectedSite3 -
- emailAddress? string - The email address for the store
- updatedAt? string - The date and time the store was last updated in ISO 8601 format
- phone? string - The store phone number
- domain? string - The store domain. The store domain must be unique within a user account
- name? string - The name of the store
- id? string - The unique identifier for the store
mailchimp.marketing: ECommerceStore2
An individual store in an account
Fields
- emailAddress? string - The email address for the store
- address? Address - The store address
- phone? string - The store phone number
- timezone? string - The timezone for the store
- domain? string - The store domain
- name? string - The name of the store
- primaryLocale? string - The primary locale for the store. For example:
en,de, etc
- platform? string - The e-commerce platform of the store
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
- moneyFormat? string - The currency format for the store. For example:
$,£, etc
mailchimp.marketing: ECommerceStore3
An individual store in an account
Fields
- automations? Automations - Details for the automations attached to this store
- address? Address - The store address
- listId? string - The unique identifier for the list that's associated with the store. The
list_idfor a specific store can't change
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- timezone? string - The timezone for the store
- primaryLocale? string - The primary locale for the store. For example:
en,de, etc
- createdAt? string - The date and time the store was created in ISO 8601 format
- listIsActive? boolean - The status of the list connected to the store, namely if it's deleted or disabled
- platform? string - The e-commerce platform of the store
- currencyCode? string - The three-letter ISO 4217 code for the currency that the store accepts
- moneyFormat? string - The currency format for the store. For example:
$,£, etc
- connectedSite? ConnectedSite3 -
- emailAddress? string - The email address for the store
- updatedAt? string - The date and time the store was last updated in ISO 8601 format
- phone? string - The store phone number
- domain? string - The store domain. The store domain must be unique within a user account
- name? string - The name of the store
- id? string - The unique identifier for the store
mailchimp.marketing: ECommerceStores
A collection of stores in the account
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- stores? ECommerceStore3[] - An array of objects, each representing a store
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: EcommercestoresstoreIdordersPromos
Fields
- code string - The Promo Code
- amountDiscounted decimal - The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0
- 'type "fixed"|"percentage" - Type of discount. For free shipping set type to fixed
mailchimp.marketing: EepurlActivity
A summary of social activity for the campaign, tracked by EepURL
Fields
- twitter? TwitterStats - A summary of Twitter activity for a campaign
- eepurl? string - The shortened link used for tracking
- referrers? Referrer[] - A summary of the top referrers for the campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- clicks? ClickSummary - A summary of the click-throughs on the campaign's URL
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The unique id for the campaign
mailchimp.marketing: EmailActivity
A list of member's subscriber activity in a specific campaign
Fields
- emails? EmailActivity2[] - An array of members that were sent the campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The unique id for the sent campaign
mailchimp.marketing: EmailActivity1
A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- emailAddress? string - Email address for a subscriber
- listId? string - The unique id for the list
- activity? MemberActivity[] - An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- campaignId? string - The unique id for the campaign
mailchimp.marketing: EmailActivity2
A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- emailAddress? string - Email address for a subscriber
- listId? string - The unique id for the list
- activity? MemberActivity[] - An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- campaignId? string - The unique id for the campaign
mailchimp.marketing: EmailClient
The email client
Fields
- members? int - The number of subscribed members who used this email client
- 'client? string - The name of the email client
mailchimp.marketing: EmailClients
The top email clients based on user-agent strings
Fields
- clients? EmailClient[] - An array of top email clients
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: EmailDomain
A single email domain's performance
Fields
- opensPct? decimal - The percentage of total opens from this domain
- emailsPct? decimal - The percentage of total emails that went to this domain
- domain? string - The name of the domain (gmail.com, hotmail.com, yahoo.com)
- emailsSent? int - The number of emails sent to that specific domain
- unsubs? int - The total number of unsubscribes for a domain
- opens? int - The number of opens for a domain
- clicks? int - The number of clicks for a domain
- delivered? int - The number of successful deliveries for a domain
- unsubsPct? decimal - The percentage of total unsubscribes from this domain
- bounces? int - The number of bounces at a domain
- clicksPct? decimal - The percentage of total clicks from this domain
- bouncesPct? decimal - The percentage of total bounces from this domain
mailchimp.marketing: Event
A specific event for a contact
Fields
- occurredAt? string - The date and time the event occurred in ISO 8601 format
- name? string - The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length
- properties? record { string... } - An optional list of properties
mailchimp.marketing: Events
A new event for a specific list member
Fields
- occurredAt? string - The date and time the event occurred in ISO 8601 format
- isSyncing? boolean - Events created with the is_syncing value set to
truewill not trigger automations
- name string - The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length
- properties? record { string... } - An optional list of properties
mailchimp.marketing: Events1
The events that can trigger the webhook and whether they are enabled
Fields
- subscribe? boolean - Whether the webhook is triggered when a list subscriber is added
- unsubscribe? boolean - Whether the webhook is triggered when a list member unsubscribes
- profile? boolean - Whether the webhook is triggered when a subscriber's profile is updated
- cleaned? boolean - Whether the webhook is triggered when a subscriber's email address is cleaned from the list
- campaign? boolean - Whether the webhook is triggered when a campaign is sent or cancelled
- upemail? boolean - Whether the webhook is triggered when a subscriber's email address is changed
mailchimp.marketing: Events2
The events that can trigger the webhook and whether they are enabled
Fields
- subscribe? boolean - Whether the webhook is triggered when a list subscriber is added
- unsubscribe? boolean - Whether the webhook is triggered when a list member unsubscribes
- profile? boolean - Whether the webhook is triggered when a subscriber's profile is updated
- cleaned? boolean - Whether the webhook is triggered when a subscriber's email address is cleaned from the list
- campaign? boolean - Whether the webhook is triggered when a campaign is sent or cancelled
- upemail? boolean - Whether the webhook is triggered when a subscriber's email address is changed
mailchimp.marketing: ExactMatches
Exact matches of the provided search query
Fields
- members? ListMembers4[] - An array of objects, each representing a specific list member
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ExactMatchesTags
Fields
- name? string - The name of the tag
- id? int - The tag id
mailchimp.marketing: FacebookAdsAllOf1
Fields
- hasSegment? boolean - If this outreach targets a segment of your audience
- thumbnail? string - The URL of the thumbnail for this outreach
- createTime? string - The date and time the outreach was created in ISO 8601 format
- canceledAt? string - The date and time the outreach was canceled in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. For example, for a
regularoutreach, you can view this campaign in your Mailchimp account athttps://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- 'type? "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms" - The type of outreach this object is
- startTime? string - The date and time the outreach was started in ISO 8601 format
- updatedAt? string - The date and time the outreach was last updated in ISO 8601 format
- recipients? Recipients - High level audience information for who the outreach targets
- publishedTime? string - The date and time the outreach was (or will be) published in ISO 8601 format
- name? string - Title or name of an Outreach
- id? string - Unique ID of an Outreach
- status? "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished" - The status of this outreach
- reportSummary? ReportSummary -
mailchimp.marketing: FacebookAdsAllOf11
Fields
- hasSegment? boolean - If this outreach targets a segment of your audience
- thumbnail? string - The URL of the thumbnail for this outreach
- createTime? string - The date and time the outreach was created in ISO 8601 format
- canceledAt? string - The date and time the outreach was canceled in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. For example, for a
regularoutreach, you can view this campaign in your Mailchimp account athttps://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- 'type? "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms" - The type of outreach this object is
- startTime? string - The date and time the outreach was started in ISO 8601 format
- updatedAt? string - The date and time the outreach was last updated in ISO 8601 format
- recipients? Recipients - High level audience information for who the outreach targets
- publishedTime? string - The date and time the outreach was (or will be) published in ISO 8601 format
- name? string - Title or name of an Outreach
- id? string - Unique ID of an Outreach
- status? "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished" - The status of this outreach
- reportSummary? ReportSummary -
mailchimp.marketing: FacebookAdsFacebookAdsAllOf112
Fields
- emailSourceName? string -
- pausedAt? string - The date and time the ad was paused in ISO 8601 format
- endTime? string - The date and time the ad was ended in ISO 8601 format
- needsAttention? boolean - If the ad has a problem and needs attention
- wasCanceledByFacebook? boolean -
mailchimp.marketing: FacebookAdsFacebookAdsAllOf12
Fields
- emailSourceName? string -
- pausedAt? string - The date and time the ad was paused in ISO 8601 format
- endTime? string - The date and time the ad was ended in ISO 8601 format
- needsAttention? boolean - If the ad has a problem and needs attention
- wasCanceledByFacebook? boolean -
mailchimp.marketing: FacebookAdsFacebookAdsFacebookAdsAllOf1123
Fields
- audience? InlineResponse20011Audience - Audience settings
- channel? InlineResponse20011Channel - Channel settings
- audienceActivity? InlineResponse20013AudienceActivity -
- budget? InlineResponse20011Budget -
- reportSummary? InlineResponse20013ReportSummary -
mailchimp.marketing: FacebookAdsFacebookAdsFacebookAdsAllOf123
A facebook ad
Fields
- isConnected? boolean - Check if this ad is connected to a facebook page
- feedback? InlineResponse20011Feedback - Check if this ad is connected to a facebook page
- site? InlineResponse20011Site - Connected Site
- audience? InlineResponse20011Audience - Audience settings
- hasAudience? boolean - Check if this ad has audience setup
- hasContent? boolean - Check if this ad has content
- channel? InlineResponse20011Channel - Channel settings
- content? InlineResponse20011Content -
- budget? InlineResponse20011Budget -
mailchimp.marketing: FacebookAdsFacebookAdsFacebookAdsFacebookAdsAllOf11234
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
mailchimp.marketing: FacebookAdsFacebookAdsFacebookAdsFacebookAdsAllOf1234
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
mailchimp.marketing: FacebookLikes
An object describing campaign engagement on Facebook
Fields
- facebookLikes? int - The number of Facebook likes for the campaign
- uniqueLikes? int - The number of unique likes
- recipientLikes? int - The number of recipients who liked the campaign on Facebook
mailchimp.marketing: FileManager
A list of available images and files stored in the File Manager for the account
Fields
- totalFileSize? decimal - The total size of all File Manager files in bytes
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- files? GalleryFile3[] - A list of files and images in an account
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: FileManagerFolders
A list of all folders in the File Manager
Fields
- folders? GalleryFolder2[] - A list of all folders in the File Manager
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: Forwards
An object describing the forwards and forward activity for the campaign
Fields
- forwardsCount? int - How many times the campaign has been forwarded
- forwardsOpens? int - How many times the forwarded campaign has been opened
mailchimp.marketing: GalleryFile
An individual file listed in the File Manager
Fields
- name string - The name of the file
- folderId? int - The id of the folder
- fileData string - The base64-encoded contents of the file
mailchimp.marketing: GalleryFile1
An individual file listed in the File Manager
Fields
- fullSizeUrl? string - The url of the full-size file
- size? int - The size of the file in bytes
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the file
- width? int - The width of the image
- createdAt? string - The date and time a file was added to the File Manager in ISO 8601 format
- id? int - The unique id of the file
- folderId? int - The id of the folder
- 'type? "image"|"file" - The type of file in the File Manager
- thumbnailUrl? string - The url of the thumbnail preview
- createdBy? string - The username of the profile that uploaded the file
- height? int - The height of an image
mailchimp.marketing: GalleryFile2
An individual file listed in the File Manager
Fields
- name? string - The name of the file
- folderId? int - The id of the folder. Setting
folder_idto0will remove a file from its current folder
mailchimp.marketing: GalleryFile3
An individual file listed in the File Manager
Fields
- fullSizeUrl? string - The url of the full-size file
- size? int - The size of the file in bytes
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the file
- width? int - The width of the image
- createdAt? string - The date and time a file was added to the File Manager in ISO 8601 format
- id? int - The unique id of the file
- folderId? int - The id of the folder
- 'type? "image"|"file" - The type of file in the File Manager
- thumbnailUrl? string - The url of the thumbnail preview
- createdBy? string - The username of the profile that uploaded the file
- height? int - The height of an image
mailchimp.marketing: GalleryFolder
An individual folder listed in the File Manager
Fields
- name string - The name of the folder
mailchimp.marketing: GalleryFolder1
An individual folder listed in the File Manager
Fields
- fileCount? int - The number of files in the folder
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the folder
- createdAt? string - The date and time a file was added to the File Manager in ISO 8601 format
- id? int - The unique id for the folder
- createdBy? string - The username of the profile that created the folder
mailchimp.marketing: GalleryFolder2
An individual folder listed in the File Manager
Fields
- fileCount? int - The number of files in the folder
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the folder
- createdAt? string - The date and time a file was added to the File Manager in ISO 8601 format
- id? int - The unique id for the folder
- createdBy? string - The username of the profile that created the folder
mailchimp.marketing: GetAccountExportIdQueries
Represents the Queries record for the operation: getAccountExportId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetAccountExportsQueries
Represents the Queries record for the operation: getAccountExports
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetActivityFeedChimpChatterQueries
Represents the Queries record for the operation: getActivityFeedChimpChatter
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
mailchimp.marketing: GetAllFacebookAdsQueries
Represents the Queries record for the operation: getAllFacebookAds
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "created_at"|"updated_at"|"end_time" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetAllLandingPagesQueries
Represents the Queries record for the operation: getAllLandingPages
Fields
- sortField? "created_at"|"updated_at" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetAuthorizedAppsIdQueries
Represents the Queries record for the operation: getAuthorizedAppsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetAuthorizedAppsQueries
Represents the Queries record for the operation: getAuthorizedApps
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetAutomationsIdQueries
Represents the Queries record for the operation: getAutomationsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetAutomationsQueries
Represents the Queries record for the operation: getAutomations
Fields
- sinceStartTime? string - Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- beforeCreateTime? string - Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- beforeStartTime? string - Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00
- sinceCreateTime? string - Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- status? "save"|"paused"|"sending" - Restrict the results to automations with the specified status
mailchimp.marketing: GetBatchesIdQueries
Represents the Queries record for the operation: getBatchesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetBatchesQueries
Represents the Queries record for the operation: getBatches
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetBatchWebhookQueries
Represents the Queries record for the operation: getBatchWebhook
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetBatchWebhooksQueries
Represents the Queries record for the operation: getBatchWebhooks
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetCampaignFoldersIdQueries
Represents the Queries record for the operation: getCampaignFoldersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetCampaignFoldersQueries
Represents the Queries record for the operation: getCampaignFolders
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetCampaignsIdContentQueries
Represents the Queries record for the operation: getCampaignsIdContent
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetCampaignsIdFeedbackIdQueries
Represents the Queries record for the operation: getCampaignsIdFeedbackId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetCampaignsIdFeedbackQueries
Represents the Queries record for the operation: getCampaignsIdFeedback
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetCampaignsIdQueries
Represents the Queries record for the operation: getCampaignsId
Fields
- includeResendShortcutEligibility? boolean - Return the
resend_shortcut_eligibilityfield in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- includeResendShortcutUsage? boolean - Return the
resend_shortcut_usagefield in the response. This includes information about campaigns related by a shortcut
mailchimp.marketing: GetCampaignsIdSendChecklistQueries
Represents the Queries record for the operation: getCampaignsIdSendChecklist
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetCampaignsQueries
Represents the Queries record for the operation: getCampaigns
Fields
- beforeSendTime? string - Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- memberId? string - 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
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sinceSendTime? string - Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- beforeCreateTime? string - Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- listId? string - The unique id for the list
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- sinceCreateTime? string - Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- includeResendShortcutEligibility? boolean - Return the
resend_shortcut_eligibilityfield in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? "regular"|"plaintext"|"absplit"|"rss"|"variate" - The campaign type
- sortField? "create_time"|"send_time" - Returns files sorted by the specified field
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- folderId? string - The unique folder id
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
- status? "save"|"paused"|"schedule"|"sending"|"sent" - The status of the campaign
mailchimp.marketing: GetConnectedSitesIdQueries
Represents the Queries record for the operation: getConnectedSitesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetConnectedSitesQueries
Represents the Queries record for the operation: getConnectedSites
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetConversationsIdMessagesIdQueries
Represents the Queries record for the operation: getConversationsIdMessagesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetConversationsIdMessagesQueries
Represents the Queries record for the operation: getConversationsIdMessages
Fields
- isRead? "true"|"false" - Whether a conversation message has been marked as read
- beforeTimestamp? string - Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sinceTimestamp? string - Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
mailchimp.marketing: GetConversationsIdQueries
Represents the Queries record for the operation: getConversationsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetConversationsQueries
Represents the Queries record for the operation: getConversations
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- hasUnreadMessages? "true"|"false" - Whether the conversation has any unread messages
- listId? string - The unique id for the list
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- campaignId? string - The unique id for the campaign
mailchimp.marketing: GetEcommerceOrdersQueries
Represents the Queries record for the operation: getEcommerceOrders
Fields
- hasOutreach? boolean - Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- outreachId? string - Restrict results to orders with a specific
outreach_idvalue
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- customerId? string - Restrict results to orders made by a specific customer
- campaignId? string - Restrict results to orders with a specific
campaign_idvalue
mailchimp.marketing: GetEcommerceStoresIdCartsIdLinesIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdCartsIdLinesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdCartsIdLinesQueries
Represents the Queries record for the operation: getEcommerceStoresIdCartsIdLines
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdCartsIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdCartsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdCartsQueries
Represents the Queries record for the operation: getEcommerceStoresIdCarts
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdCustomersIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdCustomersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdCustomersQueries
Represents the Queries record for the operation: getEcommerceStoresIdCustomers
Fields
- emailAddress? string - Restrict the response to customers with the email address
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdOrdersIdLinesIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdOrdersIdLinesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdOrdersIdLinesQueries
Represents the Queries record for the operation: getEcommerceStoresIdOrdersIdLines
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdOrdersIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdOrdersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdOrdersQueries
Represents the Queries record for the operation: getEcommerceStoresIdOrders
Fields
- hasOutreach? boolean - Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- outreachId? string - Restrict results to orders with a specific
outreach_idvalue
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- customerId? string - Restrict results to orders made by a specific customer
- campaignId? string - Restrict results to orders with a specific
campaign_idvalue
mailchimp.marketing: GetEcommerceStoresIdProductsIdImagesIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdProductsIdImagesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdProductsIdImagesQueries
Represents the Queries record for the operation: getEcommerceStoresIdProductsIdImages
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdProductsIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdProductsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdProductsIdVariantsIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdProductsIdVariantsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdProductsIdVariantsQueries
Represents the Queries record for the operation: getEcommerceStoresIdProductsIdVariants
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdProductsQueries
Represents the Queries record for the operation: getEcommerceStoresIdProducts
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdPromocodesIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdPromocodesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdPromocodesQueries
Represents the Queries record for the operation: getEcommerceStoresIdPromocodes
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdPromorulesIdQueries
Represents the Queries record for the operation: getEcommerceStoresIdPromorulesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdPromorulesQueries
Represents the Queries record for the operation: getEcommerceStoresIdPromorules
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresIdQueries
Represents the Queries record for the operation: getEcommerceStoresId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetEcommerceStoresQueries
Represents the Queries record for the operation: getEcommerceStores
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetFacebookAdsIdQueries
Represents the Queries record for the operation: getFacebookAdsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetFileManagerFilesIdQueries
Represents the Queries record for the operation: getFileManagerFilesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetFileManagerFilesQueries
Represents the Queries record for the operation: getFileManagerFiles
Fields
- beforeCreatedAt? string - Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "added_date"|"name"|"size" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- sinceCreatedAt? string - Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? string - The file type for the File Manager file
- createdBy? string - The Mailchimp account user who created the File Manager file
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetFileManagerFoldersFilesQueries
Represents the Queries record for the operation: getFileManagerFoldersFiles
Fields
- beforeCreatedAt? string - Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "added_date"|"name"|"size" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- sinceCreatedAt? string - Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? string - The file type for the File Manager file
- createdBy? string - The Mailchimp account user who created the File Manager file
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetFileManagerFoldersIdQueries
Represents the Queries record for the operation: getFileManagerFoldersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetFileManagerFoldersQueries
Represents the Queries record for the operation: getFileManagerFolders
Fields
- beforeCreatedAt? string - Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- sinceCreatedAt? string - Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- createdBy? string - The Mailchimp account user who created the File Manager file
mailchimp.marketing: GetLandingPageIdContentQueries
Represents the Queries record for the operation: getLandingPageIdContent
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetLandingPageIdQueries
Represents the Queries record for the operation: getLandingPageId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListMemberTagsQueries
Represents the Queries record for the operation: getListMemberTags
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdAbuseReportsIdQueries
Represents the Queries record for the operation: getListsIdAbuseReportsId
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdAbuseReportsQueries
Represents the Queries record for the operation: getListsIdAbuseReports
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdActivityQueries
Represents the Queries record for the operation: getListsIdActivity
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdClientsQueries
Represents the Queries record for the operation: getListsIdClients
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdGrowthHistoryIdQueries
Represents the Queries record for the operation: getListsIdGrowthHistoryId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdGrowthHistoryQueries
Represents the Queries record for the operation: getListsIdGrowthHistory
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "month" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetListsIdInterestCategoriesIdInterestsIdQueries
Represents the Queries record for the operation: getListsIdInterestCategoriesIdInterestsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdInterestCategoriesIdInterestsQueries
Represents the Queries record for the operation: getListsIdInterestCategoriesIdInterests
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdInterestCategoriesIdQueries
Represents the Queries record for the operation: getListsIdInterestCategoriesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdInterestCategoriesQueries
Represents the Queries record for the operation: getListsIdInterestCategories
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? string - Restrict results a type of interest group
mailchimp.marketing: GetListsIdLocationsQueries
Represents the Queries record for the operation: getListsIdLocations
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMembersIdActivityFeedQueries
Represents the Queries record for the operation: getListsIdMembersIdActivityFeed
Fields
- activityFilters? ("bounce"|"click"|"conversation"|"ecommerce_signup"|"event"|"web_engagement"|"generic_signup"|"landing_page_signup"|"marketing_permission"|"note"|"open"|"order"|"postcard_sent"|"sent"|"signup"|"squatter_signup"|"unsub"|"website_signup"|"survey_response"|"sms_bulk_sent"|"inbox_thread"|"qbo_payment_link"|"video_call_transcripts")[] - A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,bounce,click"
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMembersIdActivityQueries
Represents the Queries record for the operation: getListsIdMembersIdActivity
Fields
- action? ("abuse"|"bounce"|"click"|"open"|"sent"|"unsub"|"ecomm")[] - A comma seperated list of actions to return
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMembersIdEventsQueries
Represents the Queries record for the operation: getListsIdMembersIdEvents
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMembersIdGoalsQueries
Represents the Queries record for the operation: getListsIdMembersIdGoals
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMembersIdNotesIdQueries
Represents the Queries record for the operation: getListsIdMembersIdNotesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMembersIdNotesQueries
Represents the Queries record for the operation: getListsIdMembersIdNotes
Fields
- sortField? "created_at"|"updated_at"|"note_id" - Returns notes sorted by the specified field
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetListsIdMembersIdQueries
Represents the Queries record for the operation: getListsIdMembersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMembersQueries
Represents the Queries record for the operation: getListsIdMembers
Fields
- sinceLastChanged? string - Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- emailType? string - The email type
- interestMatch? "any"|"all"|"none" - Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. "any" will match a member with any of the interest supplied, "all" will only match members with every interest supplied, and "none" will match members without any of the interest supplied
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- vipOnly? boolean - A filter to return only the list's VIP members. Passing
truewill restrict results to VIP list members, passingfalsewill return all list members
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sinceTimestampOpt? string - Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- unsubscribedSince? string - Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error
- uniqueEmailId? string - A unique identifier for the email address across all Mailchimp lists
- interestIds? string - Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories
- beforeLastChanged? string - Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- sortField? "timestamp_opt"|"timestamp_signup"|"last_changed" - Returns files sorted by the specified field
- interestCategoryId? string - The unique id for the interest category
- sinceLastCampaign? boolean - Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- beforeTimestampOpt? string - Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional"|"archived" - The subscriber's status
mailchimp.marketing: GetListsIdMergeFieldsIdQueries
Represents the Queries record for the operation: getListsIdMergeFieldsId
Fields
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdMergeFieldsQueries
Represents the Queries record for the operation: getListsIdMergeFields
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? string - The merge field type
- required? boolean - Whether it's a required merge field
mailchimp.marketing: GetListsIdQueries
Represents the Queries record for the operation: getListsId
Fields
- includeTotalContacts? boolean - Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetListsIdSegmentsIdMembersQueries
Represents the Queries record for the operation: getListsIdSegmentsIdMembers
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- includeUnsubscribed? boolean - Include unsubscribed members in response
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- includeTransactional? boolean - Include transactional members in response
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- includeCleaned? boolean - Include cleaned members in response
mailchimp.marketing: GetListsIdSegmentsIdQueries
Represents the Queries record for the operation: getListsIdSegmentsId
Fields
- includeUnsubscribed? boolean - Include unsubscribed members in response
- includeTransactional? boolean - Include transactional members in response
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- includeCleaned? boolean - Include cleaned members in response
mailchimp.marketing: GetListsQueries
Represents the Queries record for the operation: getLists
Fields
- beforeCampaignLastSent? string - Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- hasEcommerceStore? boolean - Restrict results to lists that contain an active, connected, undeleted ecommerce store
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- beforeDateCreated? string - Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- includeTotalContacts? boolean - Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sinceDateCreated? string - Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- sinceCampaignLastSent? string - Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- sortField? "date_created" - Returns files sorted by the specified field
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- email? string - Restrict results to lists that include a specific subscriber's email address
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetReportingFacebookAdsIdEcommerceProductActivityQueries
Represents the Queries record for the operation: getReportingFacebookAdsIdEcommerceProductActivity
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "title"|"total_revenue"|"total_purchased" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportingFacebookAdsIdQueries
Represents the Queries record for the operation: getReportingFacebookAdsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportingFacebookAdsQueries
Represents the Queries record for the operation: getReportingFacebookAds
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "created_at"|"updated_at"|"end_time" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetReportingLandingPagesIdQueries
Represents the Queries record for the operation: getReportingLandingPagesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportingLandingPagesQueries
Represents the Queries record for the operation: getReportingLandingPages
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportingSurveysIdQueries
Represents the Queries record for the operation: getReportingSurveysId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportingSurveysIdQuestionsIdAnswersQueries
Represents the Queries record for the operation: getReportingSurveysIdQuestionsIdAnswers
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- respondentFamiliarityIs? "new"|"known"|"unknown" - Filter survey responses by familiarity of the respondents
mailchimp.marketing: GetReportingSurveysIdQuestionsIdQueries
Represents the Queries record for the operation: getReportingSurveysIdQuestionsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportingSurveysIdQuestionsQueries
Represents the Queries record for the operation: getReportingSurveysIdQuestions
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportingSurveysIdResponsesQueries
Represents the Queries record for the operation: getReportingSurveysIdResponses
Fields
- choseAnswer? string - The ID of the option chosen to filter responses on
- answeredQuestion? int - The ID of the question that was answered
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- respondentFamiliarityIs? "new"|"known"|"unknown" - Filter survey responses by familiarity of the respondents
mailchimp.marketing: GetReportingSurveysQueries
Represents the Queries record for the operation: getReportingSurveys
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdAbuseReportsIdIdQueries
Represents the Queries record for the operation: getReportsIdAbuseReportsIdId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdAbuseReportsIdQueries
Represents the Queries record for the operation: getReportsIdAbuseReportsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdAdviceQueries
Represents the Queries record for the operation: getReportsIdAdvice
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdClickDetailsIdMembersIdQueries
Represents the Queries record for the operation: getReportsIdClickDetailsIdMembersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdClickDetailsIdMembersQueries
Represents the Queries record for the operation: getReportsIdClickDetailsIdMembers
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdClickDetailsIdQueries
Represents the Queries record for the operation: getReportsIdClickDetailsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdClickDetailsQueries
Represents the Queries record for the operation: getReportsIdClickDetails
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "total_clicks"|"unique_clicks" - Returns click reports sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: GetReportsIdDomainPerformanceQueries
Represents the Queries record for the operation: getReportsIdDomainPerformance
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdEcommerceProductActivityQueries
Represents the Queries record for the operation: getReportsIdEcommerceProductActivity
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "title"|"total_revenue"|"total_purchased" - Returns files sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdEepurlQueries
Represents the Queries record for the operation: getReportsIdEepurl
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdEmailActivityIdQueries
Represents the Queries record for the operation: getReportsIdEmailActivityId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- since? string - Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
mailchimp.marketing: GetReportsIdEmailActivityQueries
Represents the Queries record for the operation: getReportsIdEmailActivity
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- since? string - Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
mailchimp.marketing: GetReportsIdLocationsQueries
Represents the Queries record for the operation: getReportsIdLocations
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdOpenDetailsIdMembersIdQueries
Represents the Queries record for the operation: getReportsIdOpenDetailsIdMembersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdOpenDetailsQueries
Represents the Queries record for the operation: getReportsIdOpenDetails
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sortField? "opens_count" - Returns open reports sorted by the specified field
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
- since? string - Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
mailchimp.marketing: GetReportsIdQueries
Represents the Queries record for the operation: getReportsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdSentToIdQueries
Represents the Queries record for the operation: getReportsIdSentToId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdSentToQueries
Represents the Queries record for the operation: getReportsIdSentTo
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdSubReportsIdQueries
Represents the Queries record for the operation: getReportsIdSubReportsId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdUnsubscribedIdQueries
Represents the Queries record for the operation: getReportsIdUnsubscribedId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsIdUnsubscribedQueries
Represents the Queries record for the operation: getReportsIdUnsubscribed
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetReportsQueries
Represents the Queries record for the operation: getReports
Fields
- beforeSendTime? string - Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- sinceSendTime? string - Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? "regular"|"plaintext"|"absplit"|"rss"|"variate" - The campaign type
mailchimp.marketing: GetRootQueries
Represents the Queries record for the operation: getRoot
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetSearchCampaignsQueries
Represents the Queries record for the operation: getSearchCampaigns
Fields
- query string - The search query used to filter results
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetSearchMembersQueries
Represents the Queries record for the operation: getSearchMembers
Fields
- listId? string - The unique id for the list
- query string - The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetTemplateFoldersIdQueries
Represents the Queries record for the operation: getTemplateFoldersId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetTemplateFoldersQueries
Represents the Queries record for the operation: getTemplateFolders
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetTemplatesIdDefaultContentQueries
Represents the Queries record for the operation: getTemplatesIdDefaultContent
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetTemplatesIdQueries
Represents the Queries record for the operation: getTemplatesId
Fields
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
mailchimp.marketing: GetTemplatesQueries
Represents the Queries record for the operation: getTemplates
Fields
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- beforeDateCreated? string - Restrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? string - Limit results based on template type
- createdBy? string - The Mailchimp account user who created the template
- sinceDateCreated? string - Restrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- sortField? "date_created"|"date_edited"|"name" - Returns user templates sorted by the specified field
- contentType? "html"|"template"|"multichannel" - Limit results based on how the template's content is put together. Only templates of type
usercan be filtered bycontent_type. If you want to retrieve saved templates created with the legacy email editor, then filtercontent_typetotemplate. If you'd rather pull your saved templates for the new editor, filter tomultichannel. For code your own templates, filter tohtml
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- category? string - Limit results based on category
- folderId? string - The unique folder id
- sortDir? "ASC"|"DESC" - Determines the order direction for sorted results
mailchimp.marketing: Goal
A single instance of a goal activity
Fields
- goalId? int - The id for a Goal event
- data? string - Any extra data passed with the Goal event
- lastVisitedAt? string - The date and time the user last triggered the Goal event in ISO 8601 format
- event? string - The name/type of Goal event triggered
mailchimp.marketing: GroupA
Stats for Group A
Fields
- clickPercentageA? decimal - The percentage of total clicks for Group A
- uniqueClicksA? int - The number of unique clicks for Group A
- totalClicksA? int - The total number of clicks for Group A
- uniqueClickPercentageA? decimal - The percentage of unique clicks for Group A
mailchimp.marketing: GroupB
Stats for Group B
Fields
- clickPercentageB? decimal - The percentage of total clicks for Group B
- uniqueClicksB? int - The number of unique clicks for Group B
- totalClicksB? int - The total number of clicks for Group B
- uniqueClickPercentageB? decimal - The percentage of unique clicks for Group B
mailchimp.marketing: GrowthHistory
A month-by-month summary of a specific list's growth activity
Fields
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- history? GrowthHistory2[] - An array of objects, each representing a monthly growth report for a list
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: GrowthHistory1
A summary of a specific list's growth activity for a specific month and year
Fields
- imports? int - (deprecated)
- listId? string - The list id for the growth activity report
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- pending? int - Pending members on the list for a specific month
- reconfirm? int - Newly reconfirmed members on the list for a specific month
- existing? int - (deprecated)
- optins? int - (deprecated)
- subscribed? int - Total subscribed members on the list at the end of the month
- unsubscribed? int - Newly unsubscribed members on the list for a specific month
- deleted? int - Newly deleted members on the list for a specific month
- month? string - The month that the growth history is describing
- cleaned? int - Newly cleaned (hard-bounced) members on the list for a specific month
- 'transactional? int - Subscribers that have been sent transactional emails via Mandrill
mailchimp.marketing: GrowthHistory2
A summary of a specific list's growth activity for a specific month and year
Fields
- imports? int - (deprecated)
- listId? string - The list id for the growth activity report
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- pending? int - Pending members on the list for a specific month
- reconfirm? int - Newly reconfirmed members on the list for a specific month
- existing? int - (deprecated)
- optins? int - (deprecated)
- subscribed? int - Total subscribed members on the list at the end of the month
- unsubscribed? int - Newly unsubscribed members on the list for a specific month
- deleted? int - Newly deleted members on the list for a specific month
- month? string - The month that the growth history is describing
- cleaned? int - Newly cleaned (hard-bounced) members on the list for a specific month
- 'transactional? int - Subscribers that have been sent transactional emails via Mandrill
mailchimp.marketing: Hours
The hours an Automation workflow can send
Fields
- 'type "send_asap"|"send_between"|"send_at" - When to send the Automation email
mailchimp.marketing: IndustryStats
The average campaign statistics for your industry
Fields
- unopenRate? decimal - The industry unopened rate
- clickRate? decimal - The industry click rate
- bounceRate? decimal - The industry bounce rate
- unsubRate? decimal - The industry unsubscribe rate
- 'type? string - The type of business industry associated with your account. For example: retail, education, etc
- abuseRate? decimal - The industry abuse rate
- openRate? decimal - The industry open rate
mailchimp.marketing: IndustryStats1
The average campaign statistics for all campaigns in the account's specified industry
Fields
- clickRate? decimal - The average unique click rate for all campaigns in the account's specified industry
- bounceRate? decimal - The average bounce rate for all campaigns in the account's specified industry
- openRate? decimal - The average unique open rate for all campaigns in the account's specified industry
mailchimp.marketing: InlineResponse200
An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- chimpChatter? ChimpChatter[] - An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse2001
An array of objects, each representing an account export
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- exports? InlineResponse2001Exports[] - An array of objects, each representing an account export
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse20010
Contains an array of facebook ads
Fields
- facebookAds? InlineResponse20010FacebookAds[] -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse20010FacebookAds
Fields
- Fields Included from *FacebookAdsAllOf1
- hasSegment boolean
- thumbnail string
- createTime string
- canceledAt string
- webId int
- type "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms"
- showReport boolean
- startTime string
- updatedAt string
- recipients Recipients
- publishedTime string
- name string
- id string
- status "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished"
- reportSummary ReportSummary
- anydata...
- Fields Included from *FacebookAdsFacebookAdsAllOf12
- Fields Included from *FacebookAdsFacebookAdsFacebookAdsAllOf123
- isConnected boolean
- feedback InlineResponse20011Feedback
- site InlineResponse20011Site
- audience InlineResponse20011Audience
- hasAudience boolean
- hasContent boolean
- channel InlineResponse20011Channel
- content InlineResponse20011Content
- budget InlineResponse20011Budget
- anydata...
- Fields Included from *FacebookAdsFacebookAdsFacebookAdsFacebookAdsAllOf1234
- links ResourceLink[]
- anydata...
mailchimp.marketing: InlineResponse20011
Fields
- Fields Included from *InlineResponse20011AllOf1
- hasSegment boolean
- thumbnail string
- createTime string
- canceledAt string
- webId int
- type "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms"
- showReport boolean
- startTime string
- updatedAt string
- recipients Recipients
- publishedTime string
- name string
- id string
- status "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished"
- reportSummary ReportSummary
- anydata...
- Fields Included from *InlineResponse20011InlineResponse20011AllOf12
- Fields Included from *InlineResponse20011InlineResponse20011InlineResponse20011AllOf123
- isConnected boolean
- feedback InlineResponse20011Feedback
- site InlineResponse20011Site
- audience InlineResponse20011Audience
- hasAudience boolean
- hasContent boolean
- channel InlineResponse20011Channel
- content InlineResponse20011Content
- budget InlineResponse20011Budget
- anydata...
- Fields Included from *InlineResponse20011InlineResponse20011InlineResponse20011InlineResponse20011AllOf1234
- links ResourceLink[]
- anydata...
mailchimp.marketing: InlineResponse20011AllOf1
Fields
- hasSegment? boolean - If this outreach targets a segment of your audience
- thumbnail? string - The URL of the thumbnail for this outreach
- createTime? string - The date and time the outreach was created in ISO 8601 format
- canceledAt? string - The date and time the outreach was canceled in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. For example, for a
regularoutreach, you can view this campaign in your Mailchimp account athttps://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- 'type? "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms" - The type of outreach this object is
- startTime? string - The date and time the outreach was started in ISO 8601 format
- updatedAt? string - The date and time the outreach was last updated in ISO 8601 format
- recipients? Recipients - High level audience information for who the outreach targets
- publishedTime? string - The date and time the outreach was (or will be) published in ISO 8601 format
- name? string - Title or name of an Outreach
- id? string - Unique ID of an Outreach
- status? "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished" - The status of this outreach
- reportSummary? ReportSummary -
mailchimp.marketing: InlineResponse20011Audience
Audience settings
Fields
- includeSourceInTarget? boolean - To include list contacts as part of audience
- emailSource? InlineResponse20011AudienceEmailSource -
- targetingSpecs? InlineResponse20011AudienceTargetingSpecs -
- sourceType? "facebook"|"list" - List or Facebook based audience
- 'type? "Custom Audience"|"Lookalike Audience"|"Interest-based Audience" - Type of the audience
- lookalikeCountryCode? string - To find similar audience in given country
mailchimp.marketing: InlineResponse20011AudienceEmailSource
Fields
- name? string - Email source name
- segmentType? string - Segment type if this source is tied to a segment
- listName? string - Associated list name to the source
- 'type? string - Type of the email source
- isSegment? boolean - Is the source reference a segment
mailchimp.marketing: InlineResponse20011AudienceTargetingSpecs
Fields
- maxAge? int -
- gender? int -
- locations? InlineResponse20011AudienceTargetingSpecsLocations -
- minAge? int -
- interests? InlineResponse20011AudienceTargetingSpecsInterests[] -
mailchimp.marketing: InlineResponse20011AudienceTargetingSpecsInterests
Fields
- name? string -
mailchimp.marketing: InlineResponse20011AudienceTargetingSpecsLocations
Fields
- regions? string[] -
- cities? string[] -
- countries? string[] -
- zips? string[] -
mailchimp.marketing: InlineResponse20011Budget
Fields
- duration? int - Duration of the ad in seconds
- totalAmount? decimal - Total budget of the ad
- currencyCode? string - Currency code
mailchimp.marketing: InlineResponse20011Channel
Channel settings
Fields
- fbPlacementFeed? boolean - Is this for facebook feed
- fbPlacementAudience? boolean - Is this for facebook audience
- igPlacementFeed? boolean - Is this for instagram feed
mailchimp.marketing: InlineResponse20011Content
Fields
- attachments? InlineResponse20011ContentAttachments[] -
- callToAction? string -
- imageUrl? string -
- linkUrl? string -
- description? string -
- title? string -
- message? string -
mailchimp.marketing: InlineResponse20011ContentAttachments
Fields
- callToAction? string -
- imageUrl? string -
- name? string -
- linkUrl? string -
- description? string -
mailchimp.marketing: InlineResponse20011Feedback
Check if this ad is connected to a facebook page
Fields
- audience? string - Feedback regarding the audience of this Ad
- compliance? string - Feedback regarding the compliance of this Ad
- content? string - Feedback regarding the content of this Ad
- budget? string - Feedback regarding the budget of this Ad
mailchimp.marketing: InlineResponse20011InlineResponse20011AllOf12
Fields
- emailSourceName? string -
- pausedAt? string - The date and time the ad was paused in ISO 8601 format
- endTime? string - The date and time the ad was ended in ISO 8601 format
- needsAttention? boolean - If the ad has a problem and needs attention
- wasCanceledByFacebook? boolean -
mailchimp.marketing: InlineResponse20011InlineResponse20011InlineResponse20011AllOf123
A facebook ad
Fields
- isConnected? boolean - Check if this ad is connected to a facebook page
- feedback? InlineResponse20011Feedback - Check if this ad is connected to a facebook page
- site? InlineResponse20011Site - Connected Site
- audience? InlineResponse20011Audience - Audience settings
- hasAudience? boolean - Check if this ad has audience setup
- hasContent? boolean - Check if this ad has content
- channel? InlineResponse20011Channel - Channel settings
- content? InlineResponse20011Content -
- budget? InlineResponse20011Budget -
mailchimp.marketing: InlineResponse20011InlineResponse20011InlineResponse20011InlineResponse20011AllOf1234
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
mailchimp.marketing: InlineResponse20011Site
Connected Site
Fields
- name? string - The name of the connected site
- id? int - The ID of this connected site
- url? string - The URL for this connected site
mailchimp.marketing: InlineResponse20012
A collection of Facebook ads
Fields
- facebookAds? InlineResponse20012FacebookAds[] -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse20012FacebookAds
Fields
- Fields Included from *FacebookAdsAllOf11
- hasSegment boolean
- thumbnail string
- createTime string
- canceledAt string
- webId int
- type "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms"
- showReport boolean
- startTime string
- updatedAt string
- recipients Recipients
- publishedTime string
- name string
- id string
- status "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished"
- reportSummary ReportSummary
- anydata...
- Fields Included from *FacebookAdsFacebookAdsAllOf112
- Fields Included from *FacebookAdsFacebookAdsFacebookAdsAllOf1123
- audience InlineResponse20011Audience
- channel InlineResponse20011Channel
- audienceActivity InlineResponse20013AudienceActivity
- budget InlineResponse20011Budget
- reportSummary InlineResponse20013ReportSummary
- anydata...
- Fields Included from *FacebookAdsFacebookAdsFacebookAdsFacebookAdsAllOf11234
- links ResourceLink[]
- anydata...
- reportSummary? record { reach int, clickRate decimal, impressions decimal, ecommerce ReportSummaryEcommerce, clicks int } -
mailchimp.marketing: InlineResponse20013
Fields
- Fields Included from *InlineResponse20013AllOf1
- hasSegment boolean
- thumbnail string
- createTime string
- canceledAt string
- webId int
- type "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms"
- showReport boolean
- startTime string
- updatedAt string
- recipients Recipients
- publishedTime string
- name string
- id string
- status "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished"
- reportSummary ReportSummary
- anydata...
- Fields Included from *InlineResponse20013InlineResponse20013AllOf12
- Fields Included from *InlineResponse20013InlineResponse20013InlineResponse20013AllOf123
- audience InlineResponse20011Audience
- channel InlineResponse20011Channel
- audienceActivity InlineResponse20013AudienceActivity
- budget InlineResponse20011Budget
- reportSummary InlineResponse20013ReportSummary
- anydata...
- Fields Included from *InlineResponse20013InlineResponse20013InlineResponse20013InlineResponse20013AllOf1234
- links ResourceLink[]
- anydata...
- reportSummary? record { reach int, clickRate decimal, impressions decimal, ecommerce ReportSummaryEcommerce, clicks int } -
mailchimp.marketing: InlineResponse20013AllOf1
Fields
- hasSegment? boolean - If this outreach targets a segment of your audience
- thumbnail? string - The URL of the thumbnail for this outreach
- createTime? string - The date and time the outreach was created in ISO 8601 format
- canceledAt? string - The date and time the outreach was canceled in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. For example, for a
regularoutreach, you can view this campaign in your Mailchimp account athttps://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- 'type? "regular"|"email-touchpoint"|"plaintext"|"rss"|"reconfirm"|"variate"|"absplit"|"automation"|"facebook"|"google"|"autoresponder"|"transactional"|"page"|"website"|"social_post"|"survey"|"customer_journey"|"sms" - The type of outreach this object is
- startTime? string - The date and time the outreach was started in ISO 8601 format
- updatedAt? string - The date and time the outreach was last updated in ISO 8601 format
- recipients? Recipients - High level audience information for who the outreach targets
- publishedTime? string - The date and time the outreach was (or will be) published in ISO 8601 format
- name? string - Title or name of an Outreach
- id? string - Unique ID of an Outreach
- status? "save"|"paused"|"schedule"|"scheduled"|"sending"|"sent"|"canceled"|"canceling"|"active"|"disconnected"|"somepaused"|"draft"|"completed"|"partialRejected"|"pending"|"rejected"|"published"|"unpublished" - The status of this outreach
- reportSummary? ReportSummary -
mailchimp.marketing: InlineResponse20013AudienceActivity
Fields
- revenue? InlineResponse20013AudienceActivityRevenue[] -
- clicks? InlineResponse20013AudienceActivityClicks[] -
- impressions? InlineResponse20013AudienceActivityImpressions[] -
mailchimp.marketing: InlineResponse20013AudienceActivityClicks
Fields
- date? string -
- clicks? int -
mailchimp.marketing: InlineResponse20013AudienceActivityImpressions
Fields
- date? string -
- impressions? int -
mailchimp.marketing: InlineResponse20013AudienceActivityRevenue
Fields
- date? string -
- revenue? decimal -
mailchimp.marketing: InlineResponse20013InlineResponse20013AllOf12
Fields
- emailSourceName? string -
- pausedAt? string - The date and time the ad was paused in ISO 8601 format
- endTime? string - The date and time the ad was ended in ISO 8601 format
- needsAttention? boolean - If the ad has a problem and needs attention
- wasCanceledByFacebook? boolean -
mailchimp.marketing: InlineResponse20013InlineResponse20013InlineResponse20013AllOf123
Fields
- audience? InlineResponse20011Audience - Audience settings
- channel? InlineResponse20011Channel - Channel settings
- audienceActivity? InlineResponse20013AudienceActivity -
- budget? InlineResponse20011Budget -
- reportSummary? InlineResponse20013ReportSummary -
mailchimp.marketing: InlineResponse20013InlineResponse20013InlineResponse20013InlineResponse20013AllOf1234
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
mailchimp.marketing: InlineResponse20013ReportSummary
Report summary of facebook ad
Fields
- totalProductsSold? int -
- comments? int -
- reach? int -
- clickRate? decimal -
- costPerClick? InlineResponse20013ReportSummaryAverageOrderAmount -
- extendedAt? InlineResponse20013ReportSummaryExtendedAt -
- returnOnInvestment? decimal -
- impressions? decimal -
- totalOrders? int -
- firstTimeBuyers? int -
- averageOrderAmount? InlineResponse20013ReportSummaryAverageOrderAmount -
- averageDailyBudget? InlineResponse20013ReportSummaryAverageOrderAmount -
- uniqueClicks? int -
- hasExtendedAdDuration? boolean -
- ecommerce? InlineResponse20013ReportSummaryEcommerce -
- clicks? int -
- likes? int -
mailchimp.marketing: InlineResponse20013ReportSummaryAverageOrderAmount
Fields
- amount? decimal -
- currencyCode? string -
mailchimp.marketing: InlineResponse20013ReportSummaryEcommerce
Fields
- totalRevenue? decimal -
- currencyCode? string -
mailchimp.marketing: InlineResponse20013ReportSummaryExtendedAt
Fields
- datetime? string -
- timezone? string -
mailchimp.marketing: InlineResponse20014
A collection of landing pages
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- landingPages? LandingPageReport1[] -
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse20015
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- surveys? SurveyReport[] - The surveys that have reports available
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse20016
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- questions? SurveyQuestionReport1[] - An array of reports for each question on the survey
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse20017
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- answers? SurveyQuestionAnswer[] - An array of answers for a question on the survey
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse20018
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- responses? SurveyRespondents[] - An array of responses to a survey
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse2001Exports
An account export
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- sizeInBytes? int - The size of the uncompressed export in bytes
- downloadUrl? string - If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes
- started? string - Start time for the export
- finished? string - If finished, the finish time for the export
- exportId? int - The ID for the export
mailchimp.marketing: InlineResponse2002
An account export
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- sizeInBytes? int - The size of the uncompressed export in bytes
- downloadUrl? string - If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes
- started? string - Start time for the export
- finished? string - If finished, the finish time for the export
- exportId? int - The ID for the export
mailchimp.marketing: InlineResponse2003
An array of objects, each representing an authorized application
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- apps? InlineResponse2003Apps[] - An array of objects, each representing an authorized application
mailchimp.marketing: InlineResponse2003Apps
An authorized app
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the application
- description? string - A short description of the application
- id? int - The ID for the application
- users? string[] - An array of usernames for users who have linked the app
mailchimp.marketing: InlineResponse2004
An authorized app
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the application
- description? string - A short description of the application
- id? int - The ID for the application
- users? string[] - An array of usernames for users who have linked the app
mailchimp.marketing: InlineResponse2005
An array of objects, each representing an Automation workflow
Fields
- automations? AutomationWorkflow2[] - An array of objects, each representing an Automation workflow
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse2006
An automation workflow
Fields
- emailId? string - A string that uniquely identifies an email in an Automation workflow
- workflowId? string - A string that uniquely identifies an Automation workflow
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- queue? SubscriberInAutomationQueue2[] - An array of objects, each representing a subscriber queue for an email in an Automation workflow
mailchimp.marketing: InlineResponse2007
An array of campaigns
Fields
- campaigns? Campaign4[] - An array of campaigns
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse2008
A collection of landing pages
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- landingPages? LandingPage3[] - The landing pages on the account
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: InlineResponse2009
A collection of ecommerce products
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- products? InlineResponse2009Products[] -
mailchimp.marketing: InlineResponse2009Products
Fields
- totalPurchased? decimal -
- imageUrl? string -
- totalRevenue? decimal -
- recommendationPurchased? int -
- recommendationTotal? int -
- title? string -
- sku? string -
- currencyCode? string -
mailchimp.marketing: Interest
Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application
Fields
- name string - The name of the interest. This can be shown publicly on a subscription form
- displayOrder? int - The display order for interests
mailchimp.marketing: Interest1
Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application
Fields
- categoryId? string - The id for the interest category
- listId? string - The ID for the list that this interest belongs to
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- subscriberCount? string - The number of subscribers associated with this interest
- name? string - The name of the interest. This can be shown publicly on a subscription form
- displayOrder? int - The display order for interests
- id? string - The ID for the interest
mailchimp.marketing: Interest2
Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application
Fields
- categoryId? string - The id for the interest category
- listId? string - The ID for the list that this interest belongs to
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- subscriberCount? string - The number of subscribers associated with this interest
- name? string - The name of the interest. This can be shown publicly on a subscription form
- displayOrder? int - The display order for interests
- id? string - The ID for the interest
mailchimp.marketing: InterestCategory
Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application
Fields
- displayOrder? int - The order that the categories are displayed in the list. Lower numbers display first
- title string - The text description of this category. This field appears on signup forms and is often phrased as a question
- 'type "checkboxes"|"dropdown"|"radio"|"hidden" - Determines how this category’s interests appear on signup forms
mailchimp.marketing: InterestCategory1
Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application
Fields
- listId? string - The unique list id for the category
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- displayOrder? int - The order that the categories are displayed in the list. Lower numbers display first
- id? string - The id for the interest category
- title? string - The text description of this category. This field appears on signup forms and is often phrased as a question
- 'type? "checkboxes"|"dropdown"|"radio"|"hidden" - Determines how this category’s interests appear on signup forms
mailchimp.marketing: InterestCategory2
Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application
Fields
- listId? string - The unique list id for the category
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- displayOrder? int - The order that the categories are displayed in the list. Lower numbers display first
- id? string - The id for the interest category
- title? string - The text description of this category. This field appears on signup forms and is often phrased as a question
- 'type? "checkboxes"|"dropdown"|"radio"|"hidden" - Determines how this category’s interests appear on signup forms
mailchimp.marketing: InterestGroupings
Information about this list's interest categories
Fields
- listId? string - The ID for the list that this category belongs to
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- categories? InterestCategory2[] - This array contains individual interest categories
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: Interests
A list of this category's interests
Fields
- listId? string - The unique list id that the interests belong to
- categoryId? string - The id for the interest category
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- interests? Interest2[] - An array of this category's interests
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: LandingPage
A summary of an individual page's properties
Fields
- storeId? string - The ID of the store associated with this landing page
- listId? string - The list's ID associated with this landing page
- name? string - The name of this landing page
- description? string - The description of this landing page
- templateId? int - The template_id of this landing page
- title? string - The title of this landing page seen in the browser's title bar
- 'type? "signup"|"product" - The type of template the landing page has
- tracking? TrackingSettings - The tracking settings applied to this landing page
mailchimp.marketing: LandingPage1
A summary of an individual landing page's settings and content
Fields
- storeId? string - The ID of the store associated with this landing page
- createdBySource? string - Created by mobile or web
- listId? string - The list's ID associated with this landing page
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- description? string - The description of this landing page
- createdAt? string - The time this landing page was created
- webId? int - The ID used in the Mailchimp web application
- title? string - The title of this landing page seen in the browser's title bar
- tracking? TrackingSettings - The tracking settings applied to this landing page
- url? string - The url of the published landing page
- updatedAt? string - The time this landing page was updated at
- name? string - The name of this landing page
- templateId? int - The template_id of this landing page
- id? string - A string that uniquely identifies this landing page
- publishedAt? string - The time this landing page was published
- status? "published"|"unpublished"|"draft" - The status of this landing page
- unpublishedAt? string - The time this landing page was unpublished
mailchimp.marketing: LandingPage2
A summary of an individual page's properties
Fields
- storeId? string - The ID of the store associated with this landing page
- listId? string - The list's ID associated with this landing page
- name? string - The name of this landing page
- description? string - The description of this landing page
- title? string - The title of this landing page seen in the browser's title bar
- tracking? TrackingSettings - The tracking settings applied to this landing page
mailchimp.marketing: LandingPage3
A summary of an individual landing page's settings and content
Fields
- storeId? string - The ID of the store associated with this landing page
- createdBySource? string - Created by mobile or web
- listId? string - The list's ID associated with this landing page
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- description? string - The description of this landing page
- createdAt? string - The time this landing page was created
- webId? int - The ID used in the Mailchimp web application
- title? string - The title of this landing page seen in the browser's title bar
- tracking? TrackingSettings - The tracking settings applied to this landing page
- url? string - The url of the published landing page
- updatedAt? string - The time this landing page was updated at
- name? string - The name of this landing page
- templateId? int - The template_id of this landing page
- id? string - A string that uniquely identifies this landing page
- publishedAt? string - The time this landing page was published
- status? "published"|"unpublished"|"draft" - The status of this landing page
- unpublishedAt? string - The time this landing page was unpublished
mailchimp.marketing: LandingPageContent
The HTML content for a landing page
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- 'json? string - The JSON Structure for the landing page
- html? string - The raw HTML for the landing page
mailchimp.marketing: LandingPageReport
A summary of an individual landing page's settings and content
Fields
- uniqueVisits? int - The number of unique visits to this landing pages
- subscribes? int - The number of subscribes to this landing pages
- listId? string - The list id connected to this landing page
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- webId? int - The ID used in the Mailchimp web application
- listName? string - List Name
- title? string - The name of the landing page the user's customers will see
- url? string - The landing page url
- signupTags? Tag[] - A list of tags associated to the landing page
- visits? int - The number of visits to this landing pages
- timeseries? LandingPageReportTimeseries -
- ecommerce? LandingPageReportEcommerce -
- name? string - The name of this landing page the user will see
- clicks? int - The number of clicks to this landing pages
- id? string - A string that uniquely identifies this landing page
- publishedAt? string - The time this landing page was published
- conversionRate? decimal - The percentage of people who visited your landing page and were added to your list
- unpublishedAt? string - The time this landing page was unpublished
- status? string - The status of the landing page
mailchimp.marketing: LandingPageReport1
A summary of an individual landing page's settings and content
Fields
- uniqueVisits? int - The number of unique visits to this landing pages
- subscribes? int - The number of subscribes to this landing pages
- listId? string - The list id connected to this landing page
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- webId? int - The ID used in the Mailchimp web application
- listName? string - List Name
- title? string - The name of the landing page the user's customers will see
- url? string - The landing page url
- signupTags? Tag[] - A list of tags associated to the landing page
- visits? int - The number of visits to this landing pages
- timeseries? LandingPageReportTimeseries -
- ecommerce? LandingPageReportEcommerce -
- name? string - The name of this landing page the user will see
- clicks? int - The number of clicks to this landing pages
- id? string - A string that uniquely identifies this landing page
- publishedAt? string - The time this landing page was published
- conversionRate? decimal - The percentage of people who visited your landing page and were added to your list
- unpublishedAt? string - The time this landing page was unpublished
- status? string - The status of the landing page
mailchimp.marketing: LandingPageReportEcommerce
Fields
- averageOrderRevenue? decimal - The average order revenue of this landing page
- totalRevenue? decimal - The total revenue of this landing page
- totalOrders? int - The total number of orders associated with this landing page
- currencyCode? string - The user's currency code
mailchimp.marketing: LandingPageReportTimeseries
Fields
- dailyStats? DailyClicksAndVisitsData -
- weeklyStats? WeeklyClicksAndVisitsData -
mailchimp.marketing: LastMessage
The most recent message in the conversation
Fields
- fromEmail? string - A label representing the email of the sender of this message
- read? boolean - Whether this message has been marked as read
- subject? string - The subject of this message
- message? string - The plain-text content of the message
- fromLabel? string - A label representing the sender of this message
- timestamp? string - The date and time the message was either sent or received in ISO 8601 format
mailchimp.marketing: List
List settings for the Automation
Fields
- storeId? string - The id of the store
- listId? string - The id of the List
mailchimp.marketing: List1
List settings for the campaign
Fields
- segmentOpts? SegmentOptions -
- listId string - The unique list id
mailchimp.marketing: List10
List settings for the Automation
Fields
- segmentOpts? SegmentOptions2 -
- storeId? string - The id of the store
- listId? string - The unique list id
- listName? string - List Name
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
mailchimp.marketing: List2
List settings for the campaign
Fields
- segmentOpts? SegmentOptions1 -
- listId string - The unique list id
mailchimp.marketing: List3
Information about a specific list segment
Fields
- name string - The name of the segment
- options? Conditions - The conditions of the segment. Static and fuzzy segments don't have conditions
- staticSegment? string[] - An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field
mailchimp.marketing: List4
Information about a specific segment
Fields
- updatedAt? string - The date and time the segment was last updated in ISO 8601 format
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the segment
- options? Conditions2 - The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions
- createdAt? string - The date and time the segment was created in ISO 8601 format
- id? int - The unique id for the segment
- memberCount? int - The number of active subscribers currently included in the segment
- 'type? "saved"|"static"|"fuzzy" - The type of segment. Static segments are now known as tags. Learn more about tags
mailchimp.marketing: List5
Information about a specific list segment
Fields
- name string - The name of the segment
- options? Conditions1 - The conditions of the segment. Static and fuzzy segments don't have conditions
- staticSegment? string[] - An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the
optionsfield
mailchimp.marketing: List6
List settings for the campaign
Fields
- segmentOpts? SegmentOptions1 -
- listId? string - The unique list id
- recipientCount? int - Count of the recipients on the associated list. Formatted as an integer
- listName? string - The name of the list
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
mailchimp.marketing: List7
List settings for the campaign
Fields
- segmentOpts? SegmentOptions1 -
- listId string - The unique list id
- recipientCount? int - Count of the recipients on the associated list. Formatted as an integer
- listName? string - The name of the list
mailchimp.marketing: List8
List settings for the campaign
Fields
- segmentOpts? SegmentOptions1 -
- listId? string - The unique list id
- recipientCount? int - Count of the recipients on the associated list. Formatted as an integer
- listName? string - The name of the list
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
mailchimp.marketing: List9
Information about a specific segment
Fields
- updatedAt? string - The date and time the segment was last updated in ISO 8601 format
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the segment
- options? Conditions2 - The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions
- createdAt? string - The date and time the segment was created in ISO 8601 format
- id? int - The unique id for the segment
- memberCount? int - The number of active subscribers currently included in the segment
- 'type? "saved"|"static"|"fuzzy" - The type of segment. Static segments are now known as tags. Learn more about tags
mailchimp.marketing: ListActivity
Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity
Fields
- activity? DailyListActivity[] - Recent list activity
- listId? string - The unique id for the list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ListContact
Contact information displayed in campaign footers to comply with international spam laws
Fields
- zip? string - The postal or zip code for the list contact
- country string - A two-character ISO3166 country code. Defaults to US if invalid
- address2? string - The street address for the list contact
- city string - The city for the list contact
- phone? string - The phone number for the list contact
- address1 string - The street address for the list contact
- company string - The company name for the list
- state? string - The state for the list contact
mailchimp.marketing: ListContact1
Contact information displayed in campaign footers to comply with international spam laws
Fields
- zip string - The postal or zip code for the list contact
- country string - A two-character ISO3166 country code. Defaults to US if invalid
- address2? string - The street address for the list contact
- city string - The city for the list contact
- phone? string - The phone number for the list contact
- address1 string - The street address for the list contact
- company string - The company name for the list
- state string - The state for the list contact
mailchimp.marketing: ListContact2
Contact information displayed in campaign footers to comply with international spam laws
Fields
- zip? string - The postal or zip code for the list contact
- country? string - A two-character ISO3166 country code. Defaults to US if invalid
- address2? string - The street address for the list contact
- city? string - The city for the list contact
- phone? string - The phone number for the list contact
- address1? string - The street address for the list contact
- company? string - The company name for the list
- state? string - The state for the list contact
mailchimp.marketing: ListLocation
Fields
- cc? string - The ISO 3166 2 digit country code
- country? string - The name of the country
- total? int - The total number of subscribers in the country
- percent? decimal - The percent of subscribers in the country
mailchimp.marketing: ListLocations
A summary of List's locations
Fields
- listId? string - The unique id for the list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- locations? ListLocation[] - An array of objects, each representing a list's top subscriber locations
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ListMembers
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- emailType? string - Type of email this member asked to get ('html' or 'text')
- listId? string - The list id
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- lastNote? Notes -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- ipSignup? string - IP address the subscriber signed up from
- memberRating? int - Star rating for this member, between 1 and 5
- language? string - If set/detected, the subscriber's language
- uniqueEmailId? string - An identifier for the address across all of Mailchimp
- emailAddress? string - Email address for a subscriber
- fullName? string - The contact's full name
- emailClient? string - The list member's email client
- stats? SubscriberStats - Open and click rates for this subscriber
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- location? Location1 - Subscriber location information
- id? string - The MD5 hash of the lowercase version of the list member's email address
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- vip? boolean - VIP status for subscriber
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional" - Subscriber's current status
- lastChanged? string - The date and time the member's info was last changed in ISO 8601 format
mailchimp.marketing: ListMembers1
Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members
Fields
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- members? ListMembers4[] - An array of objects, each representing a specific list member
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ListMembers2
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- marketingPermissions? MarketingPermission1[] - The marketing permissions for the subscriber
- listId? string - The list id
- lastNote? Notes -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- ipSignup? string - IP address the subscriber signed up from
- memberRating? int - Star rating for this member, between 1 and 5
- language? string - If set/detected, the subscriber's language
- 'source? string - The source from which the subscriber was added to this list
- contactId? string - As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the
idis the MD5 hash of their email address, thiscontact_idis agnostic of contact’s inclusion of an email address
- unsubscribeReason? string - A subscriber's reason for unsubscribing
- emailClient? string - The list member's email client
- smsPhoneNumber? string - A US phone number for SMS contact
- stats? SubscriberStats1 - Open and click rates for this subscriber
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- id? string - The MD5 hash of the lowercase version of the list member's email address
- vip? boolean - VIP status for subscriber
- emailType? string - Type of email this member asked to get ('html' or 'text')
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. View this member in your Mailchimp account at
https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}
- smsSubscriptionLastUpdated? string - The datetime when the SMS subscription was last updated
- smsSubscriptionStatus? "subscribed"|"unsubscribed"|"nonsubscribed"|"pending" - The status of an SMS subscription
- uniqueEmailId? string - An identifier for the address across all of Mailchimp
- emailAddress? string - Email address for a subscriber
- fullName? string - The contact's full name
- location? Location3 - Subscriber location information
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional"|"archived" - Subscriber's current status
- consentsToOneToOneMessaging? boolean - Indicates whether a contact consents to 1:1 messaging
- lastChanged? string - The date and time the member's info was last changed in ISO 8601 format
mailchimp.marketing: ListMembers3
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- emailType? string - Type of email this member asked to get ('html' or 'text')
- listId? string - The list id
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- lastNote? Notes -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- ipSignup? string - IP address the subscriber signed up from
- memberRating? int - Star rating for this member, between 1 and 5
- language? string - If set/detected, the subscriber's language
- uniqueEmailId? string - An identifier for the address across all of Mailchimp
- emailAddress? string - Email address for a subscriber
- fullName? string - The contact's full name
- emailClient? string - The list member's email client
- stats? SubscriberStats - Open and click rates for this subscriber
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- location? Location1 - Subscriber location information
- id? string - The MD5 hash of the lowercase version of the list member's email address
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- vip? boolean - VIP status for subscriber
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional" - Subscriber's current status
- lastChanged? string - The date and time the member's info was last changed in ISO 8601 format
mailchimp.marketing: ListMembers4
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- marketingPermissions? MarketingPermission1[] - The marketing permissions for the subscriber
- listId? string - The list id
- lastNote? Notes -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- ipSignup? string - IP address the subscriber signed up from
- memberRating? int - Star rating for this member, between 1 and 5
- language? string - If set/detected, the subscriber's language
- 'source? string - The source from which the subscriber was added to this list
- contactId? string - As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the
idis the MD5 hash of their email address, thiscontact_idis agnostic of contact’s inclusion of an email address
- unsubscribeReason? string - A subscriber's reason for unsubscribing
- emailClient? string - The list member's email client
- smsPhoneNumber? string - A US phone number for SMS contact
- stats? SubscriberStats1 - Open and click rates for this subscriber
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- id? string - The MD5 hash of the lowercase version of the list member's email address
- vip? boolean - VIP status for subscriber
- emailType? string - Type of email this member asked to get ('html' or 'text')
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- webId? int - The ID used in the Mailchimp web application. View this member in your Mailchimp account at
https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}
- smsSubscriptionLastUpdated? string - The datetime when the SMS subscription was last updated
- smsSubscriptionStatus? "subscribed"|"unsubscribed"|"nonsubscribed"|"pending" - The status of an SMS subscription
- uniqueEmailId? string - An identifier for the address across all of Mailchimp
- emailAddress? string - Email address for a subscriber
- fullName? string - The contact's full name
- location? Location3 - Subscriber location information
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional"|"archived" - Subscriber's current status
- consentsToOneToOneMessaging? boolean - Indicates whether a contact consents to 1:1 messaging
- lastChanged? string - The date and time the member's info was last changed in ISO 8601 format
mailchimp.marketing: ListMembers5
Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed
Fields
- emailType? string - Type of email this member asked to get ('html' or 'text')
- listId? string - The list id
- timestampOpt? string - The date and time the subscriber confirmed their opt-in status in ISO 8601 format
- lastNote? Notes -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - An individual merge var and value for a member
- timestampSignup? string - The date and time the subscriber signed up for the list in ISO 8601 format
- ipSignup? string - IP address the subscriber signed up from
- memberRating? int - Star rating for this member, between 1 and 5
- language? string - If set/detected, the subscriber's language
- contactId? string - A unique ID for the contact record
- uniqueEmailId? string - An identifier for the address across all of Mailchimp
- emailAddress? string - Email address for a subscriber
- emailClient? string - The list member's email client
- stats? SubscriberStats - Open and click rates for this subscriber
- ipOpt? string - The IP address the subscriber used to confirm their opt-in status
- location? Location1 - Subscriber location information
- id? string - The MD5 hash of the lowercase version of the list member's email address
- interests? record { boolean... } - The key of this object's properties is the ID of the interest in question
- vip? boolean - VIP status for subscriber
- status? "subscribed"|"unsubscribed"|"cleaned"|"pending"|"transactional" - Subscriber's current status
- lastChanged? string - The date and time the member's info was last changed in ISO 8601 format
mailchimp.marketing: ListSignupForms
List Signup Forms
Fields
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- signupForms? SignupForm2[] - List signup form
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ListStats
The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list
Fields
- subRate? decimal - The average number of subscriptions per month for the list
- proxyExcludedOpenRate? decimal - The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list, excluding opens from email clients that use proxies
- clickRate? decimal - The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list
- unsubRate? decimal - The average number of unsubscriptions per month for the list
- openRate? decimal - The average unique open rate (a percentage represented as a number between 0 and 100) per campaign for the list
mailchimp.marketing: ListWebhooks
Manage webhooks for a specific list
Fields
- listId? string - The list id
- webhooks? ListWebhooks2[] - An array of objects, each representing a specific list member
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ListWebhooks1
Webhook configured for the given list
Fields
- sources? Sources1 - The possible sources of any events that can trigger the webhook and whether they are enabled
- listId? string - The unique id for the list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - An string that uniquely identifies this webhook
- url? string - A valid URL for the Webhook
- events? Events2 - The events that can trigger the webhook and whether they are enabled
mailchimp.marketing: ListWebhooks2
Webhook configured for the given list
Fields
- sources? Sources1 - The possible sources of any events that can trigger the webhook and whether they are enabled
- listId? string - The unique id for the list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - An string that uniquely identifies this webhook
- url? string - A valid URL for the Webhook
- events? Events2 - The events that can trigger the webhook and whether they are enabled
mailchimp.marketing: Location
Subscriber location information
Fields
- latitude? decimal - The location latitude
- longitude? decimal - The location longitude
mailchimp.marketing: Location1
Subscriber location information
Fields
- countryCode? string - The unique code for the location country
- dstoff? int - The offset for timezones where daylight saving time is observed
- timezone? string - The timezone for the location
- latitude? decimal - The location latitude
- gmtoff? int - The time difference in hours from GMT
- longitude? decimal - The location longitude
mailchimp.marketing: Location2
An individual click location
Fields
- country? string - The two-digit country code for a recorded click
- region? string - If available, a specific region where the click was recorded
mailchimp.marketing: Location3
Subscriber location information
Fields
- countryCode? string - The unique code for the location country
- dstoff? int - The offset for timezones where daylight saving time is observed
- timezone? string - The timezone for the location
- latitude? decimal - The location latitude
- gmtoff? int - The time difference in hours from GMT
- region? string - The region for the location
- longitude? decimal - The location longitude
mailchimp.marketing: MarketingPermission
A single marketing permission a subscriber has either opted-in to or opted-out of
Fields
- marketingPermissionId? string - The id for the marketing permission on the list
- enabled? boolean - If the subscriber has opted-in to the marketing permission
mailchimp.marketing: MarketingPermission1
A single marketing permission a subscriber has either opted-in to or opted-out of
Fields
- marketingPermissionId? string - The id for the marketing permission on the list
- text? string - The text of the marketing permission
- enabled? boolean - If the subscriber has opted-in to the marketing permission
mailchimp.marketing: MemberActivity
A summary of the interaction with the campaign
Fields
- ip? string - The IP address recorded for the action
- action? string - One of the following actions: 'open', 'click', or 'bounce'
- 'type? string - If the action is a 'bounce', the type of bounce received: 'hard', 'soft'
- url? string - If the action is a 'click', the URL on which the member clicked
- timestamp? string - The date and time recorded for the action in ISO 8601 format
mailchimp.marketing: MemberActivity1
Member activity events
Fields
- parentCampaign? string - The ID of the parent campaign
- action? string - The type of action recorded for the subscriber
- 'type? string - The type of campaign that was sent
- title? string - If set, the campaign's title
- url? string - For clicks, the URL the subscriber clicked on
- campaignId? string - The web-based ID for the campaign
- timestamp? string - The date and time recorded for the action
mailchimp.marketing: MemberActivity2
A summary of the interaction with the campaign
Fields
- isProxyOpen? boolean - Indicates if the open was from an email client that use proxies
- timestamp? string - The date and time recorded for the action in ISO 8601 format
mailchimp.marketing: MemberActivityEvents
The last 50 member events for a list
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- activity? MemberActivity1[] - An array of objects, each representing a member event
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- contactId? string - As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the
email_idis the MD5 hash of their email address, thiscontact_idis agnostic of contact’s inclusion of an email address
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: MemberActivityEvents1
The member activity events for a given member
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- activity? record {}[] - An array of objects, each representing a contact event. There are multiple possible types, see the activity schema documentation
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
mailchimp.marketing: MemberNotes
A specific note for a specific member
Fields
- note? string - The content of the note. Note length is limited to 1,000 characters
mailchimp.marketing: MemberNotes1
A specific note for a specific member
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- note? string - The content of the note
- updatedAt? string - The date and time the note was last updated in ISO 8601 format
- listId? string - The unique id for the list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- createdAt? string - The date and time the note was created in ISO 8601 format
- id? int - The note id
- contactId? string - As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the
email_idis the MD5 hash of their email address, thiscontact_idis agnostic of contact’s inclusion of an email address
- createdBy? string - The author of the note
mailchimp.marketing: MemberNotes2
A specific note for a specific member
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- note? string - The content of the note
- updatedAt? string - The date and time the note was last updated in ISO 8601 format
- listId? string - The unique id for the list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- createdAt? string - The date and time the note was created in ISO 8601 format
- id? int - The note id
- contactId? string - As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the
email_idis the MD5 hash of their email address, thiscontact_idis agnostic of contact’s inclusion of an email address
- createdBy? string - The author of the note
mailchimp.marketing: Members
Members found for given search term
Fields
- fullSearch? PartialMatches -
- exactMatches? ExactMatches -
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
mailchimp.marketing: MembersToAddremoveTofromAStaticSegment
Members to add/remove to/from a static segment
Fields
- membersToAdd? string[] - An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent
- membersToRemove? string[] - An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent
mailchimp.marketing: MembersToSubscribeUnsubscribeTofromAListInBatch
Members to subscribe to or unsubscribe from a list
Fields
- members AddListMembers[] - An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call
- syncTags? boolean - Whether this batch operation will replace all existing tags with tags in request
- updateExisting? boolean - Whether this batch operation will change existing members' subscription status
mailchimp.marketing: MemberTag
Add or remove tags on a member by declaring a tag either active or inactive on a member
Fields
- name string - The name of the tag
- status "inactive"|"active" - The status for the tag on the member, pass in active to add a tag or inactive to remove it
mailchimp.marketing: MemberTags
A list of tags assigned to a list member
Fields
- isSyncing? boolean - When is_syncing is true, automations based on the tags in the request will not fire
mailchimp.marketing: MergeField
A merge field for an audience
Fields
- 'public? boolean - Whether the merge field is displayed on the signup form
- name string - The name of the merge field (audience field)
- displayOrder? int - The order that the merge field displays on the list signup form
- options? MergeFieldOptions - Extra options for some merge field types
- defaultValue? string - The default value for the merge field if
null
- tag? string - The merge tag used for Mailchimp campaigns and adding contact information
- 'type "text"|"number"|"address"|"phone"|"date"|"url"|"imageurl"|"radio"|"dropdown"|"birthday"|"zip" - The type for the merge field
- required? boolean - Whether the merge field is required to import a contact
- helpText? string - Extra text to help the subscriber fill out the form
mailchimp.marketing: MergeField1
A merge field for an audience
Fields
- 'public? boolean - Whether the merge field is displayed on the signup form
- listId? string - The ID that identifies this merge field's audience'
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the merge field (audience field)
- displayOrder? int - The order that the merge field displays on the list signup form
- options? MergeFieldOptions2 - Extra options for some merge field types
- mergeId? int - An unchanging id for the merge field
- defaultValue? string - The default value for the merge field if
null
- tag? string - The merge tag used for Mailchimp campaigns and adding contact information
- 'type? "text"|"number"|"address"|"phone"|"date"|"url"|"imageurl"|"radio"|"dropdown"|"birthday"|"zip" - The type for the merge field
- required? boolean - The boolean value if the merge field is required
- helpText? string - Extra text to help the subscriber fill out the form
mailchimp.marketing: MergeField2
A merge field for an audience
Fields
- 'public? boolean - Whether the merge field is displayed on the signup form
- name string - The name of the merge field (audience field)
- displayOrder? int - The order that the merge field displays on the list signup form
- options? MergeFieldOptions1 - Extra options for some merge field types
- defaultValue? string - The default value for the merge field if
null
- tag? string - The merge tag used for Mailchimp campaigns and adding contact information
- required? boolean - Whether the merge field is required to import a contact
- helpText? string - Extra text to help the subscriber fill out the form
mailchimp.marketing: MergeField3
A merge field for an audience
Fields
- 'public? boolean - Whether the merge field is displayed on the signup form
- listId? string - The ID that identifies this merge field's audience'
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the merge field (audience field)
- displayOrder? int - The order that the merge field displays on the list signup form
- options? MergeFieldOptions2 - Extra options for some merge field types
- mergeId? int - An unchanging id for the merge field
- defaultValue? string - The default value for the merge field if
null
- tag? string - The merge tag used for Mailchimp campaigns and adding contact information
- 'type? "text"|"number"|"address"|"phone"|"date"|"url"|"imageurl"|"radio"|"dropdown"|"birthday"|"zip" - The type for the merge field
- required? boolean - The boolean value if the merge field is required
- helpText? string - Extra text to help the subscriber fill out the form
mailchimp.marketing: MergeField4
A merge field for an audience
Fields
- id? int - An unchanging id for the merge field
- 'type? "text"|"number"|"address"|"phone"|"date"|"url"|"imageurl"|"radio"|"dropdown"|"birthday"|"zip" - The type for the merge field
mailchimp.marketing: MergeFieldOptions
Extra options for some merge field types
Fields
- size? int - In a text field, the default length of the text field
- dateFormat? string - In a date or birthday field, the format of the date
- choices? string[] - In a radio or dropdown non-group field, the available options for contacts to pick from
- defaultCountry? int - In an address field, the default country code if none supplied
- phoneFormat? string - In a phone field, the phone number type: US or International
mailchimp.marketing: MergeFieldOptions1
Extra options for some merge field types
Fields
- dateFormat? string - In a date or birthday field, the format of the date
- choices? string[] - In a radio or dropdown non-group field, the available options for members to pick from
- defaultCountry? int - In an address field, the default country code if none supplied
- phoneFormat? string - In a phone field, the phone number type: US or International
mailchimp.marketing: MergeFieldOptions2
Extra options for some merge field types
Fields
- size? int - In a text field, the default length of the text field
- dateFormat? string - In a date or birthday field, the format of the date
- choices? string[] - In a radio or dropdown non-group field, the available options for contacts to pick from
- defaultCountry? int - In an address field, the default country code if none supplied
- phoneFormat? string - In a phone field, the phone number type: US or International
mailchimp.marketing: Notes
The most recent Note added about this member
Fields
- noteId? int - The note id
- note? string - The content of the note
- createdAt? string - The date and time the note was created in ISO 8601 format
- createdBy? string - The author of the note
mailchimp.marketing: OpenActivity
A list of a member's opens activity in a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- emailAddress? string - Email address for a subscriber
- listId? string - The unique id for the list
- opensCount? int - The total number of times the this campaign was opened by the list member
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- opens? MemberActivity2[] - An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event
- contactStatus? string - The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation
- proxyExcludedOpensCount? int - The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- vip? boolean - VIP status for subscriber
- campaignId? string - The unique id for the campaign
mailchimp.marketing: OpenActivity1
A list of a member's opens activity in a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- emailAddress? string - Email address for a subscriber
- listId? string - The unique id for the list
- opensCount? int - The total number of times the this campaign was opened by the list member
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- opens? MemberActivity2[] - An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event
- contactStatus? string - The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation
- proxyExcludedOpensCount? int - The total number of times the this campaign was opened by the list member excluding opens from email clients that use proxies
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- vip? boolean - VIP status for subscriber
- campaignId? string - The unique id for the campaign
mailchimp.marketing: OpenDetailReport
A detailed report of any campaign emails that were opened by a list member
Fields
- totalOpens? int - The total number of opens matching the query regardless of pagination
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- members? OpenActivity1[] - An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The campaign id
- totalProxyExcludedOpens? int - The total number of opens excluding opens from email clients that use proxies regardless of pagination
mailchimp.marketing: OpenLocations
Top open locations for a specific campaign
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- locations? OpenLocationsLocations[] - An array of objects, each representing a top location for opens
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The campaign id
mailchimp.marketing: OpenLocationsLocations
Fields
- proxyExcludedOpens? int - The number of unique campaign opens for a region excluding opens from email clients that use proxies
- countryCode? string - The ISO 3166 2 digit country code
- opens? int - The number of unique campaign opens for a region
- regionName? string - The name of the region, if we have one. For blank "region" values, this will be "Rest of Country"
- region? string - An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region
mailchimp.marketing: Opens
An object describing the open activity for the campaign
Fields
- proxyExcludedOpens? int - The total number of opens for a campaign, excluding opens from email clients that use proxies
- opensTotal? int - The total number of opens for a campaign
- proxyExcludedOpenRate? decimal - The average unique open rate for a campaign, excluding opens from email clients that use proxies
- proxyExcludedUniqueOpens? int - The total number of unique opens for a campaign, excluding opens from email clients that use proxies
- lastOpen? string - The date and time of the last recorded open in ISO 8601 format
- uniqueOpens? int - The total number of unique opens for a campaign
- openRate? decimal - The number of unique opens for a campaign divided by the total number of successful deliveries
mailchimp.marketing: Operations
Fields
- path string - The relative path to use for the operation
- method "GET"|"POST"|"PUT"|"PATCH"|"DELETE" - The HTTP method to use for the operation
- operationId? string - An optional client-supplied id returned with the operation results
- params? record {} - Any request query parameters. Example parameters: {"count":10, "offset":0}
- body? string - A string containing the JSON body to use with the request
mailchimp.marketing: OrderLines
A collection of an order's line items
Fields
- storeId? string - The store id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- lines? ECommerceOrderLineItem4[] - An array of objects, each representing an order's line item
- orderId? string - The order id
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: Orders
A collection of orders in an account
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- orders? ECommerceOrder4[] - An array of objects, each representing an order resource
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: Orders1
A collection of orders in a store
Fields
- storeId? string - The unique identifier for the store
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- orders? ECommerceOrder4[] - An array of objects, each representing an order in a store
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: Orders1Promos
Fields
- code? string - The Promo Code
- amountDiscounted? decimal - The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0
- 'type? "fixed"|"percentage" - Type of discount. For free shipping set type to fixed
mailchimp.marketing: OriginalCampaign
The original campaign that was resent
Fields
- id? string - ID for the resent campaign
- webId? int - The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at
https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- shortcutType? "non_openers"|"new_subscribers"|"non_clickers"|"non_purchasers" - Which campaign resend shortcut was used
- title? string - The title of the original campaign
mailchimp.marketing: Outreach
The outreach associated with this order. For example, an email campaign or Facebook ad
Fields
- id? string - A unique identifier for the outreach. Can be an email campaign ID
mailchimp.marketing: Outreach1
The outreach associated with this order. For example, an email campaign or Facebook ad
Fields
- publishedTime? string - The date and time the Outreach was published in ISO 8601 format
- name? string - The name for the outreach
- id? string - A unique identifier for the outreach. Can be an email campaign ID
- 'type? string - The type of the outreach
mailchimp.marketing: PartialMatches
Partial matches of the provided search query
Fields
- members? ListMembers4[] - An array of objects, each representing a specific list member
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: PatchListsIdMembersIdQueries
Represents the Queries record for the operation: patchListsIdMembersId
Fields
- skipMergeValidation? boolean - 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
mailchimp.marketing: PostAllLandingPagesQueries
Represents the Queries record for the operation: postAllLandingPages
Fields
- useDefaultList? boolean - Will create the Landing Page using the account's Default List instead of requiring a list_id
mailchimp.marketing: PostListsIdMembersQueries
Represents the Queries record for the operation: postListsIdMembers
Fields
- skipMergeValidation? boolean - 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
mailchimp.marketing: PostListsIdQueries
Represents the Queries record for the operation: postListsId
Fields
- skipMergeValidation? boolean - 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
- skipDuplicateCheck? boolean - If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false
mailchimp.marketing: PreviewASegmentQueries
Represents the Queries record for the operation: previewASegment
Fields
- beforeCreatedAt? string - Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- offset int(default 0) - Used for pagination, this it the number of records from a collection to skip. Default value is 0
- includeUnsubscribed? boolean - Include unsubscribed members in response
- count int(default 10) - The number of records to return. Default value is 10. Maximum value is 1000
- sinceUpdatedAt? string - Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- sinceCreatedAt? string - Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- includeTransactional? boolean - Include transactional members in response
- fields? string[] - A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation
- excludeFields? string[] - A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation
- 'type? string - Limit results based on segment type
- beforeUpdatedAt? string - Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00
- includeCleaned? boolean - Include cleaned members in response
mailchimp.marketing: Products
A collection of a store's products
Fields
- storeId? string - The store id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- products? ECommerceProduct4[] - An array of objects, each representing a store product
mailchimp.marketing: PromoCodes
A collection of the store's promo codes
Fields
- storeId? string - The store id
- promoCodes? ECommercePromoCode3[] - An array of objects, each representing promo codes defined for a store
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: PromoRules
A collection of the store's promo rules
Fields
- storeId? string - The store id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- promoRules? ECommercePromoRule3[] - An array of objects, each representing promo rules defined for a store
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: PutListsIdMembersIdQueries
Represents the Queries record for the operation: putListsIdMembersId
Fields
- skipMergeValidation? boolean - 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
mailchimp.marketing: Recipients
High level audience information for who the outreach targets
Fields
- segmentOpts? SegmentOptions1 -
- listId? string - The unique list id
- recipientCount? int - Count of the recipients on the associated list. Formatted as an integer
- listName? string - The name of the list
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
mailchimp.marketing: Referrer
A single instance of a campaign referral
Fields
- referrer? string - A referrer (truncated to 100 bytes)
- clicks? int - The number of clicks a single referrer generated
- lastClick? string - The timestamp for the last click from this referrer
- firstClick? string - The timestamp for the first click from this referrer
mailchimp.marketing: RemovedSubscribers
A summary of the subscribers who were removed from an Automation workflow
Fields
- workflowId? string - A string that uniquely identifies an Automation workflow
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- subscribers? SubscriberRemovedFromAutomationWorkflow1[] - An array of objects, each representing a subscriber who was removed from an Automation workflow
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ReportSummary
High level reporting stats for an outreach
Fields
- proxyExcludedOpens? int -
- uniqueVisits? int -
- subscribes? int -
- proxyExcludedOpenRate? decimal -
- reach? int -
- clickRate? decimal -
- totalSent? int -
- impressions? decimal -
- uniqueOpens? int -
- subscriberClicks? int -
- visits? int -
- ecommerce? ReportSummaryEcommerce -
- opens? int -
- proxyExcludedUniqueOpens? int -
- clicks? int -
- engagements? int -
- conversionRate? decimal -
- openRate? decimal -
mailchimp.marketing: ReportSummaryEcommerce
Fields
- averageOrderRevenue? decimal -
- totalRevenue? decimal -
- currencyCode? string -
mailchimp.marketing: ResendShortcutEligibility
Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter include_resend_shortcuts is true
Fields
- toNonOpeners? ToNonOpeners -
- toNewSubscribers? ToNewSubscribers -
- toNonPurchasers? ToNonPurchasers -
- toNonClickers? ToNonClickers -
mailchimp.marketing: ResendShortcutUsage
Information about campaigns related through shortcuts
Fields
- originalCampaign? OriginalCampaign -
- shortcutCampaigns? ResendShortcutUsageShortcutCampaigns[] - Campaigns that were created from Campaign Resend Shortcuts for this campaign
mailchimp.marketing: ResendShortcutUsageShortcutCampaigns
Fields
- sendTime? string - The date and time a resent campaign was sent
- id? string - Unique ID for the resent campaign
- webId? int - The ID for the resent campaign used in the Mailchimp web application. View this campaign in your Mailchimp account at
https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}
- shortcutType? "non_openers"|"new_subscribers"|"non_clickers"|"non_purchasers" - Which campaign resend shortcut was used
- status? "save"|"paused"|"schedule"|"sending"|"sent"|"canceled"|"canceling"|"archived" - The current status of the campaign
mailchimp.marketing: ResourceLink
This object represents a link from the resource where it is found to another resource or action that may be performed
Fields
- schema? string - For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to
- targetSchema? string - For GETs, this is a URL representing the schema that the response should conform to
- method? "GET"|"POST"|"PUT"|"PATCH"|"DELETE"|"OPTIONS"|"HEAD" - The HTTP method that should be used when accessing the URL defined in 'href'
- rel? string - As with an HTML 'rel' attribute, this describes the type of link
- href? string - This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action
mailchimp.marketing: Response
A single question and the response to that question
Fields
- answer? string - The answer to this survey question
- questionType? "pickOne"|"pickMany"|"range"|"text"|"email" - The type of question this is
- query? string - The survey question
- questionId? string - The unique ID for this question
mailchimp.marketing: RSSOptions
RSS options, specific to an RSS campaign
Fields
- schedule? SendingSchedule - The schedule for sending the RSS Campaign
- constrainRssImg? boolean - Whether to add CSS to images in the RSS feed to constrain their width in campaigns
- feedUrl string - The URL for the RSS feed
- frequency "daily"|"weekly"|"monthly" - The frequency of the RSS Campaign
mailchimp.marketing: RSSOptions1
RSS options for a campaign
Fields
- schedule? SendingSchedule - The schedule for sending the RSS Campaign
- constrainRssImg? boolean - Whether to add CSS to images in the RSS feed to constrain their width in campaigns
- feedUrl string - The URL for the RSS feed
- frequency "daily"|"weekly"|"monthly" - The frequency of the RSS Campaign
mailchimp.marketing: RSSOptions2
RSS options for a campaign
Fields
- schedule? SendingSchedule1 - The schedule for sending the RSS Campaign
- lastSent? string - The date the campaign was last sent
- constrainRssImg? boolean - Whether to add CSS to images in the RSS feed to constrain their width in campaigns
- feedUrl string - The URL for the RSS feed
- frequency "daily"|"weekly"|"monthly" - The frequency of the RSS Campaign
mailchimp.marketing: RSSOptions3
RSS options for a campaign
Fields
- schedule? SendingSchedule - The schedule for sending the RSS Campaign
- lastSent? string - The date the campaign was last sent
- constrainRssImg? boolean - Whether to add CSS to images in the RSS feed to constrain their width in campaigns
- feedUrl? string - The URL for the RSS feed
- frequency? "daily"|"weekly"|"monthly" - The frequency of the RSS Campaign
mailchimp.marketing: SalesforceCRMTracking
Deprecated
Fields
- notes? boolean - Update contact notes for a campaign based on subscriber email addresses
- campaign? boolean - Create a campaign in a connected Salesforce account
mailchimp.marketing: SalesforceCRMTracking1
Deprecated
Fields
- notes? boolean - Update contact notes for a campaign based on a subscriber's email address
- campaign? boolean - Create a campaign in a connected Salesforce account
mailchimp.marketing: Script
The script used to connect your site with Mailchimp
Fields
- fragment? string - A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp
- url? string - The URL used for any integrations that offer built-in support for connected sites
mailchimp.marketing: Script1
The script used to connect your site with Mailchimp
Fields
- fragment? string - A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp
- url? string - The URL used for any integrations that offer built-in support for connected sites
mailchimp.marketing: SearchTagsByNameQueries
Represents the Queries record for the operation: searchTagsByName
Fields
- name? string - The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned
mailchimp.marketing: SegmentIdMembersBody
Fields
- emailAddress string - Email address for a subscriber
mailchimp.marketing: SegmentMembers
View members in a specific list segment
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- members? ListMembers3[] - An array of objects, each representing a specific list member
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: SegmentOptions
An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options
Fields
- 'match? "any"|"all" - Segment match type
- savedSegmentId? int - The id for an existing saved segment
- conditions? record {}[] - Segment match conditions. There are multiple possible types, see the condition types documentation
mailchimp.marketing: SegmentOptions1
An object representing all segmentation options. This object should contain a saved_segment_id to use an existing segment, or you can create a new segment by including both match and conditions options
Fields
- prebuiltSegmentId? string - The prebuilt segment id, if a prebuilt segment has been designated for this campaign
- 'match? "any"|"all" - Segment match type
- savedSegmentId? int - The id for an existing saved segment
- conditions? record {}[] - Segment match conditions. There are multiple possible types, see the condition types documentation
mailchimp.marketing: SegmentOptions2
An object representing all segmentation options
Fields
- 'match? "any"|"all" - Segment match type
- savedSegmentId? int - The id for an existing saved segment
- conditions? record {}[] - Segment match conditions. There are multiple possible types, see the condition types documentation
mailchimp.marketing: SendChecklist
The send checklist for the campaign
Fields
- isReady? boolean - Whether the campaign is ready to send
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- items? SendChecklistItems[] - A list of feedback items to review before sending your campaign
mailchimp.marketing: SendChecklistItems
Fields
- heading? string - The heading for the specific item
- details? string - Details about the specific feedback item
- id? int - The ID for the specific item
- 'type? "success"|"warning"|"error" - The item type
mailchimp.marketing: SendingSchedule
The schedule for sending the RSS Campaign
Fields
- hour? int - The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in your account's default time zone
- weeklySendDay? "sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday" - The day of the week to send a weekly RSS Campaign
- dailySend? DailySendingDays -
- monthlySendDate? decimal - The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February
mailchimp.marketing: SendingSchedule1
The schedule for sending the RSS Campaign
Fields
- hour? int - The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in your account's default time zone
- weeklySendDay? "sunday"|"monday"|"tuesday"|"wednesday"|"thursday"|"friday"|"saturday" - The day of the week to send a weekly RSS Campaign
- dailySend? DailySendingDays -
- monthlySendDate? decimal - The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February
mailchimp.marketing: SentTo
A list of subscribers who were sent a specific campaign
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- sentTo? SentTo2[] - An array of objects, each representing a campaign recipient
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The campaign id
mailchimp.marketing: SentTo1
A subscriber's status for a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- listId? string - The unique list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- openCount? int - The number of times a campaign was opened by this member
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- lastOpen? string - The date and time of the last open for this member in ISO 8601 format
- emailAddress? string - Email address for a subscriber
- absplitGroup? "a"|"b"|"winner" - For A/B Split Campaigns, the group the member was apart of
- gmtOffset? int - For campaigns sent with timewarp, the time zone group the member is apart of
- vip? boolean - VIP status for subscriber
- campaignId? string - The campaign id
- status? "sent"|"hard"|"soft" - The status of the email delivered to this subscriber.
hardandsoftrefer to different bounce types
mailchimp.marketing: SentTo2
A subscriber's status for a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- listId? string - The unique list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- openCount? int - The number of times a campaign was opened by this member
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- lastOpen? string - The date and time of the last open for this member in ISO 8601 format
- emailAddress? string - Email address for a subscriber
- absplitGroup? "a"|"b"|"winner" - For A/B Split Campaigns, the group the member was apart of
- gmtOffset? int - For campaigns sent with timewarp, the time zone group the member is apart of
- vip? boolean - VIP status for subscriber
- campaignId? string - The campaign id
- status? "sent"|"hard"|"soft" - The status of the email delivered to this subscriber.
hardandsoftrefer to different bounce types
mailchimp.marketing: ShareReport
The url and password for the VIP report
Fields
mailchimp.marketing: ShippingAddress
The shipping address for the order
Fields
- country? string - The country in the shipping address
- address2? string - An additional field for the shipping address
- city? string - The city in the order's shipping address
- address1? string - The shipping address for the order
- latitude? decimal - The latitude for the shipping address location
- provinceCode? string - The two-letter code for the province or state in the shipping address
- countryCode? string - The two-letter code for the country in the shipping address
- province? string - The state or normalized province in the order's shipping address
- phone? string - The phone number for the order's shipping address
- name? string - The name associated with an order's shipping address
- company? string - The company associated with the shipping address
- postalCode? string - The postal or zip code in the shipping address
- longitude? decimal - The longitude for the shipping address location
mailchimp.marketing: ShippingAddress1
The shipping address for the order
Fields
- country? string - The country in the shipping address
- address2? string - An additional field for the shipping address
- city? string - The city in the order's shipping address
- address1? string - The shipping address for the order
- latitude? decimal - The latitude for the shipping address location
- provinceCode? string - The two-letter code for the province or state in the shipping address
- countryCode? string - The two-letter code for the country in the shipping address
- province? string - The state or normalized province in the order's shipping address
- phone? string - The phone number for the order's shipping address
- name? string - The name associated with an order's shipping address
- company? string - The company associated with the shipping address
- postalCode? string - The postal or zip code in the shipping address
- longitude? decimal - The longitude for the shipping address location
mailchimp.marketing: ShippingAddress2
The shipping address for the order
Fields
- country? string - The country in the order's shipping address
- address2? string - An additional field for the shipping address
- city? string - The city in the order's shipping address
- address1? string - The shipping address for the order
- latitude? decimal - The latitude for the shipping address location
- provinceCode? string - The two-letter code for the province or state the order's shipping address is located in
- countryCode? string - The two-letter code for the country in the shipping address
- province? string - The state or normalized province in the order's shipping address
- phone? string - The phone number for the order's shipping address
- name? string - The name associated with an order's shipping address
- company? string - The company associated with an order's shipping address
- postalCode? string - The postal or zip code in the order's shipping address
- longitude? decimal - The longitude for the shipping address location
mailchimp.marketing: SignupForm
List signup form
Fields
- contents? CollectionOfContentForListSignupForms[] - The signup form body content
- header? SignupFormHeaderOptions - Options for customizing your signup form header
- styles? CollectionOfElementStyleForListSignupForms[] - An array of objects, each representing an element style for the signup form
mailchimp.marketing: SignupForm1
List signup form
Fields
- listId? string - The signup form's list id
- contents? CollectionOfContentForListSignupForms[] - The signup form body content
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- header? SignupFormHeaderOptions - Options for customizing your signup form header
- signupFormUrl? string - Signup form URL
- styles? CollectionOfElementStyleForListSignupForms[] - An array of objects, each representing an element style for the signup form
mailchimp.marketing: SignupForm2
List signup form
Fields
- listId? string - The signup form's list id
- contents? CollectionOfContentForListSignupForms[] - The signup form body content
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- header? SignupFormHeaderOptions - Options for customizing your signup form header
- signupFormUrl? string - Signup form URL
- styles? CollectionOfElementStyleForListSignupForms[] - An array of objects, each representing an element style for the signup form
mailchimp.marketing: SignupFormHeaderOptions
Options for customizing your signup form header
Fields
- imageHeight? string - Image height, in pixels
- imageLink? string - The URL that the header image will link to
- imageAlign? "none"|"left"|"center"|"right" - Image alignment
- imageBorderColor? string - Image border color
- imageUrl? string - Header image URL
- imageBorderStyle? "none"|"solid"|"dotted"|"dashed"|"double"|"groove"|"outset"|"inset"|"ridge" - Image border style
- imageAlt? string - Alt text for the image
- text? string - Header text
- imageWidth? string - Image width, in pixels
- imageTarget? "_blank"|"null" - Image link target
- imageBorderWidth? string - Image border width
mailchimp.marketing: Sources
The possible sources of any events that can trigger the webhook and whether they are enabled
Fields
- admin? boolean - Whether the webhook is triggered by admin-initiated actions in the web interface
- api? boolean - Whether the webhook is triggered by actions initiated via the API
- user? boolean - Whether the webhook is triggered by subscriber-initiated actions
mailchimp.marketing: Sources1
The possible sources of any events that can trigger the webhook and whether they are enabled
Fields
- admin? boolean - Whether the webhook is triggered by admin-initiated actions in the web interface
- api? boolean - Whether the webhook is triggered by actions initiated via the API
- user? boolean - Whether the webhook is triggered by subscriber-initiated actions
mailchimp.marketing: Statistics
Stats for the list. Many of these are cached for at least five minutes
Fields
- cleanedCount? int - The number of members cleaned from the list
- unsubscribeCountSinceSend? int - The number of members who have unsubscribed since the last campaign was sent
- memberCountSinceSend? int - The number of active members in the list since the last campaign was sent
- clickRate? decimal - The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)
- cleanedCountSinceSend? int - The number of members cleaned from the list since the last campaign was sent
- totalContacts? int - The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included
- campaignCount? int - The number of campaigns in any status that use this list
- avgUnsubRate? decimal - The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)
- lastSubDate? string - The date and time of the last time someone subscribed to this list in ISO 8601 format
- unsubscribeCount? int - The number of members who have unsubscribed from the list
- targetSubRate? decimal - The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)
- campaignLastSent? string - The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients
- avgSubRate? decimal - The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)
- memberCount? int - The number of active members in the list
- mergeFieldCount? int - The number of merge fields (audience field) for this list (doesn't include EMAIL)
- openRate? decimal - The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)
- lastUnsubDate? string - The date and time of the last time someone unsubscribed from this list in ISO 8601 format
mailchimp.marketing: SubscriberInAutomationQueue
Information about subscribers in an Automation email queue
Fields
- emailAddress string - The list member's email address
mailchimp.marketing: SubscriberInAutomationQueue1
Information about subscribers in an Automation email queue
Fields
- emailId? string - A string that uniquely identifies an email in an Automation workflow
- workflowId? string - A string that uniquely identifies an Automation workflow
- emailAddress? string - The list member's email address
- listId? string - A string that uniquely identifies a list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- nextSend? string - The date and time of the next send for the workflow email in ISO 8601 format
- id? string - The MD5 hash of the lowercase version of the list member's email address
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
mailchimp.marketing: SubscriberInAutomationQueue2
Information about subscribers in an Automation email queue
Fields
- emailId? string - A string that uniquely identifies an email in an Automation workflow
- workflowId? string - A string that uniquely identifies an Automation workflow
- emailAddress string - The list member's email address
- listId? string - A string that uniquely identifies a list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- nextSend? string - The date and time of the next send for the workflow email in ISO 8601 format
- id? string - The MD5 hash of the lowercase version of the list member's email address
mailchimp.marketing: SubscriberInCustomerJourneysAudience
Information about subscribers in a Customer Journey's audience
Fields
- emailAddress string - The list member's email address
mailchimp.marketing: SubscriberList
Information about a specific list
Fields
- notifyOnSubscribe string(default "false") - The email address to send subscribe notifications to
- emailTypeOption boolean - 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 tofalse, subscribers will receive HTML emails, with a plain-text alternative backup
- marketingPermissions boolean(default false) - Whether or not the list has marketing permissions (eg. GDPR) enabled
- permissionReminder string - The permission reminder for the list
- useArchiveBar boolean(default false) - Whether campaigns for this list use the Archive Bar in archives by default
- notifyOnUnsubscribe string(default "false") - The email address to send unsubscribe notifications to
- contact ListContact - Contact information displayed in campaign footers to comply with international spam laws
- name string - The name of the list
- doubleOptin boolean(default false) - Whether or not to require the subscriber to confirm subscription via email
- campaignDefaults CampaignDefaults -
mailchimp.marketing: SubscriberList1
Information about a specific list
Fields
- notifyOnSubscribe string(default "false") - The email address to send subscribe notifications to
- subscribeUrlLong? string - The full version of this list's subscribe form (host will vary)
- marketingPermissions boolean(default false) - Whether or not the list has marketing permissions (eg. GDPR) enabled
- permissionReminder? string - The permission reminder for the list
- useArchiveBar boolean(default false) - Whether campaigns for this list use the Archive Bar in archives by default
- notifyOnUnsubscribe string(default "false") - The email address to send unsubscribe notifications to
- visibility? "pub"|"prv" - Legacy - visibility settings are no longer used
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- dateCreated? string - The date and time that this list was created in ISO 8601 format
- campaignDefaults? CampaignDefaults1 -
- webId? int - The ID used in the Mailchimp web application. View this list in your Mailchimp account at
https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}
- modules? string[] - Any list-specific modules installed for this list
- emailTypeOption? boolean - 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 tofalse, subscribers will receive HTML emails, with a plain-text alternative backup
- beamerAddress? string - The list's Email Beamer address
- hasWelcome boolean(default false) - Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup
- stats? Statistics - Stats for the list. Many of these are cached for at least five minutes
- contact? ListContact2 - Contact information displayed in campaign footers to comply with international spam laws
- name? string - The name of the list
- listRating? int - An auto-generated activity score for the list (0-5)
- doubleOptin boolean(default false) - Whether or not to require the subscriber to confirm subscription via email
- id? string - A string that uniquely identifies this list
- subscribeUrlShort? string - Our url shortened version of this list's subscribe form
mailchimp.marketing: SubscriberList2
Information about a specific list
Fields
- notifyOnSubscribe string(default "false") - The email address to send subscribe notifications to
- emailTypeOption boolean - 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 tofalse, subscribers will receive HTML emails, with a plain-text alternative backup
- marketingPermissions boolean(default false) - Whether or not the list has marketing permissions (eg. GDPR) enabled
- permissionReminder string - The permission reminder for the list
- useArchiveBar boolean(default false) - Whether campaigns for this list use the Archive Bar in archives by default
- notifyOnUnsubscribe string(default "false") - The email address to send unsubscribe notifications to
- contact ListContact1 - Contact information displayed in campaign footers to comply with international spam laws
- name string - The name of the list
- doubleOptin boolean(default false) - Whether or not to require the subscriber to confirm subscription via email
- campaignDefaults CampaignDefaults -
mailchimp.marketing: SubscriberList3
Information about a specific list
Fields
- notifyOnSubscribe string(default "false") - The email address to send subscribe notifications to
- subscribeUrlLong? string - The full version of this list's subscribe form (host will vary)
- marketingPermissions boolean(default false) - Whether or not the list has marketing permissions (eg. GDPR) enabled
- permissionReminder? string - The permission reminder for the list
- useArchiveBar boolean(default false) - Whether campaigns for this list use the Archive Bar in archives by default
- notifyOnUnsubscribe string(default "false") - The email address to send unsubscribe notifications to
- visibility? "pub"|"prv" - Legacy - visibility settings are no longer used
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- dateCreated? string - The date and time that this list was created in ISO 8601 format
- campaignDefaults? CampaignDefaults1 -
- webId? int - The ID used in the Mailchimp web application. View this list in your Mailchimp account at
https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}
- modules? string[] - Any list-specific modules installed for this list
- emailTypeOption? boolean - 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 tofalse, subscribers will receive HTML emails, with a plain-text alternative backup
- beamerAddress? string - The list's Email Beamer address
- hasWelcome boolean(default false) - Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup
- stats? Statistics - Stats for the list. Many of these are cached for at least five minutes
- contact? ListContact2 - Contact information displayed in campaign footers to comply with international spam laws
- name? string - The name of the list
- listRating? int - An auto-generated activity score for the list (0-5)
- doubleOptin boolean(default false) - Whether or not to require the subscriber to confirm subscription via email
- id? string - A string that uniquely identifies this list
- subscribeUrlShort? string - Our url shortened version of this list's subscribe form
mailchimp.marketing: SubscriberLists
A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- lists SubscriberList3[] - An array of objects, each representing a list
- totalItems? int - The total number of items matching the query regardless of pagination
- constraints? CollectionAuthorization - Do particular authorization constraints around this collection limit creation of new instances?
mailchimp.marketing: SubscriberRemovedFromAutomationWorkflow
A summary of a subscriber removed from an Automation workflow
Fields
- workflowId? string - A string that uniquely identifies an Automation workflow
- emailAddress? string - The list member's email address
- listId? string - A string that uniquely identifies a list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - The MD5 hash of the lowercase version of the list member's email address
mailchimp.marketing: SubscriberRemovedFromAutomationWorkflow1
A summary of a subscriber removed from an Automation workflow
Fields
- workflowId? string - A string that uniquely identifies an Automation workflow
- emailAddress? string - The list member's email address
- listId? string - A string that uniquely identifies a list
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- id? string - The MD5 hash of the lowercase version of the list member's email address
mailchimp.marketing: SubscriberStats
Open and click rates for this subscriber
Fields
- avgClickRate? decimal - A subscriber's average clickthrough rate
- avgOpenRate? decimal - A subscriber's average open rate
mailchimp.marketing: SubscriberStats1
Open and click rates for this subscriber
Fields
- ecommerceData? EcommerceStats -
- avgClickRate? decimal - A subscriber's average clickthrough rate
- avgOpenRate? decimal - A subscriber's average open rate
mailchimp.marketing: SurveyQuestionAnswer
The details of a survey question's answer
Fields
- submittedAt? string - The date and time when the survey response was submitted in ISO 8601 format
- responseId? string - The ID of the survey response
- contact? Contact - Information about the contact
- isNewContact? boolean - If this contact was added to the Mailchimp audience via this survey
- id? string - The ID of the answer
- value? string - The raw text answer
mailchimp.marketing: SurveyQuestionReport
The details of a survey question's report
Fields
- rangeLowLabel? string - Label for the low end of the range
- query? string - The query of the survey question
- averageRating? float - The average rating for this range question
- subscribeCheckboxLabel? string - Label used for the subscribe checkbox for this email question
- 'type? "pickOne"|"pickMany"|"range"|"text"|"email" - The response type of the survey question
- rangeHighLabel? string - Label for the high end of the range
- subscribeCheckboxEnabled? boolean - Whether the subscribe checkbox is shown for this email question
- surveyId? string - The unique ID of the survey
- hasOther? boolean - Whether this survey question has an 'other' option
- placeholderLabel? string - Placeholder text for this survey question's answer box
- otherLabel? string - Label used for the 'other' option of this survey question
- contactCounts? ContactCounts -
- isRequired? boolean - Whether this survey question is required to answer
- options? SurveyQuestionReportOptions[] - The answer choices for this question
- totalResponses? int - The total number of responses to this question
- id? string - The ID of the survey question
- mergeField? MergeField4 -
mailchimp.marketing: SurveyQuestionReport1
The details of a survey question's report
Fields
- rangeLowLabel? string - Label for the low end of the range
- query? string - The query of the survey question
- averageRating? float - The average rating for this range question
- subscribeCheckboxLabel? string - Label used for the subscribe checkbox for this email question
- 'type? "pickOne"|"pickMany"|"range"|"text"|"email" - The response type of the survey question
- rangeHighLabel? string - Label for the high end of the range
- subscribeCheckboxEnabled? boolean - Whether the subscribe checkbox is shown for this email question
- surveyId? string - The unique ID of the survey
- hasOther? boolean - Whether this survey question has an 'other' option
- placeholderLabel? string - Placeholder text for this survey question's answer box
- otherLabel? string - Label used for the 'other' option of this survey question
- contactCounts? ContactCounts -
- isRequired? boolean - Whether this survey question is required to answer
- options? SurveyQuestionReportOptions[] - The answer choices for this question
- totalResponses? int - The total number of responses to this question
- id? string - The ID of the survey question
- mergeField? MergeField4 -
mailchimp.marketing: SurveyQuestionReportOptions
Fields
- count? int - The count of responses that selected this survey question option
- label? string - The label for this survey question option
- id? string - The ID for this survey question option
mailchimp.marketing: SurveyReport
The report for a survey
Fields
- listId? string - The ID of the list connected to this survey
- updatedAt? string - The date and time the survey was last updated in ISO 8601 format
- createdAt? string - The date and time the survey was created in ISO 8601 format
- totalResponses? int - The total number of responses to this survey
- id? string - A string that uniquely identifies this survey
- webId? int - The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at
https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}
- listName? string - The name of the list connected to this survey
- title? string - The title of the survey
- publishedAt? string - The date and time the survey was published in ISO 8601 format
- url? string - The URL for the survey
- status? "published"|"unpublished" - The survey's status
mailchimp.marketing: SurveyRespondents
Survey respondent details
Fields
- submittedAt? string - The date and time when the survey response was submitted in ISO 8601 format
- responseId? string - The ID for the survey response
- contact? Contact - Information about the contact
- isNewContact? boolean - If this contact was added to the Mailchimp audience via this survey
mailchimp.marketing: SurveyResponse
A single survey response
Fields
- submittedAt? string - The date and time when the survey response was submitted in ISO 8601 format
- responseId? string - The ID for the survey response
- contact? Contact - Information about the contact
- isNewContact? boolean - If this contact was added to the Mailchimp audience via this survey
- results? Response[] - The survey questions and the answers to those questions
mailchimp.marketing: Tag
Fields
- tagName? string - The name of the tag
- tagId? int - The unique id for the tag
mailchimp.marketing: TagSearchResults
A list of tags matching the input query
Fields
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: TagSearchResultsTags
Fields
- name? string - The name of the tag
- id? int - The unique id for the tag
mailchimp.marketing: TemplateContent
Use this template to generate the HTML content of the campaign
Fields
- id int - The id of the template to use
- sections? record {} - Content for the sections of the template. Each key should be the unique mc:edit area name from the template
mailchimp.marketing: TemplateContent1
Use this template to generate the HTML content for the campaign
Fields
- id int - The id of the template to use
- sections? record {} - Content for the sections of the template. Each key should be the unique mc:edit area name from the template
mailchimp.marketing: TemplateDefaultContent
Default content for a template
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- sections? record { record {}... } - The sections that you can edit in the template, including each section's default content
mailchimp.marketing: TemplateFolder
A folder used to organize templates
Fields
- name string - The name of the folder
mailchimp.marketing: TemplateFolder1
A folder used to organize templates
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the folder
- count? int - The number of templates in the folder
- id? string - A string that uniquely identifies this template folder
mailchimp.marketing: TemplateFolder2
A folder used to organize templates
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- name? string - The name of the folder
- count? int - The number of templates in the folder
- id? string - A string that uniquely identifies this template folder
mailchimp.marketing: TemplateFolders
A list of template folders
Fields
- folders? TemplateFolder2[] - An array of objects representing template folders
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: TemplateInstance
Information about a specific template
Fields
- name string - The name of the template
- html string - The raw HTML for the template. We support the Mailchimp Template Language in any HTML code passed via the API
- folderId? string - The id of the folder the template is currently in
mailchimp.marketing: TemplateInstance1
Information about a specific template
Fields
- thumbnail? string - If available, the URL for a thumbnail of the template
- dateEdited? string - The date and time the template was edited in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- dateCreated? string - The date and time the template was created in ISO 8601 format
- active? boolean - User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active
- 'type? string - The type of template (user, base, or gallery)
- createdBy? string - The login name for template's creator
- dragAndDrop? boolean - Whether the template uses the drag and drop editor
- contentType? "template"|"multichannel"|"html" - How the template's content is put together
- responsive? boolean - Whether the template contains media queries to make it responsive
- name? string - The name of the template
- id? int - The individual id for the template
- category? string - If available, the category the template is listed in
- folderId? string - The id of the folder the template is currently in
- editedBy? string - The login name who last edited the template
mailchimp.marketing: TemplateInstance2
Information about a specific template
Fields
- thumbnail? string - If available, the URL for a thumbnail of the template
- dateEdited? string - The date and time the template was edited in ISO 8601 format
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- dateCreated? string - The date and time the template was created in ISO 8601 format
- active? boolean - User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active
- 'type? string - The type of template (user, base, or gallery)
- createdBy? string - The login name for template's creator
- dragAndDrop? boolean - Whether the template uses the drag and drop editor
- contentType? "template"|"multichannel"|"html" - How the template's content is put together
- responsive? boolean - Whether the template contains media queries to make it responsive
- name? string - The name of the template
- id? int - The individual id for the template
- category? string - If available, the category the template is listed in
- folderId? string - The id of the folder the template is currently in
- editedBy? string - The login name who last edited the template
mailchimp.marketing: Templates
A list an account's available templates
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- templates? TemplateInstance2[] - All of an account's saved or custom templates
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: ToNewSubscribers
Determines if the campaign qualifies to be resent to new subscribers
Fields
- reason? string - The reason the campaign is not eligible to be resent to this segment
- isEligible? boolean - Determines if the campaign qualifies to be resent to this segment
mailchimp.marketing: ToNonClickers
Determines if the campaign qualifies to be resent to non-clickers
Fields
- reason? string - The reason the campaign is not eligible to be resent to this segment
- isEligible? boolean - Determines if the campaign qualifies to be resent to this segment
mailchimp.marketing: ToNonOpeners
Determines if the campaign qualifies to be resent to non-openers
Fields
- reason? string - The reason the campaign is not eligible to be resent to this segment
- isEligible? boolean - Determines if the campaign qualifies to be resent to this segment
mailchimp.marketing: ToNonPurchasers
Determines if the campaign qualifies to be resent to non-purchasers
Fields
- reason? string - The reason the campaign is not eligible to be resent to this segment
- isEligible? boolean - Determines if the campaign qualifies to be resent to this segment
mailchimp.marketing: TrackedConversations
A collection of this account's tracked conversations
Fields
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- conversations? Conversation1[] - A list of conversations
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: TrackingSettings
The tracking settings applied to this landing page
Fields
- enableRestrictedDataProcessing? boolean - Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads here
mailchimp.marketing: TwitterStats
A summary of Twitter activity for a campaign
Fields
- lastTweet? string - The day and time of the last recorded tweet with a link to the campaign
- statuses? TwitterStatus[] - A summary of tweets that include a link to the campaign
- firstTweet? string - The day and time of the first recorded tweet with a link to the campaign
- tweets? int - The number of tweets including a link to the campaign
- retweets? int - The number of retweets that include a link to the campaign
mailchimp.marketing: TwitterStatus
An individual tweet
Fields
- datetime? string - A timestamp for the tweet
- statusId? string - The individual id for the tweet
- screenName? string - The Twitter handle for the author of the tweet
- isRetweet? boolean - A 'true' or 'false' status of whether the tweet is a retweet
- status? string - The body of the tweet
mailchimp.marketing: Unsubscribes
A list of members who have unsubscribed from a specific campaign
Fields
- unsubscribes? Unsubscribes2[] - An array of objects, each representing a member who unsubscribed from a campaign
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- totalItems? int - The total number of items matching the query regardless of pagination
- campaignId? string - The campaign id
mailchimp.marketing: Unsubscribes1
A member who unsubscribed from a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- reason? string - If available, the reason listed by the member for unsubscribing
- emailAddress? string - Email address for a subscriber
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- vip? boolean - VIP status for subscriber
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- campaignId? string - The campaign id
- timestamp? string - The date and time the member opted-out in ISO 8601 format
mailchimp.marketing: Unsubscribes2
A member who unsubscribed from a specific campaign
Fields
- emailId? string - The MD5 hash of the lowercase version of the list member's email address
- reason? string - If available, the reason listed by the member for unsubscribing
- emailAddress? string - Email address for a subscriber
- listId? string - The list id
- links? ResourceLink[] - A list of link types and descriptions for the API schema documents
- mergeFields? record { record {}... } - A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure
- vip? boolean - VIP status for subscriber
- listIsActive? boolean - The status of the list used, namely if it's deleted or disabled
- campaignId? string - The campaign id
- timestamp? string - The date and time the member opted-out in ISO 8601 format
mailchimp.marketing: UpdateInformationAboutASpecificWorkflowEmail
Update information about an individual Automation workflow email
Fields
- settings? CampaignSettings - Settings for the campaign including the email subject, from name, and from email address
- delay? AutomationDelay - The delay settings for an automation email
mailchimp.marketing: UploadArchive
Available when uploading an archive to create campaign content. The archive should include all campaign content and images. Learn more
Fields
- archiveContent string - The base64-encoded representation of the archive file
- archiveType? "zip"|"tar.gz"|"tar.bz2"|"tar"|"tgz"|"tbz" - The type of encoded file. Defaults to zip
mailchimp.marketing: VerifiedDomains
The verified domains currently on the account
Fields
- authenticated? boolean - Whether domain authentication is enabled for this domain
- isFreeEmailProvider? boolean - Returns whether the domain used is a public / free email provider. See Limitations of Free Email Addresses for more details
- domain? string - The name of this domain
- verified? boolean - Whether the domain has been verified for sending
- verificationEmail? string - The e-mail address receiving the two-factor challenge for this domain
- verificationSent? string - The date/time that the two-factor challenge was sent to the verification email
- status? "VERIFICATION_IN_PROGRESS"|"VERIFIED"|"EXPIRED"|"ERROR"|"AUTHENTICATION_IN_PROGRESS"|"AUTHENTICATION_ERROR"|"AUTHENTICATED" - The Domain's current status
mailchimp.marketing: VerifiedDomains1
The verified domains currently on the account
Fields
- domains? VerifiedDomains[] - The domains on the account
- totalItems? int - The total number of items matching the query regardless of pagination
mailchimp.marketing: VerifiedDomains2
The verified domains currently on the account
Fields
- verificationEmail string - The e-mail address at the domain you want to verify. This will receive a two-factor challenge to be used in the verify action
mailchimp.marketing: VerifyADomainForSending
Submit a response to the verification challenge and verify a domain for sending
Fields
- code string - The code that was sent to the email address provided when adding a new domain to verify
mailchimp.marketing: WeeklyClicksAndVisitsData
The clicks and visits data from the last five weeks
Fields
- uniqueVisits? DailyClicksAndVisitsDataUniqueVisits[] -
- visits? WeeklyClicksAndVisitsDataVisits[] - The total number of visits in a week
- clicks? WeeklyClicksAndVisitsDataClicks[] - The total number of clicks in a week
mailchimp.marketing: WeeklyClicksAndVisitsDataClicks
Fields
- date? string -
- val? int -
mailchimp.marketing: WeeklyClicksAndVisitsDataVisits
Fields
- date? string -
- val? int -
Import
import ballerinax/mailchimp.marketing;Other versions
1.0.0