{ "x-doc-structure": { "resources": { "root": { "title": "API Root", "description": "The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account.", "paths": [ "/" ], "subResources": [] }, "chimp-chatter": { "title": "Chimp Chatter Activity", "description": "Get the latest Chimp Chatter activity from your account.", "paths": [ "/activity-feed/chimp-chatter" ] }, "authorized-apps": { "title": "Authorized Apps", "description": "Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints.", "paths": [ "/authorized-apps", "/authorized-apps/{app_id}" ] }, "automation": { "title": "Automations", "description": "Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Customer Journeys.", "paths": [ "/automations", "/automations/{workflow_id}", "/automations/{workflow_id}/actions/start-all-emails", "/automations/{workflow_id}/actions/pause-all-emails", "/automations/{workflow_id}/actions/archive" ], "subResources": [ "automation-email", "automation-removed-subscribers" ] }, "automation-email": { "title": "Emails", "description": "Manage individual emails in a classic automation workflow.", "paths": [ "/automations/{workflow_id}/emails", "/automations/{workflow_id}/emails/{workflow_email_id}", "/automations/{workflow_id}/emails/{workflow_email_id}/actions/pause", "/automations/{workflow_id}/emails/{workflow_email_id}/actions/start" ], "subResources": [ "automation-email-queue" ] }, "automation-email-queue": { "title": "Queue", "description": "Manage list member queues for classic automation emails.", "paths": [ "/automations/{workflow_id}/emails/{workflow_email_id}/queue", "/automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}" ], "subResources": [] }, "automation-removed-subscribers": { "title": "Removed Subscribers", "description": "Remove subscribers from a classic automation workflow.", "paths": [ "/automations/{workflow_id}/removed-subscribers", "/automations/{workflow_id}/removed-subscribers/{subscriber_hash}" ], "subResources": [] }, "batch-operations": { "title": "Batch Operations", "description": "Use batch operations to complete multiple operations with a single call.", "paths": [ "/batches", "/batches/{batch_id}" ] }, "batch-webhooks": { "title": "Batch Webhooks", "description": "Manage webhooks for batch operations. ", "paths": [ "/batch-webhooks", "/batch-webhooks/{batch_webhook_id}" ] }, "campaigns": { "title": "Campaigns", "description": "Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account.", "paths": [ "/campaigns", "/campaigns/{campaign_id}", "/campaigns/{campaign_id}/actions/cancel-send", "/campaigns/{campaign_id}/actions/send", "/campaigns/{campaign_id}/actions/schedule", "/campaigns/{campaign_id}/actions/unschedule", "/campaigns/{campaign_id}/actions/pause", "/campaigns/{campaign_id}/actions/resume", "/campaigns/{campaign_id}/actions/replicate", "/campaigns/{campaign_id}/actions/test", "/campaigns/{campaign_id}/actions/create-resend" ], "subResources": [ "campaign-feedback", "campaign-checklist", "campaign-content" ] }, "campaign-feedback": { "title": "Feedback", "description": "Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign.", "paths": [ "/campaigns/{campaign_id}/feedback", "/campaigns/{campaign_id}/feedback/{feedback_id}" ] }, "campaign-checklist": { "title": "Send Checklist", "description": "Review the send checklist for your campaign, and resolve any issues before sending.", "paths": [ "/campaigns/{campaign_id}/send-checklist" ] }, "campaign-content": { "title": "Content", "description": "Manage the HTML, plain-text, and template content for your Mailchimp campaigns.", "paths": [ "/campaigns/{campaign_id}/content" ] }, "connected-sites": { "title": "Connected Sites", "description": "Manage sites you've connected to your Mailchimp account.", "paths": [ "/connected-sites", "/connected-sites/{connected_site_id}", "/connected-sites/{connected_site_id}/actions/verify-script-installation" ] }, "conversations": { "title": "Conversations", "description": "Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account.", "paths": [ "/conversations", "/conversations/{conversation_id}" ], "subResources": [ "conversation-messages" ] }, "conversation-messages": { "title": "Messages", "description": "Manage messages in a specific campaign conversation.", "paths": [ "/conversations/{conversation_id}/messages", "/conversations/{conversation_id}/messages/{message_id}" ] }, "customer-journeys-journeys-steps-actions": { "title": "Customer Journeys", "description": "Manage Customer Journey automated workflows", "paths": [ "/customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger" ], "subResources": [] }, "file-manager": { "title": "File Manager", "description": "Manage files for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms.", "paths": [], "subResources": [ "file-manager-folders", "file-manager-files" ] }, "file-manager-folders": { "title": "File Manager Folders", "description": "Manage specific folders in the File Manager for your Mailchimp account.", "paths": [ "/file-manager/folders", "/file-manager/folders/{folder_id}" ] }, "file-manager-files": { "title": "File Manager Files", "description": "Manage specific files in the File Manager for your Mailchimp account.", "paths": [ "/file-manager/files", "/file-manager/files/{file_id}" ] }, "landing-pages": { "title": "Landing Pages", "description": "Manage your Landing Pages, including publishing and unpublishing.", "paths": [ "/landing-pages", "/landing-pages/{page_id}", "/landing-pages/{page_id}/actions/publish", "/landing-pages/{page_id}/actions/unpublish" ], "subResources": [ "landing-pages_content" ] }, "landing-pages_content": { "title": "Content", "description": "The HTML content for your Mailchimp landing pages.", "paths": [ "/landing-pages/{page_id}/content" ] }, "lists": { "title": "Lists/Audiences", "description": "Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts.", "paths": [ "/lists", "/lists/{list_id}" ], "subResources": [ "interest-categories", "list-segments", "abuse-reports", "list-activity", "list-clients", "list-growth-history", "list-imports", "list-members", "list-merges", "list-webhooks", "list-signup-forms", "list-locations", "lists-tags-search", "prebuilt-segments", "list-preview-segment", "list-surveys" ] }, "list-members": { "title": "Members", "description": "Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members.", "paths": [ "/lists/{list_id}/members", "/lists/{list_id}/members/{subscriber_hash}", "/lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent" ], "subResources": [ "list-member-activity", "list-member-activity-feed", "list-member-goal", "list-member-notes", "list-member-tags", "list-member-events" ] }, "list-merges": { "title": "Merge Fields", "description": "Manage merge fields (formerly merge vars) for a specific list.", "paths": [ "/lists/{list_id}/merge-fields", "/lists/{list_id}/merge-fields/{merge_id}" ], "subResources": [] }, "abuse-reports": { "title": "Abuse Reports", "description": "Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program.", "paths": [ "/lists/{list_id}/abuse-reports", "/lists/{list_id}/abuse-reports/{report_id}" ] }, "list-activity": { "title": "Activity", "description": "Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days.", "paths": [ "/lists/{list_id}/activity" ] }, "list-clients": { "title": "Clients", "description": "Get information about the most popular email clients for subscribers in a specific Mailchimp list.", "paths": [ "/lists/{list_id}/clients" ] }, "list-growth-history": { "title": "Growth History", "description": "View a summary of the month-by-month growth activity for a specific list.", "paths": [ "/lists/{list_id}/growth-history", "/lists/{list_id}/growth-history/{month}" ] }, "list-webhooks": { "title": "Webhooks", "description": "Manage webhooks for a specific Mailchimp list.", "paths": [ "/lists/{list_id}/webhooks", "/lists/{list_id}/webhooks/{webhook_id}" ] }, "interest-categories": { "title": "Interest Categories", "description": "Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application.", "paths": [ "/lists/{list_id}/interest-categories", "/lists/{list_id}/interest-categories/{interest_category_id}" ], "subResources": [ "interests" ] }, "interests": { "title": "Interests", "description": "Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.", "paths": [ "/lists/{list_id}/interest-categories/{interest_category_id}/interests", "/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}" ] }, "lists-tags-search": { "title": "Tag Search", "description": "Search for tags on a list by name.", "paths": [ "/lists/{list_id}/tag-search" ] }, "list-segments": { "title": "Segments", "description": "Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts.", "paths": [ "/lists/{list_id}/segments", "/lists/{list_id}/segments/{segment_id}" ], "subResources": [ "list-segment-members" ] }, "list-segment-members": { "title": "Segment Members", "description": "Manage list members in a saved segment.", "paths": [ "/lists/{list_id}/segments/{segment_id}/members", "/lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}" ] }, "list-member-activity": { "title": "Member Activity", "description": "Get details about a subscriber's recent activity. Use the new activity-feed endpoint to access more events for a given contact.", "paths": [ "/lists/{list_id}/members/{subscriber_hash}/activity" ] }, "list-member-activity-feed": { "title": "Member Activity Feed", "description": "Get details about a subscriber's recent activity.", "paths": [ "/lists/{list_id}/members/{subscriber_hash}/activity-feed" ] }, "list-member-goal": { "title": "Member Goals", "description": "Get information about recent goal events for a specific list member.", "paths": [ "/lists/{list_id}/members/{subscriber_hash}/goals" ] }, "list-member-notes": { "title": "Member Notes", "description": "Retrieve recent notes for a specific list member.", "paths": [ "/lists/{list_id}/members/{subscriber_hash}/notes", "/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}" ] }, "list-member-tags": { "title": "Member Tags", "description": "Manage all the tags that have been assigned to a contact.", "paths": [ "/lists/{list_id}/members/{subscriber_hash}/tags" ] }, "list-member-events": { "title": "Events", "description": "Use the Events endpoint to collect website or in-app actions and trigger targeted automations. ", "paths": [ "/lists/{list_id}/members/{subscriber_hash}/events" ] }, "list-signup-forms": { "title": "Signup Forms", "description": "Manage list signup forms.", "paths": [ "/lists/{list_id}/signup-forms" ] }, "list-locations": { "title": "Locations", "description": "Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address.", "paths": [ "/lists/{list_id}/locations" ] }, "reports": { "title": "Reports", "description": "Manage campaign reports for your Mailchimp account. All Reports endpoints are read-only. Mailchimp's campaign and automation reports analyze clicks, opens, subscribers' social activity, e-commerce data, and more. Note: Campaign IDs for A/B Testing Campaigns are available through the Campaign API Endpoint's Read method.", "paths": [ "/reports", "/reports/{campaign_id}" ], "subResources": [ "campaign-abuse", "campaign-advice", "click-reports", "domain-performance-reports", "eepurl-reports", "email-activity-reports", "location-reports", "sent-to-reports", "sub-reports", "unsub-reports", "open-reports", "campaign-ecommerce-product-activity" ] }, "campaign-abuse": { "title": "Campaign Abuse", "description": "Get information about campaign abuse complaints.", "paths": [ "/reports/{campaign_id}/abuse-reports", "/reports/{campaign_id}/abuse-reports/{report_id}" ] }, "campaign-advice": { "title": "Campaign Advice", "description": "Get recent feedback based on a campaign's statistics.", "paths": [ "/reports/{campaign_id}/advice" ] }, "open-reports": { "title": "Campaign Open Reports", "description": "Get a detailed report about any emails in a specific campaign that were opened by the recipient. ", "paths": [ "/reports/{campaign_id}/open-details", "/reports/{campaign_id}/open-details/{subscriber_hash}" ] }, "click-reports": { "title": "Click Reports", "description": "Get detailed information about links clicked in campaigns.", "paths": [ "/reports/{campaign_id}/click-details", "/reports/{campaign_id}/click-details/{link_id}" ], "subResources": [ "link-clickers" ] }, "campaign-ecommerce-product-activity": { "title": "Ecommerce Product Activity", "description": "Ecommerce product activity report for a campaign.", "paths": [ "/reports/{campaign_id}/ecommerce-product-activity" ] }, "link-clickers": { "title": "Click Reports Members", "description": "Get information about specific subscribers who clicked on links in a campaign.", "paths": [ "/reports/{campaign_id}/click-details/{link_id}/members", "/reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}" ] }, "domain-performance-reports": { "title": "Domain Performance", "description": "Get statistics for the top-performing domains from a campaign.", "paths": [ "/reports/{campaign_id}/domain-performance" ] }, "eepurl-reports": { "title": "EepURL Reports", "description": "Get a summary of social activity for the campaign, tracked by EepURL.", "paths": [ "/reports/{campaign_id}/eepurl" ] }, "email-activity-reports": { "title": "Email Activity", "description": "Get list member activity for a specific campaign.", "paths": [ "/reports/{campaign_id}/email-activity", "/reports/{campaign_id}/email-activity/{subscriber_hash}" ] }, "location-reports": { "title": "Location", "description": "Get top open locations for a specific campaign.", "paths": [ "/reports/{campaign_id}/locations" ] }, "sent-to-reports": { "title": "Sent To", "description": "Get details about campaign recipients.", "paths": [ "/reports/{campaign_id}/sent-to", "/reports/{campaign_id}/sent-to/{subscriber_hash}" ] }, "sub-reports": { "title": "Sub-Reports", "description": "A list of reports for child campaigns of a specific parent campaign. For example, use this endpoint to view Multivariate, RSS, and A/B Testing Campaign reports.", "paths": [ "/reports/{campaign_id}/sub-reports" ] }, "unsub-reports": { "title": "Unsubscribes", "description": "Get information about list members who unsubscribed from a specific campaign.", "paths": [ "/reports/{campaign_id}/unsubscribed", "/reports/{campaign_id}/unsubscribed/{subscriber_hash}" ] }, "templates": { "title": "Templates", "description": "Manage your Mailchimp templates. A template is an HTML file used to create the layout and basic design for a campaign. ", "paths": [ "/templates", "/templates/{template_id}" ], "subResources": [ "template-default-content" ] }, "template-default-content": { "title": "Default Content", "description": "Manage the default content for a Mailchimp template.", "paths": [ "/templates/{template_id}/default-content" ] }, "template-folders": { "title": "Template Folders", "description": "Organize your templates using folders.", "paths": [ "/template-folders", "/template-folders/{folder_id}" ] }, "campaign-folders": { "title": "Campaign Folders", "description": "Organize your campaigns using folders.", "paths": [ "/campaign-folders", "/campaign-folders/{folder_id}" ] }, "ecommerce-stores": { "title": "E-commerce Stores", "description": "Connect your E-commerce Store to Mailchimp to take advantage of powerful reporting and personalization features and to learn more about your customers.", "paths": [ "/ecommerce/stores", "/ecommerce/stores/{store_id}" ], "subResources": [ "ecommerce-customers", "ecommerce-orders", "ecommerce-products", "ecommerce-carts", "ecommerce-promo-rules" ] }, "ecommerce-customers": { "title": "Customers", "description": "Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member.", "paths": [ "/ecommerce/stores/{store_id}/customers", "/ecommerce/stores/{store_id}/customers/{customer_id}" ] }, "ecommerce-promo-rules": { "title": "Promo Rules", "description": "Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes.", "paths": [ "/ecommerce/stores/{store_id}/promo-rules", "/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}" ], "subResources": [ "ecommerce-promo-codes" ] }, "ecommerce-promo-codes": { "title": "Promo Codes", "description": "Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule.", "paths": [ "/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes", "/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}" ] }, "ecommerce-orders": { "title": "Orders", "description": "Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account.", "paths": [ "/ecommerce/orders", "/ecommerce/stores/{store_id}/orders", "/ecommerce/stores/{store_id}/orders/{order_id}" ], "subResources": [ "ecommerce-order-lines" ] }, "ecommerce-order-lines": { "title": "Order Lines", "description": "Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases.", "paths": [ "/ecommerce/stores/{store_id}/orders/{order_id}/lines", "/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}" ] }, "ecommerce-products": { "title": "Products", "description": "E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant.", "paths": [ "/ecommerce/stores/{store_id}/products", "/ecommerce/stores/{store_id}/products/{product_id}" ], "subResources": [ "ecommerce-product-variants", "ecommerce-product-images" ] }, "ecommerce-product-variants": { "title": "Product Variants", "description": "A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product.", "paths": [ "/ecommerce/stores/{store_id}/products/{product_id}/variants", "/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}" ] }, "ecommerce-product-images": { "title": "Product Images", "description": "A Product Image represents a specific product image.", "paths": [ "/ecommerce/stores/{store_id}/products/{product_id}/images", "/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}" ] }, "ecommerce-carts": { "title": "Carts", "description": "Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumer\u2019s shopping cart pending a successful Order.", "paths": [ "/ecommerce/stores/{store_id}/carts", "/ecommerce/stores/{store_id}/carts/{cart_id}" ], "subResources": [ "ecommerce-cart-lines" ] }, "ecommerce-cart-lines": { "title": "Cart Lines", "description": "Each Cart contains one or more Cart Lines, which represent a specific Product Variant that a Customer has added to their shopping cart.", "paths": [ "/ecommerce/stores/{store_id}/carts/{cart_id}/lines", "/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}" ] }, "facebook-ads": { "title": "Facebook Ads", "description": "Get information about Facebook Ads.", "paths": [ "/facebook-ads", "/facebook-ads/{outreach_id}" ] }, "ping": { "title": "Ping", "description": "A health check endpoint for Mailchimp API 3.0.", "paths": [ "/ping" ] }, "reporting": { "title": "Reporting", "description": "Reporting for various campaign types.", "paths": [], "subResources": [ "reporting-facebook-ads", "reporting-google-ads", "reporting-landing-pages", "reporting-postcards", "reporting-social-posts", "reporting-surveys", "reporting-websites" ] }, "reporting-facebook-ads": { "title": "Facebook Ads", "description": "Get information about Facebook Ad reports. ", "paths": [ "/reporting/facebook-ads", "/reporting/facebook-ads/{outreach_id}", "/reporting/facebook-ads/{outreach_id}/ecommerce-product-activity" ] }, "reporting-landing-pages": { "title": "Landing Pages", "description": "Get information about Landing Page reports.", "paths": [ "/reporting/landing-pages", "/reporting/landing-pages/{outreach_id}" ] }, "search-campaigns": { "title": "Search Campaigns", "description": "Search all of an account's campaigns for the specified query terms.", "paths": [ "/search-campaigns" ] }, "search-members": { "title": "Search Members", "description": "Search the account or a specific list for members that match the specified query terms.", "paths": [ "/search-members" ] }, "verified-domains": { "x-hidden": false, "title": "Verified Domains", "description": "Manage the domains on your account that can be used for sending email campaigns.", "paths": [ "/verified-domains", "/verified-domains/{domain_name}", "/verified-domains/{domain_name}/actions/verify" ], "subresources": [] } } }, "swagger": "2.0", "info": { "version": "3.0.47", "title": "Mailchimp Marketing API", "contact": { "name": "Mailchimp API Support", "email": "apihelp@mailchimp.com" }, "x-permalink": "https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/master/spec/marketing.json" }, "host": "server.api.mailchimp.com", "basePath": "/3.0", "securityDefinitions": { "basicAuth": { "type": "basic" } }, "security": [ { "basicAuth": [] } ], "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json", "application/problem+json" ], "paths": { "/": { "get": { "summary": "List api root resources", "description": "Get links to all other resources available in the API.", "operationId": "getRoot", "parameters": [ { "name": "fields", "x-title": "Fields", "in": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "name": "exclude_fields", "x-title": "Exclude Fields", "in": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } } ], "responses": { "200": { "description": "", "schema": { "type": "object", "title": "API Root", "description": "The API root resource links to all other resources available in the API.", "properties": { "account_id": { "type": "string", "title": "Account ID", "description": "The Mailchimp account ID.", "readOnly": true }, "login_id": { "type": "string", "title": "Login ID", "description": "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.", "readOnly": true }, "account_name": { "type": "string", "title": "Account Name", "description": "The name of the account.", "readOnly": true }, "email": { "type": "string", "title": "Account Email", "description": "The account email address.", "readOnly": true }, "first_name": { "type": "string", "title": "First Name", "description": "The first name tied to the account.", "readOnly": true }, "last_name": { "type": "string", "title": "Last Name", "description": "The last name tied to the account.", "readOnly": true }, "username": { "type": "string", "title": "User Name", "description": "The username tied to the account.", "readOnly": true, "example": "freddie2000" }, "avatar_url": { "type": "string", "title": "Avatar URL", "description": "URL of the avatar for the user.", "readOnly": true }, "role": { "type": "string", "title": "Role", "description": "The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account.", "readOnly": true }, "member_since": { "type": "string", "title": "Account Creation Date", "format": "date-time", "description": "The date and time that the account was created in ISO 8601 format.", "readOnly": true, "example": "2010-01-01T23:59:59+00:00" }, "pricing_plan_type": { "type": "string", "title": "Account Pricing Plan", "description": "The type of pricing plan the account is on.", "enum": [ "monthly", "pay_as_you_go", "forever_free" ], "readOnly": true }, "first_payment": { "type": "string", "title": "First Payment", "format": "date-time", "description": "Date of first payment for monthly plans.", "readOnly": true, "example": "2010-01-01T23:59:59+00:00" }, "account_timezone": { "type": "string", "title": "Account Timezone", "description": "The timezone currently set for the account.", "readOnly": true }, "account_industry": { "type": "string", "title": "Account Industry", "description": "The user-specified industry associated with the account.", "readOnly": true }, "contact": { "type": "object", "title": "Account Contact", "description": "Information about the account contact.", "readOnly": true, "properties": { "company": { "type": "string", "title": "Company", "description": "The company name for the account.", "readOnly": true }, "addr1": { "type": "string", "title": "Address Line 1", "description": "The street address for the account contact.", "readOnly": true }, "addr2": { "type": "string", "title": "Address Line 2", "description": "The street address for the account contact.", "readOnly": true }, "city": { "type": "string", "title": "City", "description": "The city for the account contact.", "readOnly": true }, "state": { "type": "string", "title": "State", "description": "The state for the account contact.", "readOnly": true }, "zip": { "type": "string", "title": "Zip Code", "description": "The zip code for the account contact.", "readOnly": true }, "country": { "type": "string", "title": "Country", "description": "The country for the account contact.", "readOnly": true } } }, "pro_enabled": { "type": "boolean", "title": "Mailchimp Pro", "description": "Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-mailchimp-pro/).", "readOnly": true }, "last_login": { "type": "string", "title": "Last Login Date", "description": "The date and time of the last login for this account in ISO 8601 format.", "readOnly": true, "format": "date-time" }, "total_subscribers": { "type": "integer", "title": "Total Subscribers", "description": "The total number of subscribers across all lists in the account.", "readOnly": true }, "industry_stats": { "type": "object", "title": "Industry Stats", "description": "The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry.", "readOnly": true, "properties": { "open_rate": { "type": "number", "title": "Open Rate", "description": "The average unique open rate for all campaigns in the account's specified industry.", "readOnly": true }, "bounce_rate": { "type": "number", "title": "Bounce Rate", "description": "The average bounce rate for all campaigns in the account's specified industry.", "readOnly": true }, "click_rate": { "type": "number", "title": "Click Rate", "description": "The average unique click rate for all campaigns in the account's specified industry.", "readOnly": true } } }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "root" ], "x-custom-config": { "methodNameSnake": "get_root", "methodNameCamel": "getRoot" } } }, "/activity-feed/chimp-chatter": { "get": { "summary": "Get latest chimp chatter", "description": "Return the Chimp Chatter for this account ordered by most recent.", "parameters": [ { "name": "count", "x-title": "Count", "in": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000", "required": false, "default": 10, "maximum": 1000, "type": "integer" }, { "name": "offset", "x-title": "Offset", "in": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", "required": false, "default": 0, "type": "integer" } ], "responses": { "200": { "description": "ChimpChatter Collection", "schema": { "type": "object", "description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.", "properties": { "chimp_chatter": { "type": "array", "description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account.", "readOnly": true, "items": { "type": "object", "title": "ChimpChatter", "description": "A Chimp Chatter message", "properties": { "title": { "type": "string", "title": "Title", "readOnly": true, "example": "1 new subscriber to Your New Campaign!" }, "message": { "type": "string", "title": "Message", "readOnly": true, "example": "People are telling their friends about your campaign!" }, "type": { "type": "string", "title": "Type", "description": "The type of activity", "enum": [ "lists:new-subscriber", "lists:unsubscribes", "lists:profile-updates", "campaigns:facebook-likes", "campaigns:forward-to-friend", "lists:imports" ], "readOnly": true, "example": "campaigns:forward-to-friend" }, "update_time": { "type": "string", "title": "Update Time", "format": "date-time", "description": "The date and time this activity was updated.", "readOnly": true, "example": "2017-08-04T11:09:01+00:00" }, "url": { "type": "string", "title": "URL", "description": "URL to a report that includes this activity", "readOnly": true, "example": "http://dev.mailchimp.com/reports/summary?id=1" }, "list_id": { "type": "string", "title": "List ID", "description": "If it exists, list ID for the associated list", "readOnly": true, "example": "2017-08-04T11:09:01+00:00" }, "campaign_id": { "type": "string", "title": "Campaign ID", "description": "If it exists, campaign ID for the associated campaign", "readOnly": true, "example": "2017-08-04T11:09:01+00:00" } } } }, "total_items": { "type": "integer", "title": "Item Count", "description": "The total number of items matching the query regardless of pagination.", "readOnly": true }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "tags": [ "activityFeed" ], "x-custom-config": { "methodNameSnake": "get_chimp_chatter", "methodNameCamel": "getChimpChatter" }, "operationId": "getActivityFeedChimpChatter" } }, "/authorized-apps": { "get": { "summary": "List authorized apps", "description": "Get a list of an account's registered, connected applications.", "operationId": "getAuthorizedApps", "parameters": [ { "name": "fields", "x-title": "Fields", "in": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "name": "exclude_fields", "x-title": "Exclude Fields", "in": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "name": "count", "x-title": "Count", "in": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000", "required": false, "default": 10, "maximum": 1000, "type": "integer" }, { "name": "offset", "x-title": "Offset", "in": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", "required": false, "default": 0, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "type": "object", "description": "An array of objects, each representing an authorized application.", "properties": { "apps": { "title": "Authorized Applications", "description": "An array of objects, each representing an authorized application.", "type": "array", "items": { "type": "object", "description": "An authorized app.", "properties": { "id": { "type": "integer", "title": "Client ID", "description": "The ID for the application." }, "name": { "type": "string", "title": "Application Name", "description": "The name of the application." }, "description": { "type": "string", "title": "Application Description", "description": "A short description of the application." }, "users": { "type": "array", "title": "Application Users", "description": "An array of usernames for users who have linked the app.", "items": { "type": "string" } }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "total_items": { "type": "integer", "title": "Item Count", "description": "The total number of items matching the query regardless of pagination.", "readOnly": true }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "authorizedApps" ], "x-custom-config": { "methodNameSnake": "list", "methodNameCamel": "list" } } }, "/authorized-apps/{app_id}": { "get": { "summary": "Get authorized app info", "description": "Get information about a specific authorized application.", "operationId": "getAuthorizedAppsId", "parameters": [ { "name": "fields", "x-title": "Fields", "in": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "name": "exclude_fields", "x-title": "Exclude Fields", "in": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "in": "path", "name": "app_id", "x-title": "App ID", "type": "string", "required": true, "description": "The unique id for the connected authorized application." } ], "responses": { "200": { "description": "", "schema": { "type": "object", "description": "An authorized app.", "properties": { "id": { "type": "integer", "title": "Client ID", "description": "The ID for the application." }, "name": { "type": "string", "title": "Application Name", "description": "The name of the application." }, "description": { "type": "string", "title": "Application Description", "description": "A short description of the application." }, "users": { "type": "array", "title": "Application Users", "description": "An array of usernames for users who have linked the app.", "items": { "type": "string" } }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "authorizedApps" ], "x-custom-config": { "methodNameSnake": "get", "methodNameCamel": "get" } } }, "/automations": { "get": { "summary": "List automations", "description": "Get a summary of an account's classic automations.", "operationId": "getAutomations", "parameters": [ { "name": "count", "x-title": "Count", "in": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000", "required": false, "default": 10, "maximum": 1000, "type": "integer" }, { "name": "offset", "x-title": "Offset", "in": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0.", "required": false, "default": 0, "type": "integer" }, { "name": "fields", "x-title": "Fields", "in": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "name": "exclude_fields", "x-title": "Exclude Fields", "in": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "name": "before_create_time", "x-title": "Before Create Time", "in": "query", "description": "Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.", "type": "string", "format": "date-time", "required": false }, { "name": "since_create_time", "x-title": "Since Create Time", "in": "query", "description": "Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.", "type": "string", "format": "date-time", "required": false }, { "name": "before_start_time", "x-title": "Before Start Time", "in": "query", "description": "Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.", "type": "string", "format": "date-time", "required": false }, { "name": "since_start_time", "x-title": "Since Start Time", "in": "query", "description": "Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00.", "type": "string", "format": "date-time", "required": false }, { "name": "status", "x-title": "Status", "in": "query", "description": "Restrict the results to automations with the specified status.", "required": false, "type": "string", "enum": [ "save", "paused", "sending" ] } ], "responses": { "200": { "description": "", "schema": { "type": "object", "description": "An array of objects, each representing an Automation workflow.", "properties": { "automations": { "type": "array", "items": { "type": "object", "title": "Automation Workflow", "description": "A summary of an individual Automation workflow's settings and content.", "properties": { "id": { "type": "string", "title": "Automation Campaign ID", "description": "A string that identifies the Automation.", "readOnly": true }, "create_time": { "type": "string", "title": "Create Time", "format": "date-time", "description": "The date and time the Automation was created in ISO 8601 format.", "readOnly": true }, "start_time": { "type": "string", "title": "Start Time", "format": "date-time", "description": "The date and time the Automation was started in ISO 8601 format.", "readOnly": true }, "status": { "type": "string", "title": "Automation Status", "description": "The current status of the Automation.", "enum": [ "save", "paused", "sending" ], "readOnly": true }, "emails_sent": { "type": "integer", "title": "Emails Sent", "description": "The total number of emails sent for the Automation.", "readOnly": true }, "recipients": { "type": "object", "title": "List", "description": "List settings for the Automation.", "properties": { "list_id": { "type": "string", "title": "List ID", "description": "The unique list id." }, "list_is_active": { "type": "boolean", "title": "List Status", "description": "The status of the list used, namely if it's deleted or disabled.", "readOnly": true }, "list_name": { "type": "string", "title": "List Name", "description": "List Name." }, "segment_opts": { "type": "object", "title": "Segment Options", "description": "An object representing all segmentation options.", "properties": { "saved_segment_id": { "type": "integer", "title": "Saved Segment ID", "description": "The id for an existing saved segment." }, "match": { "type": "string", "title": "Match Type", "description": "Segment match type.", "enum": [ "any", "all" ] }, "conditions": { "type": "array", "title": "Segment Type", "description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).", "items": { "x-discriminator": { "type": "string", "propertyName": "condition_type" }, "x-oneOf": [ { "type": "object", "title": "Aim Segment", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "properties": { "condition_type": { "type": "string", "x-value": "Aim", "enum": [ "Aim" ] }, "field": { "type": "string", "enum": [ "aim" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "example": "aim" }, "op": { "type": "string", "enum": [ "open", "click", "sent", "noopen", "noclick", "nosent" ], "title": "Segment Operator", "description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent.", "example": "open" }, "value": { "type": "string", "title": "Segment Data", "description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Automation Segment", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Automation", "enum": [ "Automation" ] }, "field": { "type": "string", "enum": [ "automation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "example": "automation" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.", "example": "started" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id for the automation workflow to segment against.", "example": "2135217" } } }, { "type": "object", "title": "Poll Activity Segment", "description": "Used for segmenting by poll activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "CampaignPoll", "enum": [ "CampaignPoll" ] }, "field": { "type": "string", "enum": [ "poll" ], "title": "Segment Field", "description": "Used for segmenting by poll activity.", "example": "poll" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members have/have not interacted with a specific poll in a Mailchimp email.", "example": "member" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the poll.", "example": 409 } } }, { "type": "object", "title": "Conversation Segment", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Conversation", "enum": [ "Conversation" ] }, "field": { "type": "string", "enum": [ "conversation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "example": "conversation" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied.", "example": "member" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Date Segment", "description": "Used for segmenting by a specific date field.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Date", "enum": [ "Date" ] }, "field": { "type": "string", "enum": [ "timestamp_opt", "info_changed", "ecomm_date" ], "title": "Segment Field", "description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.", "example": "timestamp_opt" }, "op": { "type": "string", "enum": [ "greater", "less", "is", "not", "blank", "blank_not", "within", "notwithin" ], "title": "Segment Operator", "description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.", "example": "greater" }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.", "example": "date" }, "extra": { "type": "string", "title": "Segment Extra Value", "description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.", "example": "2015-01-30" } } }, { "type": "object", "title": "Email Client Segment", "description": "Used for segmenting subscribers who are using a particular email client.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailClient", "enum": [ "EmailClient" ] }, "field": { "type": "string", "enum": [ "email_client" ], "title": "Segment Field", "description": "Used for segmenting subscribers who are using a particular email client.", "example": "email_client" }, "op": { "type": "string", "enum": [ "client_is", "client_not" ], "title": "Segment Operator", "description": "The operation to determine whether we select clients that match the value, or clients that do not match the value.", "example": "client_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The name of the email client.", "example": "Gmail" } } }, { "type": "object", "title": "Language Segment", "description": "Used for segmenting based off of a subscriber's language.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Language", "enum": [ "Language" ] }, "field": { "type": "string", "enum": [ "language" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's language.", "example": "language" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Whether the member's language is or is not set to a specific language.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "A two-letter language identifier.", "example": "en" } } }, { "type": "object", "title": "Member Rating Segment", "description": "Used for segmenting by member rating.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "MemberRating", "enum": [ "MemberRating" ] }, "field": { "type": "string", "enum": [ "rating" ], "title": "Segment Field", "description": "Used for segmenting by member rating.", "example": "rating" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The star rating number to segment against.", "example": 4 } } }, { "type": "object", "title": "Signup Source Segment", "description": "Used for segmenting by the signup source.", "required": [ "field", "condition_type", "op" ], "properties": { "condition_type": { "type": "string", "enum": [ "SignupSource" ], "x-value": "SignupSource", "title": "Type" }, "field": { "type": "string", "enum": [ "source" ], "title": "Segment Field", "example": "source" }, "op": { "type": "string", "enum": [ "source_is", "source_not" ], "title": "Segment Operator", "description": "Whether the member's signup source was/was not a particular value.", "example": "source_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The signup source.", "example": "List Import" } } }, { "type": "object", "title": "Survey Monkey Segment", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SurveyMonkey", "enum": [ "SurveyMonkey" ] }, "field": { "type": "string", "enum": [ "survey_monkey" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "example": "survey_monkey" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.", "example": "started" }, "value": { "type": "string", "title": "Survey ID", "description": "The unique ID of the survey monkey survey.", "example": "32179586" } } }, { "type": "object", "title": "VIP Segment", "description": "Used for segmenting based off of a subscriber's VIP status.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "VIP", "enum": [ "VIP" ] }, "field": { "type": "string", "enum": [ "gmonkey" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's VIP status.", "example": "gmonkey" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Whether the member is or is not marked as VIP.", "example": "member" } } }, { "type": "object", "title": "Interests Segment", "description": "Used for segmenting by a given interest group merge field.", "properties": { "condition_type": { "type": "string", "x-value": "Interests", "enum": [ "Interests" ] }, "field": { "type": "string", "title": "Segment Field", "description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'.", "example": "interests-123" }, "op": { "type": "string", "enum": [ "interestcontains", "interestcontainsall", "interestnotcontains" ], "title": "Segment Operator", "description": "Whether the member is a part of one, all, or none of the groups.", "example": "interestcontains" }, "value": { "type": "array", "title": "Segment Value", "description": "An array containing strings, each representing a group id.", "items": { "type": "string", "example": [ "44401", "44405", "44409" ] } } } }, { "type": "object", "title": "Ecommerce Category Segment", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "properties": { "condition_type": { "type": "string", "x-value": "EcommCategory", "enum": [ "EcommCategory" ] }, "field": { "type": "string", "enum": [ "ecomm_cat", "ecomm_prod" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "example": "ecomm_cat" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "The ecommerce category/item information.", "example": "Product" } } }, { "type": "object", "title": "Ecommerce Number Segment", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EcommNumber", "enum": [ "EcommNumber" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_avg", "ecomm_orders", "ecomm_prod_all", "ecomm_avg_ord" ], "title": "Segment Field", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "example": "ecomm_orders" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Segment", "description": "Used for segmenting members who have/have not purchased anything.", "properties": { "condition_type": { "type": "string", "x-value": "EcommPurchased", "enum": [ "EcommPurchased" ] }, "field": { "type": "string", "enum": [ "ecomm_purchased" ], "title": "Segment Field", "description": "Used for segmenting members who have/have not purchased anything.", "example": "ecomm_purchased" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who have have ('member') or have not ('notmember') purchased.", "example": "member" } } }, { "type": "object", "title": "Ecommerce Spent Segment", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "properties": { "condition_type": { "type": "string", "x-value": "EcommSpent", "enum": [ "EcommSpent" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_one", "ecomm_spent_all" ], "title": "Segment Field", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "example": "ecomm_spent_one" }, "op": { "type": "string", "enum": [ "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent 'more' or 'less' than then specified value.", "example": "greater" }, "value": { "type": "integer", "title": "Segment Data", "description": "The total amount a member spent.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Store Segment", "description": "Used for segmenting members have purchased from a specific store.", "properties": { "condition_type": { "type": "string", "x-value": "EcommStore", "enum": [ "EcommStore" ] }, "field": { "type": "string", "enum": [ "ecomm_store" ], "title": "Segment Field", "description": "Used for segmenting members have purchased from a specific store.", "example": "ecomm_store" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who have or have not purchased from a specific store.", "example": "is" }, "value": { "type": "string", "title": "Segment Operator", "description": "The store id to segment against.", "example": "289" } } }, { "type": "object", "title": "Goal Activity Segment", "description": "Used for segmenting based off of a subscriber's Goal activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalActivity", "enum": [ "GoalActivity" ] }, "field": { "type": "string", "enum": [ "goal" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's Goal activity.", "example": "goal" }, "op": { "type": "string", "enum": [ "is", "goal_not", "contains", "goal_notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The URL to check Goal activity against." } } }, { "type": "object", "title": "Goal Timestamp Segment", "description": "Used for segmenting based off of a subscriber's last interaction with a website.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalTimestamp", "enum": [ "GoalTimestamp" ] }, "field": { "type": "string", "enum": [ "goal_last_visited" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's last interaction with a website.", "example": "goal_last_visited" }, "op": { "type": "string", "enum": [ "greater", "less", "is" ], "title": "Segment Operator", "description": "Whether the website activity happened after, before, or at a given timestamp.", "example": "greater" }, "value": { "type": "string", "title": "Segment Value", "description": "The date to check Goal activity against.", "example": "2015-07-20 19:45:21" } } }, { "type": "object", "title": "Similar Subscribers Segment Member Segment", "description": "Used for segmenting by the similar subscribers segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "FuzzySegment", "enum": [ "FuzzySegment" ] }, "field": { "type": "string", "enum": [ "fuzzy_segment" ], "title": "Segment Field", "description": "Used for segmenting by the similar subscribers segment.", "example": "fuzzy_segment" }, "op": { "type": "string", "enum": [ "fuzzy_is", "fuzzy_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a 'similar subscribers' segment.", "example": "fuzzy_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the 'similar subscribers' segment.", "example": 48433 } } }, { "type": "object", "title": "Static Segment Member Segment", "description": "Used for segmenting by a given static segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "StaticSegment", "enum": [ "StaticSegment" ] }, "field": { "type": "string", "enum": [ "static_segment" ], "title": "Segment Field", "description": "Used for segmenting by a given static segment.", "example": "static_segment" }, "op": { "type": "string", "enum": [ "static_is", "static_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a static segment.", "example": "static_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the static segment.", "example": 48433 } } }, { "type": "object", "title": "Location-Based Segment", "description": "Used for segmenting members who are within a specific country or US state.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoCountryState", "enum": [ "IPGeoCountryState" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeocountry", "ipgeonotcountry", "ipgeostate", "ipgeonotstate" ], "title": "Segment Operator", "description": "Segment members who are within a specific country or US state.", "example": "ipgeocountry" }, "value": { "type": "string", "title": "Segment Data", "description": "The two-letter country code or US state abbreviation.", "example": "US" } } }, { "type": "object", "title": "Geolocation Segment", "description": "Used for segmenting members who are within a specific geographic region.", "required": [ "field", "op", "value", "addr", "lat", "lng" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoIn", "enum": [ "IPGeoIn" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoin", "ipgeonotin" ], "title": "Segment Operator", "description": "Segment members who are within a specific geographic region.", "example": "ipgeoin" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 42 }, "addr": { "type": "string", "title": "Segment Location Address", "description": "The address of the target location.", "example": "Atlanta, GA, USA" }, "lat": { "type": "string", "title": "Segment Location Latitude", "description": "The latitude of the target location.", "example": "33.7489954" }, "lng": { "type": "string", "title": "Segment Location Longitude", "description": "The longitude of the target location.", "example": "-84.3879824" } } }, { "type": "object", "title": "US Zip Code Segment", "description": "Used for segmenting members who are within a specific US zip code.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoInZip", "enum": [ "IPGeoInZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoinzip" ], "title": "Segment Operator", "description": "Segment members who are within a specific US zip code.", "example": "ipgeoinzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 25 }, "extra": { "type": "integer", "title": "Extra Data", "description": "The zip code to segment against.", "example": 30318 } } }, { "type": "object", "title": "Unknown Location-Based Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoUnknown", "enum": [ "IPGeoUnknown" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeounknown" ], "title": "Segment Operator", "description": "Segment members for which location information is unknown.", "example": "ipgeounknown" } } }, { "type": "object", "title": "Zip Code Location-Based Segment", "description": "Used for segmenting members who are/are not within a specific US zip code.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoZip", "enum": [ "IPGeoZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoiszip", "ipgeonotzip" ], "title": "Segment Operator", "description": "Segment members who are/are not within a specific US zip code.", "example": "ipgeonotzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The 5-digit zip code.", "example": 30318 } } }, { "type": "object", "title": "Social Profiles Age Segment", "description": "Used for segmenting members based age ranges in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialAge", "enum": [ "SocialAge" ] }, "field": { "type": "string", "enum": [ "social_age" ], "title": "Segment Field", "description": "Used for segmenting members based age ranges in Social Profiles data.", "example": "social_age" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-54", "55+" ], "title": "Segment Operator", "description": "The age range to segment.", "example": "35-54" } } }, { "type": "object", "title": "Social Profiles Gender Segment", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialGender", "enum": [ "SocialGender" ] }, "field": { "type": "string", "enum": [ "social_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "example": "social_gender" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The Social Profiles gender to segment.", "example": "female" } } }, { "type": "object", "title": "Social Profiles Influence Segment", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialInfluence", "enum": [ "SocialInfluence" ] }, "field": { "type": "string", "enum": [ "social_influence" ], "title": "Segment Field", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "example": "social_influence" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have a rating that is/not or greater/less than the rating provided.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The Social Profiles influence rating to segment.", "example": 2 } } }, { "type": "object", "title": "Social Profiles Social Network Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkMember", "enum": [ "SocialNetworkMember" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who are/not on a given social network.", "example": "member" }, "value": { "type": "string", "enum": [ "twitter", "facebook", "linkedin", "flickr", "foursquare", "lastfm", "myspace", "quora", "vimeo", "yelp", "youtube" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter" } } }, { "type": "object", "title": "Social Profiles Social Network Follow Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkFollow", "enum": [ "SocialNetworkFollow" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "follow", "notfollow" ], "title": "Segment Operator", "description": "Members who are/not following a linked account on a given social network.", "example": "follow" }, "value": { "type": "string", "enum": [ "twitter_follow" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter_follow" } } }, { "type": "object", "title": "Address Merge Field Segment", "description": "Used for segmenting by an address-type merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "AddressMerge", "enum": [ "AddressMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address-type merge field to segment.", "example": "MMERGE3" }, "op": { "type": "string", "enum": [ "contains", "notcontain", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's address merge field contains/does not contain a value or is/is not blank.", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Atlanta" } } }, { "type": "object", "title": "Address/Zip Merge Field Segment", "description": "Used for segmenting by an address-type merge field within a given distance.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "ZipMerge", "enum": [ "ZipMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address or zip-type merge field to segment.", "example": "MMERGE2" }, "op": { "type": "string", "enum": [ "geoin" ], "title": "Segment Operator", "description": "Whether the member's address merge field is within a given distance from a city or zip.", "example": "geoin" }, "value": { "type": "string", "title": "Segment Value", "description": "The distance from the city/zip.", "example": "25" }, "extra": { "type": "string", "title": "Segment Extra", "description": "The city or the zip being used to segment against.", "example": "30318" } } }, { "type": "object", "title": "Birthday Merge Field Segment", "description": "Used for segmenting by a contact's birthday.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "BirthdayMerge", "enum": [ "BirthdayMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE4" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against (mm/dd).", "example": "01/30" } } }, { "type": "object", "title": "Date Merge Field Segment", "description": "Used for segmenting by a given date merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "DateMerge", "enum": [ "DateMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE5" }, "op": { "type": "string", "enum": [ "is", "not", "less", "blank", "blank_not", "greater" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against.", "example": "01/30/2015" } } }, { "type": "object", "title": "Dropdown/Radio Merge Field Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "SelectMerge", "enum": [ "SelectMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A merge field to segment.", "example": "MMERGE6" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not", "notcontain", "contains" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Second Choice" } } }, { "type": "object", "title": "Text or Number Merge Field Segment", "description": "Used for segmenting by a given text or number merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "TextMerge", "enum": [ "TextMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A text or number merge field to segment.", "example": "MMERGE7" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text or number merge field with.", "example": "Freddie's Jokes" } } }, { "type": "object", "title": "Email Segment", "description": "Used for segmenting by the subscriber's email address.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailAddress", "enum": [ "EmailAddress" ] }, "field": { "type": "string", "enum": [ "merge0", "EMAIL" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's email address.", "example": "EMAIL" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less" ], "title": "Segment Operator", "description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string." }, "value": { "type": "string", "title": "Segment Value", "description": "The value to compare the email against.", "example": "urist.mcvankab@freddiesjokes.com" } } }, { "type": "object", "title": "Predicted Gender Segment", "description": "Used for segmenting members based on predicted gender.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedGender", "enum": [ "PredictedGender" ] }, "field": { "type": "string", "enum": [ "predicted_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted gender." }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The predicted gender to segment.", "example": "female" } } }, { "type": "object", "title": "Predicted Age Segment", "description": "Used for segmenting members based on predicted age", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedAge", "enum": [ "PredictedAge" ] }, "field": { "type": "string", "enum": [ "predicted_age_range" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted age" }, "op": { "type": "string", "enum": [ "is" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-44", "45-54", "55-64", "65+" ], "title": "Segment Operator", "description": "The predicted age to segment.", "example": "female" } } }, { "type": "object", "title": "New Subscribers Prebuilt Segment", "description": "Used for segmenting subscribers who have subscribed within a given time frame.", "properties": { "condition_type": { "type": "string", "x-value": "NewSubscribers", "enum": [ "NewSubscribers" ] }, "field": { "type": "string", "enum": [ "timestamp_opt" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have subscribed within a given time frame." }, "op": { "type": "string", "enum": [ "date_within" ], "title": "Segment Operator", "description": "Whe the event took place, namely within a time frame." }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." } } } ] } } } }, "store_id": { "type": "string", "title": "Store ID", "description": "The id of the store.", "example": "1a2df69xxx" } } }, "settings": { "type": "object", "title": "Automation Campaign Settings", "description": "The settings for the Automation workflow.", "properties": { "title": { "type": "string", "title": "Automation Title", "description": "The title of the Automation." }, "from_name": { "type": "string", "title": "From Name", "description": "The 'from' name for the Automation (not an email address)." }, "reply_to": { "type": "string", "title": "Reply To Address", "description": "The reply-to email address for the Automation." }, "use_conversation": { "type": "boolean", "title": "Conversations", "description": "Whether to use Mailchimp Conversation feature to manage replies" }, "to_name": { "type": "string", "title": "To Name", "description": "The Automation's custom 'To' name, typically the first name [merge field](https://mailchimp.com/help/getting-started-with-merge-tags/)." }, "authenticate": { "type": "boolean", "title": "Authentication", "description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`." }, "auto_footer": { "type": "boolean", "title": "Auto-Footer", "description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation." }, "inline_css": { "type": "boolean", "title": "Inline CSS", "description": "Whether to automatically inline the CSS included with the Automation content." } } }, "tracking": { "type": "object", "title": "Automation Tracking Options", "description": "The tracking options for the Automation.", "properties": { "opens": { "type": "boolean", "title": "Opens", "description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`." }, "html_clicks": { "type": "boolean", "title": "HTML Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`." }, "text_clicks": { "type": "boolean", "title": "Plain-Text Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`." }, "goal_tracking": { "type": "boolean", "title": "Mailchimp Goal Tracking", "description": "Deprecated" }, "ecomm360": { "type": "boolean", "title": "E-commerce Tracking", "description": "Whether to enable e-commerce tracking." }, "google_analytics": { "type": "string", "title": "Google Analytics Tracking", "description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)." }, "clicktale": { "type": "string", "title": "ClickTale Analytics Tracking", "description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)." }, "salesforce": { "type": "object", "title": "Salesforce CRM Tracking", "description": "Deprecated", "properties": { "campaign": { "type": "boolean", "title": "Salesforce Campaign", "description": "Create a campaign in a connected Salesforce account." }, "notes": { "type": "boolean", "title": "Salesforce Note", "description": "Update contact notes for a campaign based on a subscriber's email address." } } }, "capsule": { "type": "object", "title": "Capsule CRM Tracking", "description": "Deprecated", "properties": { "notes": { "type": "boolean", "title": "Capsule Note", "description": "Update contact notes for a campaign based on a subscriber's email addresses." } } } } }, "trigger_settings": { "type": "object", "title": "Automation Trigger", "description": "Available triggers for Automation workflows.", "discriminator": "workflow_type", "required": [ "workflow_type" ], "properties": { "workflow_type": { "type": "string", "title": "Workflow Type", "description": "The type of Automation workflow.", "enum": [ "abandonedBrowse", "abandonedCart", "api", "bestCustomers", "categoryFollowup", "dateAdded", "emailFollowup", "emailSeries", "groupAdd", "groupRemove", "mandrill", "productFollowup", "purchaseFollowup", "recurringEvent", "specialEvent", "visitUrl", "welcomeSeries" ] }, "workflow_title": { "type": "string", "title": "Workflow Title", "description": "The title of the workflow type.", "readOnly": true }, "runtime": { "type": "object", "title": "Automation Workflow Runtime Settings", "description": "A workflow's runtime settings for an Automation.", "properties": { "days": { "type": "array", "title": "Days", "description": "The days an Automation workflow can send.", "items": { "type": "string", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ] } }, "hours": { "type": "object", "title": "Hours", "description": "The hours an Automation workflow can send.", "required": [ "type" ], "properties": { "type": { "type": "string", "title": "Email Send Time Settings", "description": "When to send the Automation email.", "enum": [ "send_asap", "send_between", "send_at" ] } } } } }, "workflow_emails_count": { "type": "integer", "title": "Workflow Emails Count", "description": "The number of emails in the Automation workflow.", "readOnly": true } } }, "report_summary": { "type": "object", "title": "Campaign Report Summary", "description": "A summary of opens and clicks for sent campaigns.", "properties": { "opens": { "type": "integer", "title": "Automation Opens", "description": "The total number of opens for a campaign.", "readOnly": true }, "unique_opens": { "type": "integer", "title": "Unique Opens", "description": "The number of unique opens.", "readOnly": true }, "open_rate": { "type": "number", "title": "Open Rate", "description": "The number of unique opens divided by the total number of successful deliveries.", "readOnly": true }, "clicks": { "type": "integer", "title": "Total Clicks", "description": "The total number of clicks for an campaign.", "readOnly": true }, "subscriber_clicks": { "type": "integer", "title": "Unique Subscriber Clicks", "description": "The number of unique clicks.", "readOnly": true }, "click_rate": { "type": "number", "title": "Click Rate", "description": "The number of unique clicks, divided by the total number of successful deliveries.", "readOnly": true } } }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } }, "title": "Automation Workflows", "description": "An array of objects, each representing an Automation workflow." }, "total_items": { "type": "integer", "title": "Item Count", "description": "The total number of items matching the query regardless of pagination.", "readOnly": true }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "automations" ], "x-custom-config": { "methodNameSnake": "list", "methodNameCamel": "list" } }, "post": { "summary": "Add automation", "description": "Create a new classic automation in your Mailchimp account.", "operationId": "postAutomations", "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "type": "object", "title": "Automation Workflow", "description": "A summary of an individual Automation workflow's settings and content.", "required": [ "recipients", "trigger_settings" ], "properties": { "recipients": { "type": "object", "title": "List", "description": "List settings for the Automation.", "properties": { "list_id": { "type": "string", "title": "List ID", "description": "The id of the List.", "example": "1a2df69xxx" }, "store_id": { "type": "string", "title": "Store ID", "description": "The id of the store.", "example": "1a2df69xxx" } } }, "settings": { "type": "object", "title": "Automation Campaign Settings", "description": "The settings for the Automation workflow.", "properties": { "from_name": { "type": "string", "title": "From Name", "description": "The 'from' name for the Automation (not an email address)." }, "reply_to": { "type": "string", "title": "Reply To Address", "description": "The reply-to email address for the Automation." } } }, "trigger_settings": { "type": "object", "title": "Automation Trigger", "description": "Trigger settings for the Automation.", "required": [ "workflow_type" ], "properties": { "workflow_type": { "type": "string", "title": "Workflow Type", "description": "The type of Automation workflow. Currently only supports 'abandonedCart'." } } } } } } ], "responses": { "200": { "description": "", "schema": { "type": "object", "title": "Automation Workflow", "description": "A summary of an individual Automation workflow's settings and content.", "properties": { "id": { "type": "string", "title": "Automation Campaign ID", "description": "A string that identifies the Automation.", "readOnly": true }, "create_time": { "type": "string", "title": "Create Time", "format": "date-time", "description": "The date and time the Automation was created in ISO 8601 format.", "readOnly": true }, "start_time": { "type": "string", "title": "Start Time", "format": "date-time", "description": "The date and time the Automation was started in ISO 8601 format.", "readOnly": true }, "status": { "type": "string", "title": "Automation Status", "description": "The current status of the Automation.", "enum": [ "save", "paused", "sending" ], "readOnly": true }, "emails_sent": { "type": "integer", "title": "Emails Sent", "description": "The total number of emails sent for the Automation.", "readOnly": true }, "recipients": { "type": "object", "title": "List", "description": "List settings for the Automation.", "properties": { "list_id": { "type": "string", "title": "List ID", "description": "The unique list id." }, "list_is_active": { "type": "boolean", "title": "List Status", "description": "The status of the list used, namely if it's deleted or disabled.", "readOnly": true }, "list_name": { "type": "string", "title": "List Name", "description": "List Name." }, "segment_opts": { "type": "object", "title": "Segment Options", "description": "An object representing all segmentation options.", "properties": { "saved_segment_id": { "type": "integer", "title": "Saved Segment ID", "description": "The id for an existing saved segment." }, "match": { "type": "string", "title": "Match Type", "description": "Segment match type.", "enum": [ "any", "all" ] }, "conditions": { "type": "array", "title": "Segment Type", "description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).", "items": { "x-discriminator": { "type": "string", "propertyName": "condition_type" }, "x-oneOf": [ { "type": "object", "title": "Aim Segment", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "properties": { "condition_type": { "type": "string", "x-value": "Aim", "enum": [ "Aim" ] }, "field": { "type": "string", "enum": [ "aim" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "example": "aim" }, "op": { "type": "string", "enum": [ "open", "click", "sent", "noopen", "noclick", "nosent" ], "title": "Segment Operator", "description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent.", "example": "open" }, "value": { "type": "string", "title": "Segment Data", "description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Automation Segment", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Automation", "enum": [ "Automation" ] }, "field": { "type": "string", "enum": [ "automation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "example": "automation" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.", "example": "started" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id for the automation workflow to segment against.", "example": "2135217" } } }, { "type": "object", "title": "Poll Activity Segment", "description": "Used for segmenting by poll activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "CampaignPoll", "enum": [ "CampaignPoll" ] }, "field": { "type": "string", "enum": [ "poll" ], "title": "Segment Field", "description": "Used for segmenting by poll activity.", "example": "poll" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members have/have not interacted with a specific poll in a Mailchimp email.", "example": "member" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the poll.", "example": 409 } } }, { "type": "object", "title": "Conversation Segment", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Conversation", "enum": [ "Conversation" ] }, "field": { "type": "string", "enum": [ "conversation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "example": "conversation" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied.", "example": "member" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Date Segment", "description": "Used for segmenting by a specific date field.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Date", "enum": [ "Date" ] }, "field": { "type": "string", "enum": [ "timestamp_opt", "info_changed", "ecomm_date" ], "title": "Segment Field", "description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.", "example": "timestamp_opt" }, "op": { "type": "string", "enum": [ "greater", "less", "is", "not", "blank", "blank_not", "within", "notwithin" ], "title": "Segment Operator", "description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.", "example": "greater" }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.", "example": "date" }, "extra": { "type": "string", "title": "Segment Extra Value", "description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.", "example": "2015-01-30" } } }, { "type": "object", "title": "Email Client Segment", "description": "Used for segmenting subscribers who are using a particular email client.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailClient", "enum": [ "EmailClient" ] }, "field": { "type": "string", "enum": [ "email_client" ], "title": "Segment Field", "description": "Used for segmenting subscribers who are using a particular email client.", "example": "email_client" }, "op": { "type": "string", "enum": [ "client_is", "client_not" ], "title": "Segment Operator", "description": "The operation to determine whether we select clients that match the value, or clients that do not match the value.", "example": "client_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The name of the email client.", "example": "Gmail" } } }, { "type": "object", "title": "Language Segment", "description": "Used for segmenting based off of a subscriber's language.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Language", "enum": [ "Language" ] }, "field": { "type": "string", "enum": [ "language" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's language.", "example": "language" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Whether the member's language is or is not set to a specific language.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "A two-letter language identifier.", "example": "en" } } }, { "type": "object", "title": "Member Rating Segment", "description": "Used for segmenting by member rating.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "MemberRating", "enum": [ "MemberRating" ] }, "field": { "type": "string", "enum": [ "rating" ], "title": "Segment Field", "description": "Used for segmenting by member rating.", "example": "rating" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The star rating number to segment against.", "example": 4 } } }, { "type": "object", "title": "Signup Source Segment", "description": "Used for segmenting by the signup source.", "required": [ "field", "condition_type", "op" ], "properties": { "condition_type": { "type": "string", "enum": [ "SignupSource" ], "x-value": "SignupSource", "title": "Type" }, "field": { "type": "string", "enum": [ "source" ], "title": "Segment Field", "example": "source" }, "op": { "type": "string", "enum": [ "source_is", "source_not" ], "title": "Segment Operator", "description": "Whether the member's signup source was/was not a particular value.", "example": "source_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The signup source.", "example": "List Import" } } }, { "type": "object", "title": "Survey Monkey Segment", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SurveyMonkey", "enum": [ "SurveyMonkey" ] }, "field": { "type": "string", "enum": [ "survey_monkey" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "example": "survey_monkey" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.", "example": "started" }, "value": { "type": "string", "title": "Survey ID", "description": "The unique ID of the survey monkey survey.", "example": "32179586" } } }, { "type": "object", "title": "VIP Segment", "description": "Used for segmenting based off of a subscriber's VIP status.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "VIP", "enum": [ "VIP" ] }, "field": { "type": "string", "enum": [ "gmonkey" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's VIP status.", "example": "gmonkey" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Whether the member is or is not marked as VIP.", "example": "member" } } }, { "type": "object", "title": "Interests Segment", "description": "Used for segmenting by a given interest group merge field.", "properties": { "condition_type": { "type": "string", "x-value": "Interests", "enum": [ "Interests" ] }, "field": { "type": "string", "title": "Segment Field", "description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'.", "example": "interests-123" }, "op": { "type": "string", "enum": [ "interestcontains", "interestcontainsall", "interestnotcontains" ], "title": "Segment Operator", "description": "Whether the member is a part of one, all, or none of the groups.", "example": "interestcontains" }, "value": { "type": "array", "title": "Segment Value", "description": "An array containing strings, each representing a group id.", "items": { "type": "string", "example": [ "44401", "44405", "44409" ] } } } }, { "type": "object", "title": "Ecommerce Category Segment", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "properties": { "condition_type": { "type": "string", "x-value": "EcommCategory", "enum": [ "EcommCategory" ] }, "field": { "type": "string", "enum": [ "ecomm_cat", "ecomm_prod" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "example": "ecomm_cat" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "The ecommerce category/item information.", "example": "Product" } } }, { "type": "object", "title": "Ecommerce Number Segment", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EcommNumber", "enum": [ "EcommNumber" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_avg", "ecomm_orders", "ecomm_prod_all", "ecomm_avg_ord" ], "title": "Segment Field", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "example": "ecomm_orders" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Segment", "description": "Used for segmenting members who have/have not purchased anything.", "properties": { "condition_type": { "type": "string", "x-value": "EcommPurchased", "enum": [ "EcommPurchased" ] }, "field": { "type": "string", "enum": [ "ecomm_purchased" ], "title": "Segment Field", "description": "Used for segmenting members who have/have not purchased anything.", "example": "ecomm_purchased" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who have have ('member') or have not ('notmember') purchased.", "example": "member" } } }, { "type": "object", "title": "Ecommerce Spent Segment", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "properties": { "condition_type": { "type": "string", "x-value": "EcommSpent", "enum": [ "EcommSpent" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_one", "ecomm_spent_all" ], "title": "Segment Field", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "example": "ecomm_spent_one" }, "op": { "type": "string", "enum": [ "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent 'more' or 'less' than then specified value.", "example": "greater" }, "value": { "type": "integer", "title": "Segment Data", "description": "The total amount a member spent.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Store Segment", "description": "Used for segmenting members have purchased from a specific store.", "properties": { "condition_type": { "type": "string", "x-value": "EcommStore", "enum": [ "EcommStore" ] }, "field": { "type": "string", "enum": [ "ecomm_store" ], "title": "Segment Field", "description": "Used for segmenting members have purchased from a specific store.", "example": "ecomm_store" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who have or have not purchased from a specific store.", "example": "is" }, "value": { "type": "string", "title": "Segment Operator", "description": "The store id to segment against.", "example": "289" } } }, { "type": "object", "title": "Goal Activity Segment", "description": "Used for segmenting based off of a subscriber's Goal activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalActivity", "enum": [ "GoalActivity" ] }, "field": { "type": "string", "enum": [ "goal" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's Goal activity.", "example": "goal" }, "op": { "type": "string", "enum": [ "is", "goal_not", "contains", "goal_notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The URL to check Goal activity against." } } }, { "type": "object", "title": "Goal Timestamp Segment", "description": "Used for segmenting based off of a subscriber's last interaction with a website.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalTimestamp", "enum": [ "GoalTimestamp" ] }, "field": { "type": "string", "enum": [ "goal_last_visited" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's last interaction with a website.", "example": "goal_last_visited" }, "op": { "type": "string", "enum": [ "greater", "less", "is" ], "title": "Segment Operator", "description": "Whether the website activity happened after, before, or at a given timestamp.", "example": "greater" }, "value": { "type": "string", "title": "Segment Value", "description": "The date to check Goal activity against.", "example": "2015-07-20 19:45:21" } } }, { "type": "object", "title": "Similar Subscribers Segment Member Segment", "description": "Used for segmenting by the similar subscribers segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "FuzzySegment", "enum": [ "FuzzySegment" ] }, "field": { "type": "string", "enum": [ "fuzzy_segment" ], "title": "Segment Field", "description": "Used for segmenting by the similar subscribers segment.", "example": "fuzzy_segment" }, "op": { "type": "string", "enum": [ "fuzzy_is", "fuzzy_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a 'similar subscribers' segment.", "example": "fuzzy_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the 'similar subscribers' segment.", "example": 48433 } } }, { "type": "object", "title": "Static Segment Member Segment", "description": "Used for segmenting by a given static segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "StaticSegment", "enum": [ "StaticSegment" ] }, "field": { "type": "string", "enum": [ "static_segment" ], "title": "Segment Field", "description": "Used for segmenting by a given static segment.", "example": "static_segment" }, "op": { "type": "string", "enum": [ "static_is", "static_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a static segment.", "example": "static_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the static segment.", "example": 48433 } } }, { "type": "object", "title": "Location-Based Segment", "description": "Used for segmenting members who are within a specific country or US state.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoCountryState", "enum": [ "IPGeoCountryState" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeocountry", "ipgeonotcountry", "ipgeostate", "ipgeonotstate" ], "title": "Segment Operator", "description": "Segment members who are within a specific country or US state.", "example": "ipgeocountry" }, "value": { "type": "string", "title": "Segment Data", "description": "The two-letter country code or US state abbreviation.", "example": "US" } } }, { "type": "object", "title": "Geolocation Segment", "description": "Used for segmenting members who are within a specific geographic region.", "required": [ "field", "op", "value", "addr", "lat", "lng" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoIn", "enum": [ "IPGeoIn" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoin", "ipgeonotin" ], "title": "Segment Operator", "description": "Segment members who are within a specific geographic region.", "example": "ipgeoin" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 42 }, "addr": { "type": "string", "title": "Segment Location Address", "description": "The address of the target location.", "example": "Atlanta, GA, USA" }, "lat": { "type": "string", "title": "Segment Location Latitude", "description": "The latitude of the target location.", "example": "33.7489954" }, "lng": { "type": "string", "title": "Segment Location Longitude", "description": "The longitude of the target location.", "example": "-84.3879824" } } }, { "type": "object", "title": "US Zip Code Segment", "description": "Used for segmenting members who are within a specific US zip code.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoInZip", "enum": [ "IPGeoInZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoinzip" ], "title": "Segment Operator", "description": "Segment members who are within a specific US zip code.", "example": "ipgeoinzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 25 }, "extra": { "type": "integer", "title": "Extra Data", "description": "The zip code to segment against.", "example": 30318 } } }, { "type": "object", "title": "Unknown Location-Based Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoUnknown", "enum": [ "IPGeoUnknown" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeounknown" ], "title": "Segment Operator", "description": "Segment members for which location information is unknown.", "example": "ipgeounknown" } } }, { "type": "object", "title": "Zip Code Location-Based Segment", "description": "Used for segmenting members who are/are not within a specific US zip code.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoZip", "enum": [ "IPGeoZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoiszip", "ipgeonotzip" ], "title": "Segment Operator", "description": "Segment members who are/are not within a specific US zip code.", "example": "ipgeonotzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The 5-digit zip code.", "example": 30318 } } }, { "type": "object", "title": "Social Profiles Age Segment", "description": "Used for segmenting members based age ranges in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialAge", "enum": [ "SocialAge" ] }, "field": { "type": "string", "enum": [ "social_age" ], "title": "Segment Field", "description": "Used for segmenting members based age ranges in Social Profiles data.", "example": "social_age" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-54", "55+" ], "title": "Segment Operator", "description": "The age range to segment.", "example": "35-54" } } }, { "type": "object", "title": "Social Profiles Gender Segment", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialGender", "enum": [ "SocialGender" ] }, "field": { "type": "string", "enum": [ "social_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "example": "social_gender" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The Social Profiles gender to segment.", "example": "female" } } }, { "type": "object", "title": "Social Profiles Influence Segment", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialInfluence", "enum": [ "SocialInfluence" ] }, "field": { "type": "string", "enum": [ "social_influence" ], "title": "Segment Field", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "example": "social_influence" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have a rating that is/not or greater/less than the rating provided.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The Social Profiles influence rating to segment.", "example": 2 } } }, { "type": "object", "title": "Social Profiles Social Network Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkMember", "enum": [ "SocialNetworkMember" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who are/not on a given social network.", "example": "member" }, "value": { "type": "string", "enum": [ "twitter", "facebook", "linkedin", "flickr", "foursquare", "lastfm", "myspace", "quora", "vimeo", "yelp", "youtube" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter" } } }, { "type": "object", "title": "Social Profiles Social Network Follow Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkFollow", "enum": [ "SocialNetworkFollow" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "follow", "notfollow" ], "title": "Segment Operator", "description": "Members who are/not following a linked account on a given social network.", "example": "follow" }, "value": { "type": "string", "enum": [ "twitter_follow" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter_follow" } } }, { "type": "object", "title": "Address Merge Field Segment", "description": "Used for segmenting by an address-type merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "AddressMerge", "enum": [ "AddressMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address-type merge field to segment.", "example": "MMERGE3" }, "op": { "type": "string", "enum": [ "contains", "notcontain", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's address merge field contains/does not contain a value or is/is not blank.", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Atlanta" } } }, { "type": "object", "title": "Address/Zip Merge Field Segment", "description": "Used for segmenting by an address-type merge field within a given distance.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "ZipMerge", "enum": [ "ZipMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address or zip-type merge field to segment.", "example": "MMERGE2" }, "op": { "type": "string", "enum": [ "geoin" ], "title": "Segment Operator", "description": "Whether the member's address merge field is within a given distance from a city or zip.", "example": "geoin" }, "value": { "type": "string", "title": "Segment Value", "description": "The distance from the city/zip.", "example": "25" }, "extra": { "type": "string", "title": "Segment Extra", "description": "The city or the zip being used to segment against.", "example": "30318" } } }, { "type": "object", "title": "Birthday Merge Field Segment", "description": "Used for segmenting by a contact's birthday.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "BirthdayMerge", "enum": [ "BirthdayMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE4" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against (mm/dd).", "example": "01/30" } } }, { "type": "object", "title": "Date Merge Field Segment", "description": "Used for segmenting by a given date merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "DateMerge", "enum": [ "DateMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE5" }, "op": { "type": "string", "enum": [ "is", "not", "less", "blank", "blank_not", "greater" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against.", "example": "01/30/2015" } } }, { "type": "object", "title": "Dropdown/Radio Merge Field Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "SelectMerge", "enum": [ "SelectMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A merge field to segment.", "example": "MMERGE6" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not", "notcontain", "contains" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Second Choice" } } }, { "type": "object", "title": "Text or Number Merge Field Segment", "description": "Used for segmenting by a given text or number merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "TextMerge", "enum": [ "TextMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A text or number merge field to segment.", "example": "MMERGE7" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text or number merge field with.", "example": "Freddie's Jokes" } } }, { "type": "object", "title": "Email Segment", "description": "Used for segmenting by the subscriber's email address.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailAddress", "enum": [ "EmailAddress" ] }, "field": { "type": "string", "enum": [ "merge0", "EMAIL" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's email address.", "example": "EMAIL" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less" ], "title": "Segment Operator", "description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string." }, "value": { "type": "string", "title": "Segment Value", "description": "The value to compare the email against.", "example": "urist.mcvankab@freddiesjokes.com" } } }, { "type": "object", "title": "Predicted Gender Segment", "description": "Used for segmenting members based on predicted gender.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedGender", "enum": [ "PredictedGender" ] }, "field": { "type": "string", "enum": [ "predicted_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted gender." }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The predicted gender to segment.", "example": "female" } } }, { "type": "object", "title": "Predicted Age Segment", "description": "Used for segmenting members based on predicted age", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedAge", "enum": [ "PredictedAge" ] }, "field": { "type": "string", "enum": [ "predicted_age_range" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted age" }, "op": { "type": "string", "enum": [ "is" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-44", "45-54", "55-64", "65+" ], "title": "Segment Operator", "description": "The predicted age to segment.", "example": "female" } } }, { "type": "object", "title": "New Subscribers Prebuilt Segment", "description": "Used for segmenting subscribers who have subscribed within a given time frame.", "properties": { "condition_type": { "type": "string", "x-value": "NewSubscribers", "enum": [ "NewSubscribers" ] }, "field": { "type": "string", "enum": [ "timestamp_opt" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have subscribed within a given time frame." }, "op": { "type": "string", "enum": [ "date_within" ], "title": "Segment Operator", "description": "Whe the event took place, namely within a time frame." }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." } } } ] } } } }, "store_id": { "type": "string", "title": "Store ID", "description": "The id of the store.", "example": "1a2df69xxx" } } }, "settings": { "type": "object", "title": "Automation Campaign Settings", "description": "The settings for the Automation workflow.", "properties": { "title": { "type": "string", "title": "Automation Title", "description": "The title of the Automation." }, "from_name": { "type": "string", "title": "From Name", "description": "The 'from' name for the Automation (not an email address)." }, "reply_to": { "type": "string", "title": "Reply To Address", "description": "The reply-to email address for the Automation." }, "use_conversation": { "type": "boolean", "title": "Conversations", "description": "Whether to use Mailchimp Conversation feature to manage replies" }, "to_name": { "type": "string", "title": "To Name", "description": "The Automation's custom 'To' name, typically the first name [merge field](https://mailchimp.com/help/getting-started-with-merge-tags/)." }, "authenticate": { "type": "boolean", "title": "Authentication", "description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`." }, "auto_footer": { "type": "boolean", "title": "Auto-Footer", "description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation." }, "inline_css": { "type": "boolean", "title": "Inline CSS", "description": "Whether to automatically inline the CSS included with the Automation content." } } }, "tracking": { "type": "object", "title": "Automation Tracking Options", "description": "The tracking options for the Automation.", "properties": { "opens": { "type": "boolean", "title": "Opens", "description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`." }, "html_clicks": { "type": "boolean", "title": "HTML Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`." }, "text_clicks": { "type": "boolean", "title": "Plain-Text Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`." }, "goal_tracking": { "type": "boolean", "title": "Mailchimp Goal Tracking", "description": "Deprecated" }, "ecomm360": { "type": "boolean", "title": "E-commerce Tracking", "description": "Whether to enable e-commerce tracking." }, "google_analytics": { "type": "string", "title": "Google Analytics Tracking", "description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)." }, "clicktale": { "type": "string", "title": "ClickTale Analytics Tracking", "description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)." }, "salesforce": { "type": "object", "title": "Salesforce CRM Tracking", "description": "Deprecated", "properties": { "campaign": { "type": "boolean", "title": "Salesforce Campaign", "description": "Create a campaign in a connected Salesforce account." }, "notes": { "type": "boolean", "title": "Salesforce Note", "description": "Update contact notes for a campaign based on a subscriber's email address." } } }, "capsule": { "type": "object", "title": "Capsule CRM Tracking", "description": "Deprecated", "properties": { "notes": { "type": "boolean", "title": "Capsule Note", "description": "Update contact notes for a campaign based on a subscriber's email addresses." } } } } }, "trigger_settings": { "type": "object", "title": "Automation Trigger", "description": "Available triggers for Automation workflows.", "discriminator": "workflow_type", "required": [ "workflow_type" ], "properties": { "workflow_type": { "type": "string", "title": "Workflow Type", "description": "The type of Automation workflow.", "enum": [ "abandonedBrowse", "abandonedCart", "api", "bestCustomers", "categoryFollowup", "dateAdded", "emailFollowup", "emailSeries", "groupAdd", "groupRemove", "mandrill", "productFollowup", "purchaseFollowup", "recurringEvent", "specialEvent", "visitUrl", "welcomeSeries" ] }, "workflow_title": { "type": "string", "title": "Workflow Title", "description": "The title of the workflow type.", "readOnly": true }, "runtime": { "type": "object", "title": "Automation Workflow Runtime Settings", "description": "A workflow's runtime settings for an Automation.", "properties": { "days": { "type": "array", "title": "Days", "description": "The days an Automation workflow can send.", "items": { "type": "string", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ] } }, "hours": { "type": "object", "title": "Hours", "description": "The hours an Automation workflow can send.", "required": [ "type" ], "properties": { "type": { "type": "string", "title": "Email Send Time Settings", "description": "When to send the Automation email.", "enum": [ "send_asap", "send_between", "send_at" ] } } } } }, "workflow_emails_count": { "type": "integer", "title": "Workflow Emails Count", "description": "The number of emails in the Automation workflow.", "readOnly": true } } }, "report_summary": { "type": "object", "title": "Campaign Report Summary", "description": "A summary of opens and clicks for sent campaigns.", "properties": { "opens": { "type": "integer", "title": "Automation Opens", "description": "The total number of opens for a campaign.", "readOnly": true }, "unique_opens": { "type": "integer", "title": "Unique Opens", "description": "The number of unique opens.", "readOnly": true }, "open_rate": { "type": "number", "title": "Open Rate", "description": "The number of unique opens divided by the total number of successful deliveries.", "readOnly": true }, "clicks": { "type": "integer", "title": "Total Clicks", "description": "The total number of clicks for an campaign.", "readOnly": true }, "subscriber_clicks": { "type": "integer", "title": "Unique Subscriber Clicks", "description": "The number of unique clicks.", "readOnly": true }, "click_rate": { "type": "number", "title": "Click Rate", "description": "The number of unique clicks, divided by the total number of successful deliveries.", "readOnly": true } } }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "automations" ], "x-custom-config": { "methodNameSnake": "create", "methodNameCamel": "create" } } }, "/automations/{workflow_id}": { "get": { "summary": "Get automation info", "description": "Get a summary of an individual classic automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow.", "operationId": "getAutomationsId", "parameters": [ { "name": "fields", "x-title": "Fields", "in": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "name": "exclude_fields", "x-title": "Exclude Fields", "in": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", "required": false, "type": "array", "collectionFormat": "csv", "items": { "type": "string" } }, { "in": "path", "name": "workflow_id", "type": "string", "required": true, "description": "The unique id for the Automation workflow." } ], "responses": { "200": { "description": "", "schema": { "type": "object", "title": "Automation Workflow", "description": "A summary of an individual Automation workflow's settings and content.", "properties": { "id": { "type": "string", "title": "Automation Campaign ID", "description": "A string that identifies the Automation.", "readOnly": true }, "create_time": { "type": "string", "title": "Create Time", "format": "date-time", "description": "The date and time the Automation was created in ISO 8601 format.", "readOnly": true }, "start_time": { "type": "string", "title": "Start Time", "format": "date-time", "description": "The date and time the Automation was started in ISO 8601 format.", "readOnly": true }, "status": { "type": "string", "title": "Automation Status", "description": "The current status of the Automation.", "enum": [ "save", "paused", "sending" ], "readOnly": true }, "emails_sent": { "type": "integer", "title": "Emails Sent", "description": "The total number of emails sent for the Automation.", "readOnly": true }, "recipients": { "type": "object", "title": "List", "description": "List settings for the Automation.", "properties": { "list_id": { "type": "string", "title": "List ID", "description": "The unique list id." }, "list_is_active": { "type": "boolean", "title": "List Status", "description": "The status of the list used, namely if it's deleted or disabled.", "readOnly": true }, "list_name": { "type": "string", "title": "List Name", "description": "List Name." }, "segment_opts": { "type": "object", "title": "Segment Options", "description": "An object representing all segmentation options.", "properties": { "saved_segment_id": { "type": "integer", "title": "Saved Segment ID", "description": "The id for an existing saved segment." }, "match": { "type": "string", "title": "Match Type", "description": "Segment match type.", "enum": [ "any", "all" ] }, "conditions": { "type": "array", "title": "Segment Type", "description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).", "items": { "x-discriminator": { "type": "string", "propertyName": "condition_type" }, "x-oneOf": [ { "type": "object", "title": "Aim Segment", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "properties": { "condition_type": { "type": "string", "x-value": "Aim", "enum": [ "Aim" ] }, "field": { "type": "string", "enum": [ "aim" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "example": "aim" }, "op": { "type": "string", "enum": [ "open", "click", "sent", "noopen", "noclick", "nosent" ], "title": "Segment Operator", "description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent.", "example": "open" }, "value": { "type": "string", "title": "Segment Data", "description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Automation Segment", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Automation", "enum": [ "Automation" ] }, "field": { "type": "string", "enum": [ "automation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "example": "automation" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.", "example": "started" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id for the automation workflow to segment against.", "example": "2135217" } } }, { "type": "object", "title": "Poll Activity Segment", "description": "Used for segmenting by poll activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "CampaignPoll", "enum": [ "CampaignPoll" ] }, "field": { "type": "string", "enum": [ "poll" ], "title": "Segment Field", "description": "Used for segmenting by poll activity.", "example": "poll" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members have/have not interacted with a specific poll in a Mailchimp email.", "example": "member" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the poll.", "example": 409 } } }, { "type": "object", "title": "Conversation Segment", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Conversation", "enum": [ "Conversation" ] }, "field": { "type": "string", "enum": [ "conversation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "example": "conversation" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied.", "example": "member" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Date Segment", "description": "Used for segmenting by a specific date field.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Date", "enum": [ "Date" ] }, "field": { "type": "string", "enum": [ "timestamp_opt", "info_changed", "ecomm_date" ], "title": "Segment Field", "description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.", "example": "timestamp_opt" }, "op": { "type": "string", "enum": [ "greater", "less", "is", "not", "blank", "blank_not", "within", "notwithin" ], "title": "Segment Operator", "description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.", "example": "greater" }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.", "example": "date" }, "extra": { "type": "string", "title": "Segment Extra Value", "description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.", "example": "2015-01-30" } } }, { "type": "object", "title": "Email Client Segment", "description": "Used for segmenting subscribers who are using a particular email client.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailClient", "enum": [ "EmailClient" ] }, "field": { "type": "string", "enum": [ "email_client" ], "title": "Segment Field", "description": "Used for segmenting subscribers who are using a particular email client.", "example": "email_client" }, "op": { "type": "string", "enum": [ "client_is", "client_not" ], "title": "Segment Operator", "description": "The operation to determine whether we select clients that match the value, or clients that do not match the value.", "example": "client_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The name of the email client.", "example": "Gmail" } } }, { "type": "object", "title": "Language Segment", "description": "Used for segmenting based off of a subscriber's language.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Language", "enum": [ "Language" ] }, "field": { "type": "string", "enum": [ "language" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's language.", "example": "language" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Whether the member's language is or is not set to a specific language.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "A two-letter language identifier.", "example": "en" } } }, { "type": "object", "title": "Member Rating Segment", "description": "Used for segmenting by member rating.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "MemberRating", "enum": [ "MemberRating" ] }, "field": { "type": "string", "enum": [ "rating" ], "title": "Segment Field", "description": "Used for segmenting by member rating.", "example": "rating" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The star rating number to segment against.", "example": 4 } } }, { "type": "object", "title": "Signup Source Segment", "description": "Used for segmenting by the signup source.", "required": [ "field", "condition_type", "op" ], "properties": { "condition_type": { "type": "string", "enum": [ "SignupSource" ], "x-value": "SignupSource", "title": "Type" }, "field": { "type": "string", "enum": [ "source" ], "title": "Segment Field", "example": "source" }, "op": { "type": "string", "enum": [ "source_is", "source_not" ], "title": "Segment Operator", "description": "Whether the member's signup source was/was not a particular value.", "example": "source_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The signup source.", "example": "List Import" } } }, { "type": "object", "title": "Survey Monkey Segment", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SurveyMonkey", "enum": [ "SurveyMonkey" ] }, "field": { "type": "string", "enum": [ "survey_monkey" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "example": "survey_monkey" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.", "example": "started" }, "value": { "type": "string", "title": "Survey ID", "description": "The unique ID of the survey monkey survey.", "example": "32179586" } } }, { "type": "object", "title": "VIP Segment", "description": "Used for segmenting based off of a subscriber's VIP status.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "VIP", "enum": [ "VIP" ] }, "field": { "type": "string", "enum": [ "gmonkey" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's VIP status.", "example": "gmonkey" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Whether the member is or is not marked as VIP.", "example": "member" } } }, { "type": "object", "title": "Interests Segment", "description": "Used for segmenting by a given interest group merge field.", "properties": { "condition_type": { "type": "string", "x-value": "Interests", "enum": [ "Interests" ] }, "field": { "type": "string", "title": "Segment Field", "description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'.", "example": "interests-123" }, "op": { "type": "string", "enum": [ "interestcontains", "interestcontainsall", "interestnotcontains" ], "title": "Segment Operator", "description": "Whether the member is a part of one, all, or none of the groups.", "example": "interestcontains" }, "value": { "type": "array", "title": "Segment Value", "description": "An array containing strings, each representing a group id.", "items": { "type": "string", "example": [ "44401", "44405", "44409" ] } } } }, { "type": "object", "title": "Ecommerce Category Segment", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "properties": { "condition_type": { "type": "string", "x-value": "EcommCategory", "enum": [ "EcommCategory" ] }, "field": { "type": "string", "enum": [ "ecomm_cat", "ecomm_prod" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "example": "ecomm_cat" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "The ecommerce category/item information.", "example": "Product" } } }, { "type": "object", "title": "Ecommerce Number Segment", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EcommNumber", "enum": [ "EcommNumber" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_avg", "ecomm_orders", "ecomm_prod_all", "ecomm_avg_ord" ], "title": "Segment Field", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "example": "ecomm_orders" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Segment", "description": "Used for segmenting members who have/have not purchased anything.", "properties": { "condition_type": { "type": "string", "x-value": "EcommPurchased", "enum": [ "EcommPurchased" ] }, "field": { "type": "string", "enum": [ "ecomm_purchased" ], "title": "Segment Field", "description": "Used for segmenting members who have/have not purchased anything.", "example": "ecomm_purchased" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who have have ('member') or have not ('notmember') purchased.", "example": "member" } } }, { "type": "object", "title": "Ecommerce Spent Segment", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "properties": { "condition_type": { "type": "string", "x-value": "EcommSpent", "enum": [ "EcommSpent" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_one", "ecomm_spent_all" ], "title": "Segment Field", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "example": "ecomm_spent_one" }, "op": { "type": "string", "enum": [ "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent 'more' or 'less' than then specified value.", "example": "greater" }, "value": { "type": "integer", "title": "Segment Data", "description": "The total amount a member spent.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Store Segment", "description": "Used for segmenting members have purchased from a specific store.", "properties": { "condition_type": { "type": "string", "x-value": "EcommStore", "enum": [ "EcommStore" ] }, "field": { "type": "string", "enum": [ "ecomm_store" ], "title": "Segment Field", "description": "Used for segmenting members have purchased from a specific store.", "example": "ecomm_store" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who have or have not purchased from a specific store.", "example": "is" }, "value": { "type": "string", "title": "Segment Operator", "description": "The store id to segment against.", "example": "289" } } }, { "type": "object", "title": "Goal Activity Segment", "description": "Used for segmenting based off of a subscriber's Goal activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalActivity", "enum": [ "GoalActivity" ] }, "field": { "type": "string", "enum": [ "goal" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's Goal activity.", "example": "goal" }, "op": { "type": "string", "enum": [ "is", "goal_not", "contains", "goal_notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The URL to check Goal activity against." } } }, { "type": "object", "title": "Goal Timestamp Segment", "description": "Used for segmenting based off of a subscriber's last interaction with a website.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalTimestamp", "enum": [ "GoalTimestamp" ] }, "field": { "type": "string", "enum": [ "goal_last_visited" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's last interaction with a website.", "example": "goal_last_visited" }, "op": { "type": "string", "enum": [ "greater", "less", "is" ], "title": "Segment Operator", "description": "Whether the website activity happened after, before, or at a given timestamp.", "example": "greater" }, "value": { "type": "string", "title": "Segment Value", "description": "The date to check Goal activity against.", "example": "2015-07-20 19:45:21" } } }, { "type": "object", "title": "Similar Subscribers Segment Member Segment", "description": "Used for segmenting by the similar subscribers segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "FuzzySegment", "enum": [ "FuzzySegment" ] }, "field": { "type": "string", "enum": [ "fuzzy_segment" ], "title": "Segment Field", "description": "Used for segmenting by the similar subscribers segment.", "example": "fuzzy_segment" }, "op": { "type": "string", "enum": [ "fuzzy_is", "fuzzy_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a 'similar subscribers' segment.", "example": "fuzzy_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the 'similar subscribers' segment.", "example": 48433 } } }, { "type": "object", "title": "Static Segment Member Segment", "description": "Used for segmenting by a given static segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "StaticSegment", "enum": [ "StaticSegment" ] }, "field": { "type": "string", "enum": [ "static_segment" ], "title": "Segment Field", "description": "Used for segmenting by a given static segment.", "example": "static_segment" }, "op": { "type": "string", "enum": [ "static_is", "static_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a static segment.", "example": "static_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the static segment.", "example": 48433 } } }, { "type": "object", "title": "Location-Based Segment", "description": "Used for segmenting members who are within a specific country or US state.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoCountryState", "enum": [ "IPGeoCountryState" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeocountry", "ipgeonotcountry", "ipgeostate", "ipgeonotstate" ], "title": "Segment Operator", "description": "Segment members who are within a specific country or US state.", "example": "ipgeocountry" }, "value": { "type": "string", "title": "Segment Data", "description": "The two-letter country code or US state abbreviation.", "example": "US" } } }, { "type": "object", "title": "Geolocation Segment", "description": "Used for segmenting members who are within a specific geographic region.", "required": [ "field", "op", "value", "addr", "lat", "lng" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoIn", "enum": [ "IPGeoIn" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoin", "ipgeonotin" ], "title": "Segment Operator", "description": "Segment members who are within a specific geographic region.", "example": "ipgeoin" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 42 }, "addr": { "type": "string", "title": "Segment Location Address", "description": "The address of the target location.", "example": "Atlanta, GA, USA" }, "lat": { "type": "string", "title": "Segment Location Latitude", "description": "The latitude of the target location.", "example": "33.7489954" }, "lng": { "type": "string", "title": "Segment Location Longitude", "description": "The longitude of the target location.", "example": "-84.3879824" } } }, { "type": "object", "title": "US Zip Code Segment", "description": "Used for segmenting members who are within a specific US zip code.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoInZip", "enum": [ "IPGeoInZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoinzip" ], "title": "Segment Operator", "description": "Segment members who are within a specific US zip code.", "example": "ipgeoinzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 25 }, "extra": { "type": "integer", "title": "Extra Data", "description": "The zip code to segment against.", "example": 30318 } } }, { "type": "object", "title": "Unknown Location-Based Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoUnknown", "enum": [ "IPGeoUnknown" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeounknown" ], "title": "Segment Operator", "description": "Segment members for which location information is unknown.", "example": "ipgeounknown" } } }, { "type": "object", "title": "Zip Code Location-Based Segment", "description": "Used for segmenting members who are/are not within a specific US zip code.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoZip", "enum": [ "IPGeoZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoiszip", "ipgeonotzip" ], "title": "Segment Operator", "description": "Segment members who are/are not within a specific US zip code.", "example": "ipgeonotzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The 5-digit zip code.", "example": 30318 } } }, { "type": "object", "title": "Social Profiles Age Segment", "description": "Used for segmenting members based age ranges in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialAge", "enum": [ "SocialAge" ] }, "field": { "type": "string", "enum": [ "social_age" ], "title": "Segment Field", "description": "Used for segmenting members based age ranges in Social Profiles data.", "example": "social_age" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-54", "55+" ], "title": "Segment Operator", "description": "The age range to segment.", "example": "35-54" } } }, { "type": "object", "title": "Social Profiles Gender Segment", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialGender", "enum": [ "SocialGender" ] }, "field": { "type": "string", "enum": [ "social_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "example": "social_gender" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The Social Profiles gender to segment.", "example": "female" } } }, { "type": "object", "title": "Social Profiles Influence Segment", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialInfluence", "enum": [ "SocialInfluence" ] }, "field": { "type": "string", "enum": [ "social_influence" ], "title": "Segment Field", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "example": "social_influence" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have a rating that is/not or greater/less than the rating provided.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The Social Profiles influence rating to segment.", "example": 2 } } }, { "type": "object", "title": "Social Profiles Social Network Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkMember", "enum": [ "SocialNetworkMember" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who are/not on a given social network.", "example": "member" }, "value": { "type": "string", "enum": [ "twitter", "facebook", "linkedin", "flickr", "foursquare", "lastfm", "myspace", "quora", "vimeo", "yelp", "youtube" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter" } } }, { "type": "object", "title": "Social Profiles Social Network Follow Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkFollow", "enum": [ "SocialNetworkFollow" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "follow", "notfollow" ], "title": "Segment Operator", "description": "Members who are/not following a linked account on a given social network.", "example": "follow" }, "value": { "type": "string", "enum": [ "twitter_follow" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter_follow" } } }, { "type": "object", "title": "Address Merge Field Segment", "description": "Used for segmenting by an address-type merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "AddressMerge", "enum": [ "AddressMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address-type merge field to segment.", "example": "MMERGE3" }, "op": { "type": "string", "enum": [ "contains", "notcontain", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's address merge field contains/does not contain a value or is/is not blank.", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Atlanta" } } }, { "type": "object", "title": "Address/Zip Merge Field Segment", "description": "Used for segmenting by an address-type merge field within a given distance.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "ZipMerge", "enum": [ "ZipMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address or zip-type merge field to segment.", "example": "MMERGE2" }, "op": { "type": "string", "enum": [ "geoin" ], "title": "Segment Operator", "description": "Whether the member's address merge field is within a given distance from a city or zip.", "example": "geoin" }, "value": { "type": "string", "title": "Segment Value", "description": "The distance from the city/zip.", "example": "25" }, "extra": { "type": "string", "title": "Segment Extra", "description": "The city or the zip being used to segment against.", "example": "30318" } } }, { "type": "object", "title": "Birthday Merge Field Segment", "description": "Used for segmenting by a contact's birthday.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "BirthdayMerge", "enum": [ "BirthdayMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE4" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against (mm/dd).", "example": "01/30" } } }, { "type": "object", "title": "Date Merge Field Segment", "description": "Used for segmenting by a given date merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "DateMerge", "enum": [ "DateMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE5" }, "op": { "type": "string", "enum": [ "is", "not", "less", "blank", "blank_not", "greater" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against.", "example": "01/30/2015" } } }, { "type": "object", "title": "Dropdown/Radio Merge Field Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "SelectMerge", "enum": [ "SelectMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A merge field to segment.", "example": "MMERGE6" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not", "notcontain", "contains" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Second Choice" } } }, { "type": "object", "title": "Text or Number Merge Field Segment", "description": "Used for segmenting by a given text or number merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "TextMerge", "enum": [ "TextMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A text or number merge field to segment.", "example": "MMERGE7" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text or number merge field with.", "example": "Freddie's Jokes" } } }, { "type": "object", "title": "Email Segment", "description": "Used for segmenting by the subscriber's email address.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailAddress", "enum": [ "EmailAddress" ] }, "field": { "type": "string", "enum": [ "merge0", "EMAIL" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's email address.", "example": "EMAIL" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less" ], "title": "Segment Operator", "description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string." }, "value": { "type": "string", "title": "Segment Value", "description": "The value to compare the email against.", "example": "urist.mcvankab@freddiesjokes.com" } } }, { "type": "object", "title": "Predicted Gender Segment", "description": "Used for segmenting members based on predicted gender.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedGender", "enum": [ "PredictedGender" ] }, "field": { "type": "string", "enum": [ "predicted_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted gender." }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The predicted gender to segment.", "example": "female" } } }, { "type": "object", "title": "Predicted Age Segment", "description": "Used for segmenting members based on predicted age", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedAge", "enum": [ "PredictedAge" ] }, "field": { "type": "string", "enum": [ "predicted_age_range" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted age" }, "op": { "type": "string", "enum": [ "is" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-44", "45-54", "55-64", "65+" ], "title": "Segment Operator", "description": "The predicted age to segment.", "example": "female" } } }, { "type": "object", "title": "New Subscribers Prebuilt Segment", "description": "Used for segmenting subscribers who have subscribed within a given time frame.", "properties": { "condition_type": { "type": "string", "x-value": "NewSubscribers", "enum": [ "NewSubscribers" ] }, "field": { "type": "string", "enum": [ "timestamp_opt" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have subscribed within a given time frame." }, "op": { "type": "string", "enum": [ "date_within" ], "title": "Segment Operator", "description": "Whe the event took place, namely within a time frame." }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." } } } ] } } } }, "store_id": { "type": "string", "title": "Store ID", "description": "The id of the store.", "example": "1a2df69xxx" } } }, "settings": { "type": "object", "title": "Automation Campaign Settings", "description": "The settings for the Automation workflow.", "properties": { "title": { "type": "string", "title": "Automation Title", "description": "The title of the Automation." }, "from_name": { "type": "string", "title": "From Name", "description": "The 'from' name for the Automation (not an email address)." }, "reply_to": { "type": "string", "title": "Reply To Address", "description": "The reply-to email address for the Automation." }, "use_conversation": { "type": "boolean", "title": "Conversations", "description": "Whether to use Mailchimp Conversation feature to manage replies" }, "to_name": { "type": "string", "title": "To Name", "description": "The Automation's custom 'To' name, typically the first name [merge field](https://mailchimp.com/help/getting-started-with-merge-tags/)." }, "authenticate": { "type": "boolean", "title": "Authentication", "description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`." }, "auto_footer": { "type": "boolean", "title": "Auto-Footer", "description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation." }, "inline_css": { "type": "boolean", "title": "Inline CSS", "description": "Whether to automatically inline the CSS included with the Automation content." } } }, "tracking": { "type": "object", "title": "Automation Tracking Options", "description": "The tracking options for the Automation.", "properties": { "opens": { "type": "boolean", "title": "Opens", "description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`." }, "html_clicks": { "type": "boolean", "title": "HTML Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`." }, "text_clicks": { "type": "boolean", "title": "Plain-Text Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`." }, "goal_tracking": { "type": "boolean", "title": "Mailchimp Goal Tracking", "description": "Deprecated" }, "ecomm360": { "type": "boolean", "title": "E-commerce Tracking", "description": "Whether to enable e-commerce tracking." }, "google_analytics": { "type": "string", "title": "Google Analytics Tracking", "description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)." }, "clicktale": { "type": "string", "title": "ClickTale Analytics Tracking", "description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)." }, "salesforce": { "type": "object", "title": "Salesforce CRM Tracking", "description": "Deprecated", "properties": { "campaign": { "type": "boolean", "title": "Salesforce Campaign", "description": "Create a campaign in a connected Salesforce account." }, "notes": { "type": "boolean", "title": "Salesforce Note", "description": "Update contact notes for a campaign based on a subscriber's email address." } } }, "capsule": { "type": "object", "title": "Capsule CRM Tracking", "description": "Deprecated", "properties": { "notes": { "type": "boolean", "title": "Capsule Note", "description": "Update contact notes for a campaign based on a subscriber's email addresses." } } } } }, "trigger_settings": { "type": "object", "title": "Automation Trigger", "description": "Available triggers for Automation workflows.", "discriminator": "workflow_type", "required": [ "workflow_type" ], "properties": { "workflow_type": { "type": "string", "title": "Workflow Type", "description": "The type of Automation workflow.", "enum": [ "abandonedBrowse", "abandonedCart", "api", "bestCustomers", "categoryFollowup", "dateAdded", "emailFollowup", "emailSeries", "groupAdd", "groupRemove", "mandrill", "productFollowup", "purchaseFollowup", "recurringEvent", "specialEvent", "visitUrl", "welcomeSeries" ] }, "workflow_title": { "type": "string", "title": "Workflow Title", "description": "The title of the workflow type.", "readOnly": true }, "runtime": { "type": "object", "title": "Automation Workflow Runtime Settings", "description": "A workflow's runtime settings for an Automation.", "properties": { "days": { "type": "array", "title": "Days", "description": "The days an Automation workflow can send.", "items": { "type": "string", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ] } }, "hours": { "type": "object", "title": "Hours", "description": "The hours an Automation workflow can send.", "required": [ "type" ], "properties": { "type": { "type": "string", "title": "Email Send Time Settings", "description": "When to send the Automation email.", "enum": [ "send_asap", "send_between", "send_at" ] } } } } }, "workflow_emails_count": { "type": "integer", "title": "Workflow Emails Count", "description": "The number of emails in the Automation workflow.", "readOnly": true } } }, "report_summary": { "type": "object", "title": "Campaign Report Summary", "description": "A summary of opens and clicks for sent campaigns.", "properties": { "opens": { "type": "integer", "title": "Automation Opens", "description": "The total number of opens for a campaign.", "readOnly": true }, "unique_opens": { "type": "integer", "title": "Unique Opens", "description": "The number of unique opens.", "readOnly": true }, "open_rate": { "type": "number", "title": "Open Rate", "description": "The number of unique opens divided by the total number of successful deliveries.", "readOnly": true }, "clicks": { "type": "integer", "title": "Total Clicks", "description": "The total number of clicks for an campaign.", "readOnly": true }, "subscriber_clicks": { "type": "integer", "title": "Unique Subscriber Clicks", "description": "The number of unique clicks.", "readOnly": true }, "click_rate": { "type": "number", "title": "Click Rate", "description": "The number of unique clicks, divided by the total number of successful deliveries.", "readOnly": true } } }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "tags": [ "automations" ], "x-custom-config": { "methodNameSnake": "get", "methodNameCamel": "get" } } }, "/automations/{workflow_id}/actions/pause-all-emails": { "post": { "summary": "Pause automation emails", "description": "Pause all emails in a specific classic automation workflow.", "operationId": "postAutomationsIdActionsPauseAllEmails", "parameters": [ { "in": "path", "name": "workflow_id", "type": "string", "required": true, "description": "The unique id for the Automation workflow." } ], "responses": { "204": { "description": "Empty Response" }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "automations" ], "x-custom-config": { "methodNameSnake": "pause_all_emails", "methodNameCamel": "pauseAllEmails" } } }, "/automations/{workflow_id}/actions/start-all-emails": { "post": { "summary": "Start automation emails", "description": "Start all emails in a classic automation workflow.", "operationId": "postAutomationsIdActionsStartAllEmails", "parameters": [ { "in": "path", "name": "workflow_id", "type": "string", "required": true, "description": "The unique id for the Automation workflow." } ], "responses": { "204": { "description": "Empty Response" }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "automations" ], "x-custom-config": { "methodNameSnake": "start_all_emails", "methodNameCamel": "startAllEmails" } } }, "/automations/{workflow_id}/actions/archive": { "post": { "summary": "Archive automation", "description": "Archiving will permanently end your automation and keep the report data. You\u2019ll be able to replicate your archived automation, but you can\u2019t restart it.", "operationId": "archiveAutomations", "parameters": [ { "in": "path", "name": "workflow_id", "type": "string", "required": true, "description": "The unique id for the Automation workflow." } ], "responses": { "204": { "description": "Empty Response" }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "automations" ], "x-custom-config": { "methodNameSnake": "archive", "methodNameCamel": "archive" } } }, "/automations/{workflow_id}/emails": { "get": { "summary": "List automated emails", "description": "Get a summary of the emails in a classic automation workflow.", "operationId": "getAutomationsIdEmails", "parameters": [ { "in": "path", "name": "workflow_id", "type": "string", "required": true, "description": "The unique id for the Automation workflow." } ], "responses": { "200": { "description": "", "schema": { "type": "object", "title": "Automation Emails", "description": "A summary of the emails in an Automation workflow.", "properties": { "emails": { "type": "array", "items": { "type": "object", "title": "Automation Workflow Email", "description": "A summary of an individual Automation workflow email.", "properties": { "id": { "type": "string", "title": "Automation Email ID", "description": "A string that uniquely identifies the Automation email.", "readOnly": true }, "web_id": { "type": "integer", "title": "Automation Web ID", "description": "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}`.", "readOnly": true, "example": 33345484 }, "workflow_id": { "type": "string", "title": "Workflow ID", "description": "A string that uniquely identifies an Automation workflow.", "readOnly": true }, "position": { "type": "integer", "title": "Email Position", "description": "The position of an Automation email in a workflow.", "readOnly": true }, "delay": { "type": "object", "title": "Automation Delay", "description": "The delay settings for an Automation email.", "properties": { "amount": { "type": "integer", "title": "Delay Amount", "description": "The delay amount for an Automation email.", "readOnly": true }, "type": { "type": "string", "enum": [ "now", "day", "hour", "week" ], "title": "Delay Type", "description": "The type of delay for an Automation email." }, "direction": { "type": "string", "title": "Delay Direction", "description": "Whether the delay settings describe before or after the delay action of an Automation email.", "enum": [ "before", "after" ] }, "action": { "type": "string", "title": "Delay Action", "description": "The action that triggers the delay of an Automation email.", "enum": [ "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" ] }, "action_description": { "type": "string", "title": "Delay Action Description", "description": "The user-friendly description of the action that triggers an Automation email.", "example": "subscribers purchase anything from your store", "readOnly": true }, "full_description": { "type": "string", "title": "Full Delay Description", "description": "The user-friendly description of the delay and trigger action settings for an Automation email.", "example": "1 day after subscribers purchase anything from your store", "readOnly": true } } }, "create_time": { "type": "string", "title": "Create Time", "format": "date-time", "description": "The date and time the campaign was created in ISO 8601 format.", "readOnly": true }, "start_time": { "type": "string", "title": "Start Time", "format": "date-time", "description": "The date and time the campaign was started in ISO 8601 format.", "readOnly": true }, "archive_url": { "type": "string", "title": "Archive URL", "description": "The link to the campaign's archive version in ISO 8601 format.", "readOnly": true }, "status": { "type": "string", "title": "Campaign Status", "description": "The current status of the campaign.", "enum": [ "save", "paused", "sending" ], "readOnly": true }, "emails_sent": { "type": "integer", "title": "Emails Sent", "description": "The total number of emails sent for this campaign.", "readOnly": true }, "send_time": { "type": "string", "title": "Send Time", "format": "date-time", "description": " The date and time a campaign was sent in ISO 8601 format", "readOnly": true }, "content_type": { "type": "string", "title": "Content Type", "description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').", "readOnly": true }, "needs_block_refresh": { "type": "boolean", "title": "Needs Block Refresh", "description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor.", "readOnly": true, "example": true }, "has_logo_merge_tag": { "type": "boolean", "title": "Has Logo Merge Tag", "description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag.", "readOnly": true, "example": true }, "recipients": { "type": "object", "title": "List", "description": "List settings for the campaign.", "properties": { "list_id": { "type": "string", "title": "List ID", "description": "The unique list id." }, "list_is_active": { "type": "boolean", "title": "List Status", "description": "The status of the list used, namely if it's deleted or disabled.", "readOnly": true }, "list_name": { "type": "string", "title": "List Name", "description": "The name of the list.", "readOnly": true }, "segment_text": { "type": "string", "title": "Segment Text", "description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML.", "readOnly": true }, "recipient_count": { "type": "integer", "title": "Recipient Count", "description": "Count of the recipients on the associated list. Formatted as an integer.", "readOnly": true }, "segment_opts": { "type": "object", "title": "Segment Options", "description": "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.", "properties": { "saved_segment_id": { "type": "integer", "title": "Saved Segment ID", "description": "The id for an existing saved segment." }, "prebuilt_segment_id": { "type": "string", "title": "Prebuilt Segment Id", "description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign.", "example": "subscribers-female" }, "match": { "type": "string", "title": "Match Type", "description": "Segment match type.", "enum": [ "any", "all" ] }, "conditions": { "type": "array", "title": "Segment Type", "description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).", "items": { "x-discriminator": { "type": "string", "propertyName": "condition_type" }, "x-oneOf": [ { "type": "object", "title": "Aim Segment", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "properties": { "condition_type": { "type": "string", "x-value": "Aim", "enum": [ "Aim" ] }, "field": { "type": "string", "enum": [ "aim" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "example": "aim" }, "op": { "type": "string", "enum": [ "open", "click", "sent", "noopen", "noclick", "nosent" ], "title": "Segment Operator", "description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent.", "example": "open" }, "value": { "type": "string", "title": "Segment Data", "description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Automation Segment", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Automation", "enum": [ "Automation" ] }, "field": { "type": "string", "enum": [ "automation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "example": "automation" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.", "example": "started" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id for the automation workflow to segment against.", "example": "2135217" } } }, { "type": "object", "title": "Poll Activity Segment", "description": "Used for segmenting by poll activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "CampaignPoll", "enum": [ "CampaignPoll" ] }, "field": { "type": "string", "enum": [ "poll" ], "title": "Segment Field", "description": "Used for segmenting by poll activity.", "example": "poll" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members have/have not interacted with a specific poll in a Mailchimp email.", "example": "member" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the poll.", "example": 409 } } }, { "type": "object", "title": "Conversation Segment", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Conversation", "enum": [ "Conversation" ] }, "field": { "type": "string", "enum": [ "conversation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "example": "conversation" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied.", "example": "member" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Date Segment", "description": "Used for segmenting by a specific date field.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Date", "enum": [ "Date" ] }, "field": { "type": "string", "enum": [ "timestamp_opt", "info_changed", "ecomm_date" ], "title": "Segment Field", "description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.", "example": "timestamp_opt" }, "op": { "type": "string", "enum": [ "greater", "less", "is", "not", "blank", "blank_not", "within", "notwithin" ], "title": "Segment Operator", "description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.", "example": "greater" }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.", "example": "date" }, "extra": { "type": "string", "title": "Segment Extra Value", "description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.", "example": "2015-01-30" } } }, { "type": "object", "title": "Email Client Segment", "description": "Used for segmenting subscribers who are using a particular email client.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailClient", "enum": [ "EmailClient" ] }, "field": { "type": "string", "enum": [ "email_client" ], "title": "Segment Field", "description": "Used for segmenting subscribers who are using a particular email client.", "example": "email_client" }, "op": { "type": "string", "enum": [ "client_is", "client_not" ], "title": "Segment Operator", "description": "The operation to determine whether we select clients that match the value, or clients that do not match the value.", "example": "client_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The name of the email client.", "example": "Gmail" } } }, { "type": "object", "title": "Language Segment", "description": "Used for segmenting based off of a subscriber's language.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Language", "enum": [ "Language" ] }, "field": { "type": "string", "enum": [ "language" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's language.", "example": "language" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Whether the member's language is or is not set to a specific language.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "A two-letter language identifier.", "example": "en" } } }, { "type": "object", "title": "Member Rating Segment", "description": "Used for segmenting by member rating.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "MemberRating", "enum": [ "MemberRating" ] }, "field": { "type": "string", "enum": [ "rating" ], "title": "Segment Field", "description": "Used for segmenting by member rating.", "example": "rating" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The star rating number to segment against.", "example": 4 } } }, { "type": "object", "title": "Signup Source Segment", "description": "Used for segmenting by the signup source.", "required": [ "field", "condition_type", "op" ], "properties": { "condition_type": { "type": "string", "enum": [ "SignupSource" ], "x-value": "SignupSource", "title": "Type" }, "field": { "type": "string", "enum": [ "source" ], "title": "Segment Field", "example": "source" }, "op": { "type": "string", "enum": [ "source_is", "source_not" ], "title": "Segment Operator", "description": "Whether the member's signup source was/was not a particular value.", "example": "source_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The signup source.", "example": "List Import" } } }, { "type": "object", "title": "Survey Monkey Segment", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SurveyMonkey", "enum": [ "SurveyMonkey" ] }, "field": { "type": "string", "enum": [ "survey_monkey" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "example": "survey_monkey" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.", "example": "started" }, "value": { "type": "string", "title": "Survey ID", "description": "The unique ID of the survey monkey survey.", "example": "32179586" } } }, { "type": "object", "title": "VIP Segment", "description": "Used for segmenting based off of a subscriber's VIP status.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "VIP", "enum": [ "VIP" ] }, "field": { "type": "string", "enum": [ "gmonkey" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's VIP status.", "example": "gmonkey" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Whether the member is or is not marked as VIP.", "example": "member" } } }, { "type": "object", "title": "Interests Segment", "description": "Used for segmenting by a given interest group merge field.", "properties": { "condition_type": { "type": "string", "x-value": "Interests", "enum": [ "Interests" ] }, "field": { "type": "string", "title": "Segment Field", "description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'.", "example": "interests-123" }, "op": { "type": "string", "enum": [ "interestcontains", "interestcontainsall", "interestnotcontains" ], "title": "Segment Operator", "description": "Whether the member is a part of one, all, or none of the groups.", "example": "interestcontains" }, "value": { "type": "array", "title": "Segment Value", "description": "An array containing strings, each representing a group id.", "items": { "type": "string", "example": [ "44401", "44405", "44409" ] } } } }, { "type": "object", "title": "Ecommerce Category Segment", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "properties": { "condition_type": { "type": "string", "x-value": "EcommCategory", "enum": [ "EcommCategory" ] }, "field": { "type": "string", "enum": [ "ecomm_cat", "ecomm_prod" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not purchased specific items or categories.", "example": "ecomm_cat" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "The ecommerce category/item information.", "example": "Product" } } }, { "type": "object", "title": "Ecommerce Number Segment", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EcommNumber", "enum": [ "EcommNumber" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_avg", "ecomm_orders", "ecomm_prod_all", "ecomm_avg_ord" ], "title": "Segment Field", "description": "Used for segmenting members have an average spent total, a total number of orders, total number of products purchased, or average number of products per order.", "example": "ecomm_orders" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Segment", "description": "Used for segmenting members who have/have not purchased anything.", "properties": { "condition_type": { "type": "string", "x-value": "EcommPurchased", "enum": [ "EcommPurchased" ] }, "field": { "type": "string", "enum": [ "ecomm_purchased" ], "title": "Segment Field", "description": "Used for segmenting members who have/have not purchased anything.", "example": "ecomm_purchased" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who have have ('member') or have not ('notmember') purchased.", "example": "member" } } }, { "type": "object", "title": "Ecommerce Spent Segment", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "properties": { "condition_type": { "type": "string", "x-value": "EcommSpent", "enum": [ "EcommSpent" ] }, "field": { "type": "string", "enum": [ "ecomm_spent_one", "ecomm_spent_all" ], "title": "Segment Field", "description": "Used for segmenting members who have spent a specific amount on a single order or over their lifetime.", "example": "ecomm_spent_one" }, "op": { "type": "string", "enum": [ "greater", "less" ], "title": "Segment Operator", "description": "Members who have spent 'more' or 'less' than then specified value.", "example": "greater" }, "value": { "type": "integer", "title": "Segment Data", "description": "The total amount a member spent.", "example": 42 } } }, { "type": "object", "title": "Ecommerce Purchased Store Segment", "description": "Used for segmenting members have purchased from a specific store.", "properties": { "condition_type": { "type": "string", "x-value": "EcommStore", "enum": [ "EcommStore" ] }, "field": { "type": "string", "enum": [ "ecomm_store" ], "title": "Segment Field", "description": "Used for segmenting members have purchased from a specific store.", "example": "ecomm_store" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who have or have not purchased from a specific store.", "example": "is" }, "value": { "type": "string", "title": "Segment Operator", "description": "The store id to segment against.", "example": "289" } } }, { "type": "object", "title": "Goal Activity Segment", "description": "Used for segmenting based off of a subscriber's Goal activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalActivity", "enum": [ "GoalActivity" ] }, "field": { "type": "string", "enum": [ "goal" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's Goal activity.", "example": "goal" }, "op": { "type": "string", "enum": [ "is", "goal_not", "contains", "goal_notcontain", "starts", "ends" ], "title": "Segment Operator", "description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The URL to check Goal activity against." } } }, { "type": "object", "title": "Goal Timestamp Segment", "description": "Used for segmenting based off of a subscriber's last interaction with a website.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "GoalTimestamp", "enum": [ "GoalTimestamp" ] }, "field": { "type": "string", "enum": [ "goal_last_visited" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's last interaction with a website.", "example": "goal_last_visited" }, "op": { "type": "string", "enum": [ "greater", "less", "is" ], "title": "Segment Operator", "description": "Whether the website activity happened after, before, or at a given timestamp.", "example": "greater" }, "value": { "type": "string", "title": "Segment Value", "description": "The date to check Goal activity against.", "example": "2015-07-20 19:45:21" } } }, { "type": "object", "title": "Similar Subscribers Segment Member Segment", "description": "Used for segmenting by the similar subscribers segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "FuzzySegment", "enum": [ "FuzzySegment" ] }, "field": { "type": "string", "enum": [ "fuzzy_segment" ], "title": "Segment Field", "description": "Used for segmenting by the similar subscribers segment.", "example": "fuzzy_segment" }, "op": { "type": "string", "enum": [ "fuzzy_is", "fuzzy_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a 'similar subscribers' segment.", "example": "fuzzy_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the 'similar subscribers' segment.", "example": 48433 } } }, { "type": "object", "title": "Static Segment Member Segment", "description": "Used for segmenting by a given static segment.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "StaticSegment", "enum": [ "StaticSegment" ] }, "field": { "type": "string", "enum": [ "static_segment" ], "title": "Segment Field", "description": "Used for segmenting by a given static segment.", "example": "static_segment" }, "op": { "type": "string", "enum": [ "static_is", "static_not" ], "title": "Segment Operator", "description": "Members who are/are not apart of a static segment.", "example": "static_is" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the static segment.", "example": 48433 } } }, { "type": "object", "title": "Location-Based Segment", "description": "Used for segmenting members who are within a specific country or US state.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoCountryState", "enum": [ "IPGeoCountryState" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeocountry", "ipgeonotcountry", "ipgeostate", "ipgeonotstate" ], "title": "Segment Operator", "description": "Segment members who are within a specific country or US state.", "example": "ipgeocountry" }, "value": { "type": "string", "title": "Segment Data", "description": "The two-letter country code or US state abbreviation.", "example": "US" } } }, { "type": "object", "title": "Geolocation Segment", "description": "Used for segmenting members who are within a specific geographic region.", "required": [ "field", "op", "value", "addr", "lat", "lng" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoIn", "enum": [ "IPGeoIn" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoin", "ipgeonotin" ], "title": "Segment Operator", "description": "Segment members who are within a specific geographic region.", "example": "ipgeoin" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 42 }, "addr": { "type": "string", "title": "Segment Location Address", "description": "The address of the target location.", "example": "Atlanta, GA, USA" }, "lat": { "type": "string", "title": "Segment Location Latitude", "description": "The latitude of the target location.", "example": "33.7489954" }, "lng": { "type": "string", "title": "Segment Location Longitude", "description": "The longitude of the target location.", "example": "-84.3879824" } } }, { "type": "object", "title": "US Zip Code Segment", "description": "Used for segmenting members who are within a specific US zip code.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoInZip", "enum": [ "IPGeoInZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoinzip" ], "title": "Segment Operator", "description": "Segment members who are within a specific US zip code.", "example": "ipgeoinzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The radius of the target location.", "example": 25 }, "extra": { "type": "integer", "title": "Extra Data", "description": "The zip code to segment against.", "example": 30318 } } }, { "type": "object", "title": "Unknown Location-Based Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoUnknown", "enum": [ "IPGeoUnknown" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeounknown" ], "title": "Segment Operator", "description": "Segment members for which location information is unknown.", "example": "ipgeounknown" } } }, { "type": "object", "title": "Zip Code Location-Based Segment", "description": "Used for segmenting members who are/are not within a specific US zip code.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "IPGeoZip", "enum": [ "IPGeoZip" ] }, "field": { "type": "string", "enum": [ "ipgeo" ], "title": "Segment Field", "description": "Segmenting subscribers who are within a specific location.", "example": "ipgeo" }, "op": { "type": "string", "enum": [ "ipgeoiszip", "ipgeonotzip" ], "title": "Segment Operator", "description": "Segment members who are/are not within a specific US zip code.", "example": "ipgeonotzip" }, "value": { "type": "integer", "title": "Segment Data", "description": "The 5-digit zip code.", "example": 30318 } } }, { "type": "object", "title": "Social Profiles Age Segment", "description": "Used for segmenting members based age ranges in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialAge", "enum": [ "SocialAge" ] }, "field": { "type": "string", "enum": [ "social_age" ], "title": "Segment Field", "description": "Used for segmenting members based age ranges in Social Profiles data.", "example": "social_age" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-54", "55+" ], "title": "Segment Operator", "description": "The age range to segment.", "example": "35-54" } } }, { "type": "object", "title": "Social Profiles Gender Segment", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialGender", "enum": [ "SocialGender" ] }, "field": { "type": "string", "enum": [ "social_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on listed gender in Social Profiles data.", "example": "social_gender" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The Social Profiles gender to segment.", "example": "female" } } }, { "type": "object", "title": "Social Profiles Influence Segment", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialInfluence", "enum": [ "SocialInfluence" ] }, "field": { "type": "string", "enum": [ "social_influence" ], "title": "Segment Field", "description": "Used for segmenting members based on influence rating in Social Profiles data.", "example": "social_influence" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have a rating that is/not or greater/less than the rating provided.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The Social Profiles influence rating to segment.", "example": 2 } } }, { "type": "object", "title": "Social Profiles Social Network Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkMember", "enum": [ "SocialNetworkMember" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members who are/not on a given social network.", "example": "member" }, "value": { "type": "string", "enum": [ "twitter", "facebook", "linkedin", "flickr", "foursquare", "lastfm", "myspace", "quora", "vimeo", "yelp", "youtube" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter" } } }, { "type": "object", "title": "Social Profiles Social Network Follow Segment", "description": "Used for segmenting members based on social network in Social Profiles data.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "SocialNetworkFollow", "enum": [ "SocialNetworkFollow" ] }, "field": { "type": "string", "enum": [ "social_network" ], "title": "Segment Field", "description": "Used for segmenting members based on social network in Social Profiles data.", "example": "social_network" }, "op": { "type": "string", "enum": [ "follow", "notfollow" ], "title": "Segment Operator", "description": "Members who are/not following a linked account on a given social network.", "example": "follow" }, "value": { "type": "string", "enum": [ "twitter_follow" ], "title": "Segment Operator", "description": "The social network to segment against.", "example": "twitter_follow" } } }, { "type": "object", "title": "Address Merge Field Segment", "description": "Used for segmenting by an address-type merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "AddressMerge", "enum": [ "AddressMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address-type merge field to segment.", "example": "MMERGE3" }, "op": { "type": "string", "enum": [ "contains", "notcontain", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's address merge field contains/does not contain a value or is/is not blank.", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Atlanta" } } }, { "type": "object", "title": "Address/Zip Merge Field Segment", "description": "Used for segmenting by an address-type merge field within a given distance.", "required": [ "field", "op", "value", "extra" ], "properties": { "condition_type": { "type": "string", "x-value": "ZipMerge", "enum": [ "ZipMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "An address or zip-type merge field to segment.", "example": "MMERGE2" }, "op": { "type": "string", "enum": [ "geoin" ], "title": "Segment Operator", "description": "Whether the member's address merge field is within a given distance from a city or zip.", "example": "geoin" }, "value": { "type": "string", "title": "Segment Value", "description": "The distance from the city/zip.", "example": "25" }, "extra": { "type": "string", "title": "Segment Extra", "description": "The city or the zip being used to segment against.", "example": "30318" } } }, { "type": "object", "title": "Birthday Merge Field Segment", "description": "Used for segmenting by a contact's birthday.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "BirthdayMerge", "enum": [ "BirthdayMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE4" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against (mm/dd).", "example": "01/30" } } }, { "type": "object", "title": "Date Merge Field Segment", "description": "Used for segmenting by a given date merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "DateMerge", "enum": [ "DateMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A date merge field to segment.", "example": "MMERGE5" }, "op": { "type": "string", "enum": [ "is", "not", "less", "blank", "blank_not", "greater" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "A date to segment against.", "example": "01/30/2015" } } }, { "type": "object", "title": "Dropdown/Radio Merge Field Segment", "description": "An individual segment condition", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "SelectMerge", "enum": [ "SelectMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A merge field to segment.", "example": "MMERGE6" }, "op": { "type": "string", "enum": [ "is", "not", "blank", "blank_not", "notcontain", "contains" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not a value or is/is not blank.", "example": "is" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text merge field with.", "example": "Second Choice" } } }, { "type": "object", "title": "Text or Number Merge Field Segment", "description": "Used for segmenting by a given text or number merge field.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "TextMerge", "enum": [ "TextMerge" ] }, "field": { "type": "string", "title": "Segment Field", "description": "A text or number merge field to segment.", "example": "MMERGE7" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less", "blank", "blank_not" ], "title": "Segment Operator", "description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value", "example": "contains" }, "value": { "type": "string", "title": "Segment Value", "description": "The value to segment a text or number merge field with.", "example": "Freddie's Jokes" } } }, { "type": "object", "title": "Email Segment", "description": "Used for segmenting by the subscriber's email address.", "required": [ "field", "op" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailAddress", "enum": [ "EmailAddress" ] }, "field": { "type": "string", "enum": [ "merge0", "EMAIL" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's email address.", "example": "EMAIL" }, "op": { "type": "string", "enum": [ "is", "not", "contains", "notcontain", "starts", "ends", "greater", "less" ], "title": "Segment Operator", "description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string." }, "value": { "type": "string", "title": "Segment Value", "description": "The value to compare the email against.", "example": "urist.mcvankab@freddiesjokes.com" } } }, { "type": "object", "title": "Predicted Gender Segment", "description": "Used for segmenting members based on predicted gender.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedGender", "enum": [ "PredictedGender" ] }, "field": { "type": "string", "enum": [ "predicted_gender" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted gender." }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "male", "female" ], "title": "Segment Operator", "description": "The predicted gender to segment.", "example": "female" } } }, { "type": "object", "title": "Predicted Age Segment", "description": "Used for segmenting members based on predicted age", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "PredictedAge", "enum": [ "PredictedAge" ] }, "field": { "type": "string", "enum": [ "predicted_age_range" ], "title": "Segment Field", "description": "Used for segmenting members based on predicted age" }, "op": { "type": "string", "enum": [ "is" ], "title": "Segment Operator", "description": "Members who are/not the exact criteria listed.", "example": "is" }, "value": { "type": "string", "enum": [ "18-24", "25-34", "35-44", "45-54", "55-64", "65+" ], "title": "Segment Operator", "description": "The predicted age to segment.", "example": "female" } } }, { "type": "object", "title": "New Subscribers Prebuilt Segment", "description": "Used for segmenting subscribers who have subscribed within a given time frame.", "properties": { "condition_type": { "type": "string", "x-value": "NewSubscribers", "enum": [ "NewSubscribers" ] }, "field": { "type": "string", "enum": [ "timestamp_opt" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have subscribed within a given time frame." }, "op": { "type": "string", "enum": [ "date_within" ], "title": "Segment Operator", "description": "Whe the event took place, namely within a time frame." }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent." } } } ] } } } } } }, "settings": { "type": "object", "title": "Campaign Settings", "description": "Settings for the campaign including the email subject, from name, and from email address.", "properties": { "subject_line": { "type": "string", "title": "Campaign Subject Line", "description": "The subject line for the campaign." }, "preview_text": { "type": "string", "title": "Campaign Preview Text", "description": "The preview text for the campaign." }, "title": { "type": "string", "title": "Campaign Title", "description": "The title of the campaign." }, "from_name": { "type": "string", "title": "From Name", "description": "The 'from' name on the campaign (not an email address)." }, "reply_to": { "type": "string", "title": "Reply To Address", "description": "The reply-to email address for the campaign." }, "authenticate": { "type": "boolean", "title": "Authentication", "description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`." }, "auto_footer": { "type": "boolean", "title": "Auto-Footer", "description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign." }, "inline_css": { "type": "boolean", "title": "Inline CSS", "description": "Automatically inline the CSS included with the campaign content." }, "auto_tweet": { "type": "boolean", "title": "Auto-Tweet", "description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent." }, "auto_fb_post": { "type": "array", "title": "Auto Post to Facebook", "description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to.", "items": { "type": "string" } }, "fb_comments": { "type": "boolean", "title": "Facebook Comments", "description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`." }, "template_id": { "type": "integer", "title": "Template ID", "description": "The id for the template used in this campaign." }, "drag_and_drop": { "type": "boolean", "title": "Drag And Drop Campaign", "description": "Whether the campaign uses the drag-and-drop editor.", "readOnly": true } } }, "tracking": { "type": "object", "title": "Campaign Tracking Options", "description": "The tracking options for a campaign.", "properties": { "opens": { "type": "boolean", "title": "Opens", "description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`." }, "html_clicks": { "type": "boolean", "title": "HTML Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`." }, "text_clicks": { "type": "boolean", "title": "Plain-Text Click Tracking", "description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`." }, "goal_tracking": { "type": "boolean", "title": "Mailchimp Goal Tracking", "description": "Deprecated" }, "ecomm360": { "type": "boolean", "title": "E-commerce Tracking", "description": "Whether to enable e-commerce tracking." }, "google_analytics": { "type": "string", "title": "Google Analytics Tracking", "description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)." }, "clicktale": { "type": "string", "title": "ClickTale Analytics Tracking", "description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)." }, "salesforce": { "type": "object", "title": "Salesforce CRM Tracking", "description": "Deprecated", "properties": { "campaign": { "type": "boolean", "title": "Salesforce Campaign", "description": "Create a campaign in a connected Salesforce account." }, "notes": { "type": "boolean", "title": "Salesforce Note", "description": "Update contact notes for a campaign based on a subscriber's email address." } } }, "capsule": { "type": "object", "title": "Capsule CRM Tracking", "description": "Deprecated", "properties": { "notes": { "type": "boolean", "title": "Capsule Note", "description": "Update contact notes for a campaign based on a subscriber's email address." } } } } }, "social_card": { "type": "object", "title": "Campaign Social Card", "description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/).", "properties": { "image_url": { "type": "string", "title": "Image URL", "description": "The url for the header image for the card." }, "description": { "type": "string", "title": "Campaign Description", "description": "A short summary of the campaign to display." }, "title": { "type": "string", "title": "Title", "description": "The title for the card. Typically the subject line of the campaign." } } }, "trigger_settings": { "type": "object", "title": "Automation Trigger", "description": "Available triggers for Automation workflows.", "discriminator": "workflow_type", "required": [ "workflow_type" ], "properties": { "workflow_type": { "type": "string", "title": "Workflow Type", "description": "The type of Automation workflow.", "enum": [ "abandonedBrowse", "abandonedCart", "api", "bestCustomers", "categoryFollowup", "dateAdded", "emailFollowup", "emailSeries", "groupAdd", "groupRemove", "mandrill", "productFollowup", "purchaseFollowup", "recurringEvent", "specialEvent", "visitUrl", "welcomeSeries" ] }, "workflow_title": { "type": "string", "title": "Workflow Title", "description": "The title of the workflow type.", "readOnly": true }, "runtime": { "type": "object", "title": "Automation Workflow Runtime Settings", "description": "A workflow's runtime settings for an Automation.", "properties": { "days": { "type": "array", "title": "Days", "description": "The days an Automation workflow can send.", "items": { "type": "string", "enum": [ "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" ] } }, "hours": { "type": "object", "title": "Hours", "description": "The hours an Automation workflow can send.", "required": [ "type" ], "properties": { "type": { "type": "string", "title": "Email Send Time Settings", "description": "When to send the Automation email.", "enum": [ "send_asap", "send_between", "send_at" ] } } } } }, "workflow_emails_count": { "type": "integer", "title": "Workflow Emails Count", "description": "The number of emails in the Automation workflow.", "readOnly": true } } }, "report_summary": { "type": "object", "title": "Campaign Report Summary", "description": "For sent campaigns, a summary of opens and clicks.", "properties": { "opens": { "type": "integer", "title": "Automation Opens", "description": "The total number of opens for a campaign.", "readOnly": true }, "unique_opens": { "type": "integer", "title": "Unique Opens", "description": "The number of unique opens.", "readOnly": true }, "open_rate": { "type": "number", "title": "Open Rate", "description": "The number of unique opens divided by the total number of successful deliveries.", "readOnly": true }, "clicks": { "type": "integer", "title": "Total Clicks", "description": "The total number of clicks for an campaign.", "readOnly": true }, "subscriber_clicks": { "type": "integer", "title": "Unique Subscriber Clicks", "description": "The number of unique clicks.", "readOnly": true }, "click_rate": { "type": "number", "title": "Click Rate", "description": "The number of unique clicks divided by the total number of successful deliveries.", "readOnly": true } } }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } }, "title": "Emails", "description": "An array of objects, each representing an email in an Automation workflow." }, "total_items": { "type": "integer", "title": "Item Count", "description": "The total number of items matching the query regardless of pagination.", "readOnly": true }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", "type": "array", "items": { "type": "object", "title": "Resource Link", "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", "properties": { "rel": { "type": "string", "title": "Rel", "description": "As with an HTML 'rel' attribute, this describes the type of link.", "readOnly": true }, "href": { "type": "string", "title": "Href", "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", "readOnly": true }, "method": { "type": "string", "title": "Method", "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "readOnly": true }, "targetSchema": { "type": "string", "title": "Target Schema", "description": "For GETs, this is a URL representing the schema that the response should conform to.", "readOnly": true }, "schema": { "type": "string", "title": "Schema", "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", "readOnly": true } } }, "readOnly": true } } } }, "default": { "description": "An error generated by the Mailchimp API.", "schema": { "type": "object", "title": "Problem Detail Document", "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", "required": [ "type", "title", "status", "detail", "instance" ], "properties": { "type": { "type": "string", "title": "Problem Type", "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", "example": "https://mailchimp.com/developer/marketing/docs/errors/" }, "title": { "type": "string", "title": "Error Title", "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", "example": "Resource Not Found" }, "status": { "type": "integer", "title": "HTTP Status Code", "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", "example": 404 }, "detail": { "type": "string", "title": "Error Message", "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", "example": "The requested resource could not be found." }, "instance": { "type": "string", "title": "Instance ID", "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" } } } } }, "deprecated": false, "tags": [ "automations" ], "x-custom-config": { "methodNameSnake": "list_all_workflow_emails", "methodNameCamel": "listAllWorkflowEmails" } } }, "/automations/{workflow_id}/emails/{workflow_email_id}": { "get": { "summary": "Get workflow email info", "description": "Get information about an individual classic automation workflow email.", "operationId": "getAutomationsIdEmailsId", "parameters": [ { "in": "path", "name": "workflow_id", "type": "string", "required": true, "description": "The unique id for the Automation workflow." }, { "in": "path", "name": "workflow_email_id", "type": "string", "required": true, "description": "The unique id for the Automation workflow email." } ], "responses": { "200": { "description": "", "schema": { "type": "object", "title": "Automation Workflow Email", "description": "A summary of an individual Automation workflow email.", "properties": { "id": { "type": "string", "title": "Automation Email ID", "description": "A string that uniquely identifies the Automation email.", "readOnly": true }, "web_id": { "type": "integer", "title": "Automation Web ID", "description": "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}`.", "readOnly": true, "example": 33345484 }, "workflow_id": { "type": "string", "title": "Workflow ID", "description": "A string that uniquely identifies an Automation workflow.", "readOnly": true }, "position": { "type": "integer", "title": "Email Position", "description": "The position of an Automation email in a workflow.", "readOnly": true }, "delay": { "type": "object", "title": "Automation Delay", "description": "The delay settings for an Automation email.", "properties": { "amount": { "type": "integer", "title": "Delay Amount", "description": "The delay amount for an Automation email.", "readOnly": true }, "type": { "type": "string", "enum": [ "now", "day", "hour", "week" ], "title": "Delay Type", "description": "The type of delay for an Automation email." }, "direction": { "type": "string", "title": "Delay Direction", "description": "Whether the delay settings describe before or after the delay action of an Automation email.", "enum": [ "before", "after" ] }, "action": { "type": "string", "title": "Delay Action", "description": "The action that triggers the delay of an Automation email.", "enum": [ "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" ] }, "action_description": { "type": "string", "title": "Delay Action Description", "description": "The user-friendly description of the action that triggers an Automation email.", "example": "subscribers purchase anything from your store", "readOnly": true }, "full_description": { "type": "string", "title": "Full Delay Description", "description": "The user-friendly description of the delay and trigger action settings for an Automation email.", "example": "1 day after subscribers purchase anything from your store", "readOnly": true } } }, "create_time": { "type": "string", "title": "Create Time", "format": "date-time", "description": "The date and time the campaign was created in ISO 8601 format.", "readOnly": true }, "start_time": { "type": "string", "title": "Start Time", "format": "date-time", "description": "The date and time the campaign was started in ISO 8601 format.", "readOnly": true }, "archive_url": { "type": "string", "title": "Archive URL", "description": "The link to the campaign's archive version in ISO 8601 format.", "readOnly": true }, "status": { "type": "string", "title": "Campaign Status", "description": "The current status of the campaign.", "enum": [ "save", "paused", "sending" ], "readOnly": true }, "emails_sent": { "type": "integer", "title": "Emails Sent", "description": "The total number of emails sent for this campaign.", "readOnly": true }, "send_time": { "type": "string", "title": "Send Time", "format": "date-time", "description": " The date and time a campaign was sent in ISO 8601 format", "readOnly": true }, "content_type": { "type": "string", "title": "Content Type", "description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url').", "readOnly": true }, "needs_block_refresh": { "type": "boolean", "title": "Needs Block Refresh", "description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor.", "readOnly": true, "example": true }, "has_logo_merge_tag": { "type": "boolean", "title": "Has Logo Merge Tag", "description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag.", "readOnly": true, "example": true }, "recipients": { "type": "object", "title": "List", "description": "List settings for the campaign.", "properties": { "list_id": { "type": "string", "title": "List ID", "description": "The unique list id." }, "list_is_active": { "type": "boolean", "title": "List Status", "description": "The status of the list used, namely if it's deleted or disabled.", "readOnly": true }, "list_name": { "type": "string", "title": "List Name", "description": "The name of the list.", "readOnly": true }, "segment_text": { "type": "string", "title": "Segment Text", "description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML.", "readOnly": true }, "recipient_count": { "type": "integer", "title": "Recipient Count", "description": "Count of the recipients on the associated list. Formatted as an integer.", "readOnly": true }, "segment_opts": { "type": "object", "title": "Segment Options", "description": "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.", "properties": { "saved_segment_id": { "type": "integer", "title": "Saved Segment ID", "description": "The id for an existing saved segment." }, "prebuilt_segment_id": { "type": "string", "title": "Prebuilt Segment Id", "description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign.", "example": "subscribers-female" }, "match": { "type": "string", "title": "Match Type", "description": "Segment match type.", "enum": [ "any", "all" ] }, "conditions": { "type": "array", "title": "Segment Type", "description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas).", "items": { "x-discriminator": { "type": "string", "propertyName": "condition_type" }, "x-oneOf": [ { "type": "object", "title": "Aim Segment", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "properties": { "condition_type": { "type": "string", "x-value": "Aim", "enum": [ "Aim" ] }, "field": { "type": "string", "enum": [ "aim" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a specific campaign(s).", "example": "aim" }, "op": { "type": "string", "enum": [ "open", "click", "sent", "noopen", "noclick", "nosent" ], "title": "Segment Operator", "description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent.", "example": "open" }, "value": { "type": "string", "title": "Segment Data", "description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Automation Segment", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Automation", "enum": [ "Automation" ] }, "field": { "type": "string", "enum": [ "automation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with an Automation workflow.", "example": "automation" }, "op": { "type": "string", "enum": [ "started", "completed", "not_started", "not_completed" ], "title": "Segment Operator", "description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.", "example": "started" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id for the automation workflow to segment against.", "example": "2135217" } } }, { "type": "object", "title": "Poll Activity Segment", "description": "Used for segmenting by poll activity.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "CampaignPoll", "enum": [ "CampaignPoll" ] }, "field": { "type": "string", "enum": [ "poll" ], "title": "Segment Field", "description": "Used for segmenting by poll activity.", "example": "poll" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "Members have/have not interacted with a specific poll in a Mailchimp email.", "example": "member" }, "value": { "type": "number", "title": "Segment Operator", "description": "The id for the poll.", "example": 409 } } }, { "type": "object", "title": "Conversation Segment", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Conversation", "enum": [ "Conversation" ] }, "field": { "type": "string", "enum": [ "conversation" ], "title": "Segment Field", "description": "Used for segmenting subscribers who have/have not interacted with a campaign via 'Converstaions'.", "example": "conversation" }, "op": { "type": "string", "enum": [ "member", "notmember" ], "title": "Segment Operator", "description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied.", "example": "member" }, "value": { "type": "string", "title": "Segment Data", "description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns.", "example": "any" } } }, { "type": "object", "title": "Date Segment", "description": "Used for segmenting by a specific date field.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Date", "enum": [ "Date" ] }, "field": { "type": "string", "enum": [ "timestamp_opt", "info_changed", "ecomm_date" ], "title": "Segment Field", "description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.", "example": "timestamp_opt" }, "op": { "type": "string", "enum": [ "greater", "less", "is", "not", "blank", "blank_not", "within", "notwithin" ], "title": "Segment Operator", "description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.", "example": "greater" }, "value": { "type": "string", "title": "Segment Data", "description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.", "example": "date" }, "extra": { "type": "string", "title": "Segment Extra Value", "description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign.", "example": "2015-01-30" } } }, { "type": "object", "title": "Email Client Segment", "description": "Used for segmenting subscribers who are using a particular email client.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "EmailClient", "enum": [ "EmailClient" ] }, "field": { "type": "string", "enum": [ "email_client" ], "title": "Segment Field", "description": "Used for segmenting subscribers who are using a particular email client.", "example": "email_client" }, "op": { "type": "string", "enum": [ "client_is", "client_not" ], "title": "Segment Operator", "description": "The operation to determine whether we select clients that match the value, or clients that do not match the value.", "example": "client_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The name of the email client.", "example": "Gmail" } } }, { "type": "object", "title": "Language Segment", "description": "Used for segmenting based off of a subscriber's language.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "Language", "enum": [ "Language" ] }, "field": { "type": "string", "enum": [ "language" ], "title": "Segment Field", "description": "Segmenting based off of a subscriber's language.", "example": "language" }, "op": { "type": "string", "enum": [ "is", "not" ], "title": "Segment Operator", "description": "Whether the member's language is or is not set to a specific language.", "example": "is" }, "value": { "type": "string", "title": "Segment Data", "description": "A two-letter language identifier.", "example": "en" } } }, { "type": "object", "title": "Member Rating Segment", "description": "Used for segmenting by member rating.", "required": [ "field", "op", "value" ], "properties": { "condition_type": { "type": "string", "x-value": "MemberRating", "enum": [ "MemberRating" ] }, "field": { "type": "string", "enum": [ "rating" ], "title": "Segment Field", "description": "Used for segmenting by member rating.", "example": "rating" }, "op": { "type": "string", "enum": [ "is", "not", "greater", "less" ], "title": "Segment Operator", "description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number.", "example": "greater" }, "value": { "type": "number", "title": "Segment Operator", "description": "The star rating number to segment against.", "example": 4 } } }, { "type": "object", "title": "Signup Source Segment", "description": "Used for segmenting by the signup source.", "required": [ "field", "condition_type", "op" ], "properties": { "condition_type": { "type": "string", "enum": [ "SignupSource" ], "x-value": "SignupSource", "title": "Type" }, "field": { "type": "string", "enum": [ "source" ], "title": "Segment Field", "example": "source" }, "op": { "type": "string", "enum": [ "source_is", "source_not" ], "title": "Segment Operator", "description": "Whether the member's signup source was/was not a particular value.", "example": "source_is" }, "value": { "type": "string", "title": "Segment Data", "description": "The signup source.", "example": "List Import" } } }, { "type": "object", "title": "Survey Monkey Segment", "description": "Used for segmenting subscribers who have/have not interacted with a survey monkey survey.", "require