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} account-exports: title: Account Exports description: Generate a new export or download a finished export. paths: - /account-exports - /account-exports/{export_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} subResources: - file-manager-folders-files 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} file-manager-folders-files: title: Files in Folder description: Manage specific files in a folder. paths: - /file-manager/folders/{folder_id}/files 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-sms-program 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 for an audience. See [Merge Field documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/) for more. 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} list-surveys: title: Surveys description: Get survey data for this audience. paths: - /lists/{list_id}/surveys - /lists/{list_id}/surveys/{survey_id} - /lists/{list_id}/surveys/{survey_id}/actions/publish - /lists/{list_id}/surveys/{survey_id}/actions/unpublish - /lists/{list_id}/surveys/{survey_id}/actions/create-email 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 consumers 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} reporting-surveys: title: Surveys description: >- Get an overall report for a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys - /reporting/surveys/{survey_id} subResources: - reporting-surveys-questions - reporting-surveys-responses reporting-surveys-questions: title: Survey Questions description: >- Get reports by question on a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/questions - /reporting/surveys/{survey_id}/questions/{question_id} subResources: - reporting-surveys-questions-answers reporting-surveys-questions-answers: title: Survey Question Answers description: >- Answers to specific questions on a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/questions/{question_id}/answers reporting-surveys-responses: title: Survey Responses description: >- Get survey response reports for a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/responses - /reporting/surveys/{survey_id}/responses/{response_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.55 title: 'Mailchimp Marketing API ' contact: name: Mailchimp API Support email: apihelp@mailchimp.com x-permalink: >- https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json description: |2- The Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more. 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: Mailchimp 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 example: example_value - 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 example: example_value 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /activity-feed/chimp-chatter: get: summary: Mailchimp 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 example: example_value - 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 example: example_value 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: - Activity - Chatter - Feed x-custom-config: methodNameSnake: get_chimp_chatter methodNameCamel: getChimpChatter operationId: getActivityFeedChimpChatter x-microcks-operation: delay: 0 dispatcher: FALLBACK /account-exports: get: summary: Mailchimp List Account Exports description: Get a list of account exports for a given account. operationId: getAccountExports 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object description: An array of objects, each representing an account export. properties: exports: title: Account Exports description: An array of objects, each representing an account export. type: array items: type: object description: An account export. properties: export_id: type: integer title: Export ID description: The ID for the export. started: type: string format: date-time title: Start Time description: Start time for the export. finished: type: string format: date-time title: Finish Time description: If finished, the finish time for the export. size_in_bytes: type: integer title: Export Size description: The size of the uncompressed export in bytes. download_url: type: string title: Download URL description: >- If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. _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: - Accounts - Exports x-custom-config: methodNameSnake: list_account_exports methodNameCamel: listAccountExports x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Export description: Create a new account export in your Mailchimp account. operationId: postAccountExport parameters: - name: body in: body required: true schema: type: object title: Create an account export description: Creates an account export with the given parameters. required: - include_stages properties: include_stages: type: array title: Include Stages description: The stages of an account export to include. example: '["audiences", "gallery_files"]' items: type: string enum: - audiences - campaigns - events - gallery_files - reports - templates since_timestamp: type: string title: Since Timestamp format: date-time description: >- An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit. example: '2021-08-23T14:15:09Z' example: example_value responses: '200': description: '' schema: type: object description: An account export. properties: export_id: type: integer title: Export ID description: The ID for the export. started: type: string format: date-time title: Start Time description: Start time for the export. finished: type: string format: date-time title: Finish Time description: If finished, the finish time for the export. size_in_bytes: type: integer title: Export Size description: The size of the uncompressed export in bytes. download_url: type: string title: Download URL description: >- If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. _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: - Accounts - Exports x-custom-config: methodNameSnake: create_account_export methodNameCamel: createAccountExport x-microcks-operation: delay: 0 dispatcher: FALLBACK /account-exports/{export_id}: get: summary: Mailchimp Get Account Export Info description: Get information about a specific account export. operationId: getAccountExportId 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 example: example_value - 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 example: example_value - in: path name: export_id x-title: Export ID type: string required: true description: The unique id for the account export. example: '500123' responses: '200': description: '' schema: type: object description: An account export. properties: export_id: type: integer title: Export ID description: The ID for the export. started: type: string format: date-time title: Start Time description: Start time for the export. finished: type: string format: date-time title: Finish Time description: If finished, the finish time for the export. size_in_bytes: type: integer title: Export Size description: The size of the uncompressed export in bytes. download_url: type: string title: Download URL description: >- If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes. _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: - Account Export - Accounts - Exports x-custom-config: methodNameSnake: get_account_exports methodNameCamel: getAccountExports x-microcks-operation: delay: 0 dispatcher: FALLBACK /authorized-apps: get: summary: Mailchimp 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value 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: - Applications - Authorized x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK /authorized-apps/{app_id}: get: summary: Mailchimp 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 example: example_value - 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 example: example_value - in: path name: app_id x-title: App ID type: string required: true description: The unique id for the connected authorized application. example: '500123' 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: - Applications - Authorized - Authorized Apps x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations: get: summary: Mailchimp 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: >- Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: >- Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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 [audience 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp 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'. example: example_value 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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 [audience 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}: get: summary: Mailchimp 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 example: example_value - 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 example: example_value - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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 [audience 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/actions/pause-all-emails: post: summary: Mailchimp 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. example: '500123' 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: - Actions - Automations - Emails - Pause x-custom-config: methodNameSnake: pause_all_emails methodNameCamel: pauseAllEmails x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/actions/start-all-emails: post: summary: Mailchimp 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. example: '500123' 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: - Actions - Automations - Emails x-custom-config: methodNameSnake: start_all_emails methodNameCamel: startAllEmails x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/actions/archive: post: summary: Mailchimp Archive Automation description: >- Archiving will permanently end your automation and keep the report data. Youll be able to replicate your archived automation, but you cant restart it. operationId: archiveAutomations parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' 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: - Actions - Archive - Automations x-custom-config: methodNameSnake: archive methodNameCamel: archive x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/emails: get: summary: Mailchimp 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. example: '500123' 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: >- Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: >- Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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 - Emails x-custom-config: methodNameSnake: list_all_workflow_emails methodNameCamel: listAllWorkflowEmails x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/emails/{workflow_email_id}: get: summary: Mailchimp 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. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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 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 - Emails x-custom-config: methodNameSnake: get_workflow_email methodNameCamel: getWorkflowEmail x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Workflow Email description: >- Removes an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted. operationId: deleteAutomationsIdEmailsId parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com 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 - Emails x-custom-config: methodNameSnake: delete_workflow_email methodNameCamel: deleteWorkflowEmail x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Workflow Email description: >- Update settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome. operationId: patchAutomationEmailWorkflowId parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com - in: body name: body description: '' required: true schema: type: object title: Update information about a specific workflow email description: Update information about an individual Automation workflow email. properties: 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: 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. delay: type: object title: Automation Delay description: The delay settings for an automation email. required: - action properties: amount: type: integer title: Delay Amount description: The delay amount for an automation email. example: 1 type: type: string enum: - now - day - hour - week title: Delay Type description: The type of delay for an automation email. example: day direction: type: string title: Delay Direction description: >- Whether the delay settings describe before or after the delay action of an automation email. enum: - after example: after action: type: string title: Delay Action description: >- The action that triggers the delay of an automation emails. enum: - signup - ecomm_abandoned_browse - ecomm_abandoned_cart example: signup example: example_value 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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 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 - Emails x-custom-config: methodNameSnake: update_workflow_email methodNameCamel: updateWorkflowEmail x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/emails/{workflow_email_id}/queue: get: summary: Mailchimp List Automated Email Subscribers description: Get information about a classic automation email queue. operationId: getAutomationsIdEmailsIdQueue parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com responses: '200': description: '' schema: type: object description: An automation workflow properties: workflow_id: type: string title: Workflow ID description: A string that uniquely identifies an Automation workflow. readOnly: true email_id: type: string title: Automation Email ID description: >- A string that uniquely identifies an email in an Automation workflow. readOnly: true queue: type: array items: type: object title: Subscriber in Automation Queue description: Information about subscribers in an Automation email queue. required: - email_address properties: id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true workflow_id: type: string title: Workflow ID description: >- A string that uniquely identifies an Automation workflow. readOnly: true email_id: type: string title: Automation Email ID description: >- A string that uniquely identifies an email in an Automation workflow. readOnly: true list_id: type: string title: List ID description: A string that uniquely identifies a list. readOnly: true email_address: type: string title: Email Address description: The list member's email address. next_send: type: string title: Next Send format: date-time description: >- The date and time of the next send for the workflow email in ISO 8601 format. 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: Trigger description: >- An array of objects, each representing a subscriber queue for an email in an Automation workflow. 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: - Automations - Emails - Queues x-custom-config: methodNameSnake: get_workflow_email_subscriber_queue methodNameCamel: getWorkflowEmailSubscriberQueue x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Subscriber to Workflow Email description: >- Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type. operationId: postAutomationsIdEmailsIdQueue parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com - name: body in: body description: '' required: true schema: type: object title: Subscriber in Automation Queue description: Information about subscribers in an Automation email queue. required: - email_address properties: email_address: type: string title: Email Address description: The list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Subscriber in Automation Queue description: Information about subscribers in an Automation email queue. properties: id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true workflow_id: type: string title: Workflow ID description: A string that uniquely identifies an Automation workflow. readOnly: true email_id: type: string title: Automation Email ID description: >- A string that uniquely identifies an email in an Automation workflow. readOnly: true list_id: type: string title: List ID description: A string that uniquely identifies a list. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true email_address: type: string title: Email Address description: The list member's email address. next_send: type: string title: Next Send format: date-time description: >- The date and time of the next send for the workflow email in ISO 8601 format. 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 - Emails - Queues x-custom-config: methodNameSnake: add_workflow_email_subscriber methodNameCamel: addWorkflowEmailSubscriber x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash}: get: summary: Mailchimp Get Automated Email Subscriber description: >- Get information about a specific subscriber in a classic automation email queue. operationId: getAutomationsIdEmailsIdQueueId parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Subscriber in Automation Queue description: Information about subscribers in an Automation email queue. properties: id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true workflow_id: type: string title: Workflow ID description: A string that uniquely identifies an Automation workflow. readOnly: true email_id: type: string title: Automation Email ID description: >- A string that uniquely identifies an email in an Automation workflow. readOnly: true list_id: type: string title: List ID description: A string that uniquely identifies a list. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true email_address: type: string title: Email Address description: The list member's email address. next_send: type: string title: Next Send format: date-time description: >- The date and time of the next send for the workflow email in ISO 8601 format. 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 - Emails - Queues x-custom-config: methodNameSnake: get_workflow_email_subscriber methodNameCamel: getWorkflowEmailSubscriber x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause: post: summary: Mailchimp Pause Automated Email description: Pause an automated email. operationId: postAutomationsIdEmailsIdActionsPause parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com 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: - Actions - Automations - Emails - Pause x-custom-config: methodNameSnake: pause_workflow_email methodNameCamel: pauseWorkflowEmail x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/emails/{workflow_email_id}/actions/start: post: summary: Mailchimp Start Automated Email description: Start an automated email. operationId: postAutomationsIdEmailsIdActionsStart parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: workflow_email_id type: string required: true description: The unique id for the Automation workflow email. example: user@example.com 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: - Actions - Automations - Emails x-custom-config: methodNameSnake: start_workflow_email methodNameCamel: startWorkflowEmail x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/removed-subscribers: get: summary: Mailchimp List Subscribers Removed From Workflow description: >- Get information about subscribers who were removed from a classic automation workflow. operationId: getAutomationsIdRemovedSubscribers parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' responses: '200': description: '' schema: type: object title: Removed Subscribers description: >- A summary of the subscribers who were removed from an Automation workflow. properties: workflow_id: type: string title: Workflow ID description: A string that uniquely identifies an Automation workflow. readOnly: true subscribers: type: array items: type: object title: Subscriber Removed from Automation Workflow description: >- A summary of a subscriber removed from an Automation workflow. properties: id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true workflow_id: type: string title: Workflow ID description: >- A string that uniquely identifies an Automation workflow. readOnly: true list_id: type: string title: List ID description: A string that uniquely identifies a list. readOnly: true email_address: type: string title: Email Address description: The list member's email address. _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: Trigger description: >- An array of objects, each representing a subscriber who was removed from an Automation workflow. 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: - Automations - Removed - Subscribers x-custom-config: methodNameSnake: list_workflow_email_subscribers_removed methodNameCamel: listWorkflowEmailSubscribersRemoved x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Remove Subscriber From Workflow description: >- Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow. operationId: postAutomationsIdRemovedSubscribers parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - name: body in: body description: '' required: true schema: type: object title: Subscriber in Automation Queue description: Information about subscribers in an Automation email queue. required: - email_address properties: email_address: type: string title: Email Address description: The list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Subscriber Removed from Automation Workflow description: A summary of a subscriber removed from an Automation workflow. properties: id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true workflow_id: type: string title: Workflow ID description: A string that uniquely identifies an Automation workflow. readOnly: true list_id: type: string title: List ID description: A string that uniquely identifies a list. readOnly: true email_address: type: string title: Email Address description: The list member's email address. _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 - Removed - Subscribers x-custom-config: methodNameSnake: remove_workflow_email_subscriber methodNameCamel: removeWorkflowEmailSubscriber x-microcks-operation: delay: 0 dispatcher: FALLBACK /automations/{workflow_id}/removed-subscribers/{subscriber_hash}: get: summary: Mailchimp Get Subscriber Removed From Workflow description: >- Get information about a specific subscriber who was removed from a classic automation workflow. operationId: getAutomationsIdRemovedSubscribersId parameters: - in: path name: workflow_id type: string required: true description: The unique id for the Automation workflow. example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Subscriber Removed from Automation Workflow description: A summary of a subscriber removed from an Automation workflow. properties: id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true workflow_id: type: string title: Workflow ID description: A string that uniquely identifies an Automation workflow. readOnly: true list_id: type: string title: List ID description: A string that uniquely identifies a list. readOnly: true email_address: type: string title: Email Address description: The list member's email address. _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 - Removed - Subscribers x-custom-config: methodNameSnake: get_removed_workflow_email_subscriber methodNameCamel: getRemovedWorkflowEmailSubscriber x-microcks-operation: delay: 0 dispatcher: FALLBACK /batches: get: summary: Mailchimp List Batch Requests description: Get a summary of batch requests that have been made. operationId: getBatches 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Batch Operations description: A summary of batch requests that have been made. properties: batches: type: array items: type: object title: Batch description: The status of a batch request properties: id: type: string title: Batch ID description: A string that uniquely identifies this batch request. readOnly: true status: type: string title: Status description: >- The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true total_operations: type: integer title: Total Operations description: >- The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true finished_operations: type: integer title: Finished Operations description: >- The number of completed operations. This includes operations that returned an error. readOnly: true errored_operations: type: integer title: Error Operations description: >- The number of completed operations that returned an error. readOnly: true submitted_at: type: string format: date-time title: Submitted At description: >- The date and time when the server received the batch request in ISO 8601 format. readOnly: true completed_at: type: string format: date-time title: Completed At description: >- The date and time when all operations in the batch request completed in ISO 8601 format. readOnly: true response_body_url: type: string title: Response Body URL description: >- The URL of the gzipped archive of the results of all the operations. 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: Batches description: An array of objects representing batch calls. 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: - Batches x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Start Batch Operation description: Begin processing a batch operations request. operationId: postBatches parameters: - in: body name: body description: '' required: true schema: type: object required: - operations properties: operations: type: array title: Operations List description: An array of objects that describes operations to perform. items: type: object title: Operations required: - method - path properties: method: type: string title: HTTP Method description: The HTTP method to use for the operation. enum: - GET - POST - PUT - PATCH - DELETE example: POST path: type: string title: Path description: The relative path to use for the operation. example: /lists params: type: object title: Query Parameters description: >- Any request query parameters. Example parameters: {"count":10, "offset":0} example: '{"count":10,"offset":0}' body: type: string title: Body description: >- A string containing the JSON body to use with the request. example: '{"title":"Test"}' operation_id: type: string title: Operation ID description: >- An optional client-supplied id returned with the operation results. example: my-id-123 example: example_value responses: '200': description: '' schema: type: object title: Batch description: The status of a batch request properties: id: type: string title: Batch ID description: A string that uniquely identifies this batch request. readOnly: true status: type: string title: Status description: >- The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true total_operations: type: integer title: Total Operations description: >- The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true finished_operations: type: integer title: Finished Operations description: >- The number of completed operations. This includes operations that returned an error. readOnly: true errored_operations: type: integer title: Error Operations description: The number of completed operations that returned an error. readOnly: true submitted_at: type: string format: date-time title: Submitted At description: >- The date and time when the server received the batch request in ISO 8601 format. readOnly: true completed_at: type: string format: date-time title: Completed At description: >- The date and time when all operations in the batch request completed in ISO 8601 format. readOnly: true response_body_url: type: string title: Response Body URL description: >- The URL of the gzipped archive of the results of all the operations. 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: - Batches x-custom-config: methodNameSnake: start methodNameCamel: start x-microcks-operation: delay: 0 dispatcher: FALLBACK /batches/{batch_id}: get: summary: Mailchimp Get Batch Operation Status description: Get the status of a batch request. operationId: getBatchesId 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 example: example_value - 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 example: example_value - in: path name: batch_id type: string required: true description: The unique id for the batch operation. example: '500123' responses: '200': description: '' schema: type: object title: Batch description: The status of a batch request properties: id: type: string title: Batch ID description: A string that uniquely identifies this batch request. readOnly: true status: type: string title: Status description: >- The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status. enum: - pending - preprocessing - started - finalizing - finished readOnly: true total_operations: type: integer title: Total Operations description: >- The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation. readOnly: true finished_operations: type: integer title: Finished Operations description: >- The number of completed operations. This includes operations that returned an error. readOnly: true errored_operations: type: integer title: Error Operations description: The number of completed operations that returned an error. readOnly: true submitted_at: type: string format: date-time title: Submitted At description: >- The date and time when the server received the batch request in ISO 8601 format. readOnly: true completed_at: type: string format: date-time title: Completed At description: >- The date and time when all operations in the batch request completed in ISO 8601 format. readOnly: true response_body_url: type: string title: Response Body URL description: >- The URL of the gzipped archive of the results of all the operations. 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: - Batches x-custom-config: methodNameSnake: status methodNameCamel: status x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Batch Request description: >- Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call. operationId: deleteBatchesId parameters: - in: path name: batch_id type: string required: true description: The unique id for the batch operation. example: '500123' 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: - Batches x-custom-config: methodNameSnake: delete_request methodNameCamel: deleteRequest x-microcks-operation: delay: 0 dispatcher: FALLBACK /batch-webhooks: get: summary: Mailchimp List Batch Webhooks description: Get all webhooks that have been configured for batches. operationId: getBatchWebhooks 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Batch Webhooks description: Manage webhooks for batch requests. properties: webhooks: type: array items: type: object title: Batch Webhook description: A webhook configured for batch status updates. properties: id: type: string title: Batch Webhook ID description: A string that uniquely identifies this Batch Webhook. readOnly: true url: type: string title: URL description: A valid URL for the Webhook. readOnly: false example: http://yourdomain.com/webhook enabled: type: boolean title: Enabled description: Whether the webhook receives requests or not. readOnly: false example: 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: Webhooks description: An array of objects, each representing a Batch Webhook. 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: - Batch - Webhooks x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Batch Webhook description: >- Configure a webhook that will fire whenever any batch request completes processing. You may only have a maximum of 20 batch webhooks. operationId: postBatchWebhooks parameters: - in: body name: body description: '' required: true schema: type: object title: Batch Webhook description: Add a new Batch Webook. required: - url properties: url: type: string title: URL description: A valid URL for the Webhook. example: http://yourdomain.com/webhook enabled: type: boolean title: Enabled description: Whether the webhook receives requests or not. example: true example: example_value responses: '200': description: '' schema: type: object title: Batch Webhook description: A webhook configured for batch status updates. properties: id: type: string title: Batch Webhook ID description: A string that uniquely identifies this Batch Webhook. readOnly: true url: type: string title: URL description: A valid URL for the Webhook. readOnly: false example: http://yourdomain.com/webhook enabled: type: boolean title: Enabled description: Whether the webhook receives requests or not. readOnly: false example: 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: - Batch - Webhooks x-custom-config: methodNameSnake: create methodNameCamel: create x-microcks-operation: delay: 0 dispatcher: FALLBACK /batch-webhooks/{batch_webhook_id}: get: summary: Mailchimp Get Batch Webhook Info description: Get information about a specific batch webhook. operationId: getBatchWebhook 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 example: example_value - 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 example: example_value - in: path name: batch_webhook_id type: string required: true description: The unique id for the batch webhook. example: '500123' responses: '200': description: '' schema: type: object title: Batch Webhook description: A webhook configured for batch status updates. properties: id: type: string title: Batch Webhook ID description: A string that uniquely identifies this Batch Webhook. readOnly: true url: type: string title: URL description: A valid URL for the Webhook. readOnly: false example: http://yourdomain.com/webhook enabled: type: boolean title: Enabled description: Whether the webhook receives requests or not. readOnly: false example: 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: - Batch - Batch Webhooks - Webhooks x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Batch Webhook description: >- Update a webhook that will fire whenever any batch request completes processing. operationId: patchBatchWebhooks parameters: - in: path name: batch_webhook_id type: string required: true description: The unique id for the batch webhook. example: '500123' - in: body name: body description: '' required: true schema: type: object title: Batch Webhook description: Update an existing Batch Webook. properties: url: type: string title: URL description: A valid URL for the Webhook. example: http://yourdomain.com/webhook enabled: type: boolean title: Enabled description: Whether the webhook receives requests or not. example: true example: example_value responses: '200': description: '' schema: type: object title: Batch Webhook description: A webhook configured for batch status updates. properties: id: type: string title: Batch Webhook ID description: A string that uniquely identifies this Batch Webhook. readOnly: true url: type: string title: URL description: A valid URL for the Webhook. readOnly: false example: http://yourdomain.com/webhook enabled: type: boolean title: Enabled description: Whether the webhook receives requests or not. readOnly: false example: 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: - Batch - Batch Webhooks - Webhooks x-custom-config: methodNameSnake: update methodNameCamel: update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Batch Webhook description: >- Remove a batch webhook. Webhooks will no longer be sent to the given URL. operationId: deleteBatchWebhookId parameters: - in: path name: batch_webhook_id type: string required: true description: The unique id for the batch webhook. example: '500123' 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: - Batch - Batch Webhooks - Webhooks x-custom-config: methodNameSnake: remove methodNameCamel: remove x-microcks-operation: delay: 0 dispatcher: FALLBACK /template-folders: get: summary: Mailchimp List Template Folders description: Get all folders used to organize templates. operationId: getTemplateFolders 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Template Folders description: A list of template folders properties: folders: type: array items: type: object title: Template Folder description: A folder used to organize templates. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this template folder. readOnly: true count: type: integer title: Template Count description: The number of templates in the folder. 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: Template Folders description: An array of objects representing template folders. 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: - Folders - Template x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Template Folder description: Create a new template folder. operationId: postTemplateFolders parameters: - in: body name: body description: '' required: true schema: type: object title: Template Folder description: A folder used to organize templates. required: - name properties: name: type: string title: Folder Name description: The name of the folder. example: example_value responses: '200': description: '' schema: type: object title: Template Folder description: A folder used to organize templates. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this template folder. readOnly: true count: type: integer title: Template Count description: The number of templates in the folder. 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: - Folders - Template x-custom-config: methodNameSnake: create methodNameCamel: create x-microcks-operation: delay: 0 dispatcher: FALLBACK /template-folders/{folder_id}: get: summary: Mailchimp Get Template Folder description: Get information about a specific folder used to organize templates. operationId: getTemplateFoldersId 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 example: example_value - 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 example: example_value - in: path name: folder_id type: string required: true description: The unique id for the template folder. example: '500123' responses: '200': description: '' schema: type: object title: Template Folder description: A folder used to organize templates. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this template folder. readOnly: true count: type: integer title: Template Count description: The number of templates in the folder. 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: - Folders - Template - Template Folders x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Template Folder description: Update a specific folder used to organize templates. operationId: patchTemplateFoldersId parameters: - in: path name: folder_id type: string required: true description: The unique id for the template folder. example: '500123' - in: body name: body description: '' required: true schema: type: object title: Template Folder description: A folder used to organize templates. required: - name properties: name: type: string title: Folder Name description: The name of the folder. example: example_value responses: '200': description: '' schema: type: object title: Template Folder description: A folder used to organize templates. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this template folder. readOnly: true count: type: integer title: Template Count description: The number of templates in the folder. 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: - Folders - Template - Template Folders x-custom-config: methodNameSnake: update methodNameCamel: update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Template Folder description: >- Delete a specific template folder, and mark all the templates in the folder as 'unfiled'. operationId: deleteTemplateFoldersId parameters: - in: path name: folder_id type: string required: true description: The unique id for the template folder. example: '500123' 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: - Folders - Template - Template Folders x-custom-config: methodNameSnake: remove methodNameCamel: remove x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaign-folders: get: summary: Mailchimp List Campaign Folders description: Get all folders used to organize campaigns. operationId: getCampaignFolders 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Campaign Folders description: A list of campaign folders properties: folders: type: array items: type: object title: Campaign Folder description: A folder used to organize campaigns. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this campaign folder. readOnly: true count: type: integer title: Campaign Count description: The number of campaigns in the folder. 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: Campaign Folders description: An array of objects representing campaign folders. 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: - Campaigns - Folders x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Campaign Folder description: Create a new campaign folder. operationId: postCampaignFolders parameters: - in: body name: body description: '' required: true schema: type: object title: Campaign Folder description: A folder used to organize campaigns. required: - name properties: name: type: string title: Folder Name description: Name to associate with the folder. example: example_value responses: '200': description: '' schema: type: object title: Campaign Folder description: A folder used to organize campaigns. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this campaign folder. readOnly: true count: type: integer title: Campaign Count description: The number of campaigns in the folder. 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: - Campaigns - Folders x-custom-config: methodNameSnake: create methodNameCamel: create x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaign-folders/{folder_id}: get: summary: Mailchimp Get Campaign Folder description: Get information about a specific folder used to organize campaigns. operationId: getCampaignFoldersId 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 example: example_value - 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 example: example_value - in: path name: folder_id type: string required: true description: The unique id for the campaign folder. example: '500123' responses: '200': description: '' schema: type: object title: Campaign Folder description: A folder used to organize campaigns. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this campaign folder. readOnly: true count: type: integer title: Campaign Count description: The number of campaigns in the folder. 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: - Campaign Folders - Campaigns - Folders x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Campaign Folder description: Update a specific folder used to organize campaigns. operationId: patchCampaignFoldersId parameters: - in: path name: folder_id type: string required: true description: The unique id for the campaign folder. example: '500123' - in: body name: body description: '' required: true schema: type: object title: Campaign Folder description: A folder used to organize campaigns. required: - name properties: name: type: string title: Folder Name description: Name to associate with the folder. example: example_value responses: '200': description: '' schema: type: object title: Campaign Folder description: A folder used to organize campaigns. properties: name: type: string title: Folder Name description: The name of the folder. id: type: string title: Folder Id description: A string that uniquely identifies this campaign folder. readOnly: true count: type: integer title: Campaign Count description: The number of campaigns in the folder. 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: - Campaign Folders - Campaigns - Folders x-custom-config: methodNameSnake: update methodNameCamel: update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Campaign Folder description: >- Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'. operationId: deleteCampaignFoldersId parameters: - in: path name: folder_id type: string required: true description: The unique id for the campaign folder. example: '500123' 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: - Campaign Folders - Campaigns - Folders x-custom-config: methodNameSnake: remove methodNameCamel: remove x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns: get: summary: Mailchimp List Campaigns description: Get all campaigns in an account. operationId: getCampaigns 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: type x-title: Campaign Type in: query description: The campaign type. required: false type: string enum: - regular - plaintext - absplit - rss - variate example: example_value - name: status x-title: Status in: query description: The status of the campaign. required: false type: string enum: - save - paused - schedule - sending - sent example: example_value - name: before_send_time x-title: Before Send Time in: query description: >- Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value - name: since_send_time x-title: Since Send Time in: query description: >- Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value - name: before_create_time x-title: Before Create Time in: query description: >- Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value - name: since_create_time x-title: Since Create Time in: query description: >- Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value - name: list_id x-title: List ID in: query description: The unique id for the list. required: false type: string example: '500123' - name: folder_id x-title: Folder ID in: query description: The unique folder id. required: false type: string example: '500123' - name: member_id x-title: Member ID in: query description: >- Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list members email address. type: string required: false example: '500123' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - create_time - send_time example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: include_resend_shortcut_eligibility x-title: Include Resend Shortcut Eligibility in: query description: >- Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered. required: false type: boolean example: example_value responses: '200': description: '' schema: type: object description: An array of campaigns. properties: campaigns: type: array items: type: object title: Campaign description: A summary of an individual campaign's settings and content. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: >- The date and time the campaign was created 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 long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send Time description: The date and time a campaign was sent. readOnly: true content_type: type: string title: Content Type description: How the campaign's content is put together. enum: - template - html - url - multichannel needs_block_refresh: type: boolean title: Needs Block Refresh description: >- Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: 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/create-and-send-to-a-segment/) 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: >- Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: >- Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: >- Use Mailchimp Conversation feature to manage out-of-office replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: false drag_and_drop: type: boolean title: Drag And Drop Campaign description: Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: >- Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: >- The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: >- The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: >- The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/). daily_send: type: object title: Daily Sending Days description: >- The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: >- The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: >- For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: >- For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. report_summary: type: object title: Campaign Report Summary description: >- For sent campaigns, a summary of opens, clicks, and e-commerce data. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: >- The total number of emails canceled for this campaign. readOnly: true resend_shortcut_eligibility: type: object title: Resend Shortcut Eligibility description: >- Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`. properties: to_non_openers: type: object title: To Non-Openers description: >- Determines if the campaign qualifies to be resent to non-openers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_new_subscribers: type: object title: To New Subscribers description: >- Determines if the campaign qualifies to be resent to new subscribers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_non_clickers: type: object title: To Non-Clickers description: >- Determines if the campaign qualifies to be resent to non-clickers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. 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: Campaigns description: An array of campaigns. 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: - Campaigns x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Campaign description: Create a new Mailchimp campaign. operationId: postCampaigns parameters: - name: body in: body description: '' required: true schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. required: - type properties: type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate recipients: type: object title: List description: List settings for the campaign. required: - list_id properties: list_id: type: string title: List ID description: The unique list id. 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. 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. Note: while this field is not required for campaign creation, it is required for sending. use_conversation: type: boolean title: Conversation description: >- Use Mailchimp Conversation feature to manage out-of-office replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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 of the template to use. variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. required: - winner_criteria properties: winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options, specific to an RSS campaign. required: - feed_url - frequency properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. 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. content_type: type: string title: Content Type description: >- How the campaign's content is put together. The old drag and drop editor uses 'template' while the new editor uses 'multichannel'. Defaults to template. example: template enum: - template - multichannel example: example_value responses: '200': description: '' schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: The date and time the campaign was created 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 long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send Time description: The date and time a campaign was sent. readOnly: true content_type: type: string title: Content Type description: How the campaign's content is put together. enum: - template - html - url - multichannel needs_block_refresh: type: boolean title: Needs Block Refresh description: >- Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: 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/create-and-send-to-a-segment/) 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: >- Use Mailchimp Conversation feature to manage out-of-office replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: false drag_and_drop: type: boolean title: Drag And Drop Campaign description: Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. report_summary: type: object title: Campaign Report Summary description: >- For sent campaigns, a summary of opens, clicks, and e-commerce data. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. readOnly: true resend_shortcut_eligibility: type: object title: Resend Shortcut Eligibility description: >- Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`. properties: to_non_openers: type: object title: To Non-Openers description: >- Determines if the campaign qualifies to be resent to non-openers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_new_subscribers: type: object title: To New Subscribers description: >- Determines if the campaign qualifies to be resent to new subscribers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_non_clickers: type: object title: To Non-Clickers description: >- Determines if the campaign qualifies to be resent to non-clickers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. 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: - Campaigns x-custom-config: methodNameSnake: create methodNameCamel: create x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}: get: summary: Mailchimp Get Campaign Info description: Get information about a specific campaign. operationId: getCampaignsId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: include_resend_shortcut_eligibility x-title: Include Resend Shortcut Eligibility in: query description: >- Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered. required: false type: boolean example: example_value responses: '200': description: '' schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: The date and time the campaign was created 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 long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send Time description: The date and time a campaign was sent. readOnly: true content_type: type: string title: Content Type description: How the campaign's content is put together. enum: - template - html - url - multichannel needs_block_refresh: type: boolean title: Needs Block Refresh description: >- Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: 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/create-and-send-to-a-segment/) 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: >- Use Mailchimp Conversation feature to manage out-of-office replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: false drag_and_drop: type: boolean title: Drag And Drop Campaign description: Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. report_summary: type: object title: Campaign Report Summary description: >- For sent campaigns, a summary of opens, clicks, and e-commerce data. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. readOnly: true resend_shortcut_eligibility: type: object title: Resend Shortcut Eligibility description: >- Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`. properties: to_non_openers: type: object title: To Non-Openers description: >- Determines if the campaign qualifies to be resent to non-openers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_new_subscribers: type: object title: To New Subscribers description: >- Determines if the campaign qualifies to be resent to new subscribers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_non_clickers: type: object title: To Non-Clickers description: >- Determines if the campaign qualifies to be resent to non-clickers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. 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: - Campaigns x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Campaign Settings description: Update some or all of the settings for a specific campaign. operationId: patchCampaignsId parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: body name: body description: '' required: true schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. required: - settings properties: recipients: type: object title: List description: List settings for the campaign. required: - list_id properties: list_id: type: string title: List ID description: The unique list id. 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. required: - subject_line - from_name - reply_to 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. use_conversation: type: boolean title: Conversation description: >- Use Mailchimp Conversation feature to manage out-of-office replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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 of the template to use. variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. required: - winner_criteria properties: winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. required: - feed_url - frequency properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. 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. example: example_value responses: '200': description: '' schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: The date and time the campaign was created 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 long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send Time description: The date and time a campaign was sent. readOnly: true content_type: type: string title: Content Type description: How the campaign's content is put together. enum: - template - html - url - multichannel needs_block_refresh: type: boolean title: Needs Block Refresh description: >- Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: 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/create-and-send-to-a-segment/) 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: >- Use Mailchimp Conversation feature to manage out-of-office replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: false drag_and_drop: type: boolean title: Drag And Drop Campaign description: Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. report_summary: type: object title: Campaign Report Summary description: >- For sent campaigns, a summary of opens, clicks, and e-commerce data. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. readOnly: true resend_shortcut_eligibility: type: object title: Resend Shortcut Eligibility description: >- Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`. properties: to_non_openers: type: object title: To Non-Openers description: >- Determines if the campaign qualifies to be resent to non-openers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_new_subscribers: type: object title: To New Subscribers description: >- Determines if the campaign qualifies to be resent to new subscribers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_non_clickers: type: object title: To Non-Clickers description: >- Determines if the campaign qualifies to be resent to non-clickers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. 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: - Campaigns x-custom-config: methodNameSnake: update methodNameCamel: update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Campaign description: Remove a campaign from your Mailchimp account. operationId: deleteCampaignsId parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' 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: - Campaigns x-custom-config: methodNameSnake: remove methodNameCamel: remove x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/cancel-send: post: summary: Mailchimp Cancel Campaign description: >- Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro. operationId: postCampaignsIdActionsCancelSend x-pro-required: true parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' 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: - Actions - Campaigns - Cancels - Send x-custom-config: methodNameSnake: cancel_send methodNameCamel: cancelSend x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/replicate: post: summary: Mailchimp Replicate Campaign description: Replicate a campaign in saved or send status. operationId: postCampaignsIdActionsReplicate parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. required: - type properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: The date and time the campaign was created in ISO 8601 format. readOnly: true archive_url: type: string title: Archive URL description: The link to the campaign's archive version. readOnly: true long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send 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 campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: true recipients: type: object title: List description: List settings for the campaign. required: - list_id properties: list_id: type: string title: List ID description: The unique list id. 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/save-and-manage-segments/) 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: Use Mailchimp Conversation feature to manage replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: true drag_and_drop: type: boolean title: Drag And Drop Campaign description: Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. required: - winner_criteria properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. required: - feed_url - frequency properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. 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: - Actions - Campaigns - Replicate x-custom-config: methodNameSnake: replicate methodNameCamel: replicate x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/send: post: summary: Mailchimp Send Campaign description: >- Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately. operationId: postCampaignsIdActionsSend parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' 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: - Actions - Campaigns - Send x-custom-config: methodNameSnake: send methodNameCamel: send x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/schedule: post: summary: Mailchimp Schedule Campaign description: >- Schedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead. operationId: postCampaignsIdActionsSchedule parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: body name: body description: '' required: true schema: type: object required: - schedule_time properties: schedule_time: type: string title: Schedule Time format: date-time description: >- The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45). timewarp: type: boolean title: Timewarp description: >- Choose whether the campaign should use [Timewarp](https://mailchimp.com/help/use-timewarp/) when sending. Campaigns scheduled with Timewarp are localized based on the recipients' time zones. For example, a Timewarp campaign with a `schedule_time` of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to `true` for campaigns using [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/). batch_delivery: type: object title: Batch Delivery description: >- Choose whether the campaign should use [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/). Cannot be set to `true` for campaigns using [Timewarp](https://mailchimp.com/help/use-timewarp/). required: - batch_delay - batch_count properties: batch_delay: type: integer title: Batch Delay description: The delay, in minutes, between batches. batch_count: type: integer title: Batch Count description: The number of batches for the campaign send. example: example_value 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: - Actions - Campaigns - Schedules x-custom-config: methodNameSnake: schedule methodNameCamel: schedule x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/unschedule: post: summary: Mailchimp Unschedule Campaign description: Unschedule a scheduled campaign that hasn't started sending. operationId: postCampaignsIdActionsUnschedule parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' 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: - Actions - Campaigns x-custom-config: methodNameSnake: unschedule methodNameCamel: unschedule x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/test: post: summary: Mailchimp Send Test Email description: Send a test email. operationId: postCampaignsIdActionsTest parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: body name: body description: '' required: true schema: type: object required: - test_emails - send_type properties: test_emails: type: array title: Test Emails description: An array of email addresses to send the test email to. items: type: string send_type: type: string enum: - html - plaintext title: Type of email to test description: Choose the type of test email to send. example: example_value 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: - Actions - Campaigns - Tests x-custom-config: methodNameSnake: send_test_email methodNameCamel: sendTestEmail x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/pause: post: summary: Mailchimp Pause Rss Campaign description: Pause an RSS-Driven campaign. operationId: postCampaignsIdActionsPause parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' 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: - Actions - Campaigns - Pause x-custom-config: methodNameSnake: pause methodNameCamel: pause x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/resume: post: summary: Mailchimp Resume Rss Campaign description: Resume an RSS-Driven campaign. operationId: postCampaignsIdActionsResume parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' 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: - Actions - Campaigns - Resume x-custom-config: methodNameSnake: resume methodNameCamel: resume x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/actions/create-resend: post: summary: Mailchimp Resend Campaign description: >- Remove the guesswork for resending a campaign to certain segments. You can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent. operationId: postCampaignsIdActionsCreateResend x-pro-required: true parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: body name: body description: '' required: false schema: type: object properties: shortcut_type: type: string title: Resend Shortcut Type description: >- Which campaign resend shortcut to use. Default is `to_non_openers`. enum: - to_non_openers - to_new_subscribers - to_non_clickers example: example_value responses: '200': description: '' schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. required: - type properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: The date and time the campaign was created in ISO 8601 format. readOnly: true archive_url: type: string title: Archive URL description: The link to the campaign's archive version. readOnly: true long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send 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 campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: true recipients: type: object title: List description: List settings for the campaign. required: - list_id properties: list_id: type: string title: List ID description: The unique list id. 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/save-and-manage-segments/) 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: Use Mailchimp Conversation feature to manage replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: true drag_and_drop: type: boolean title: Drag And Drop Campaign description: Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. required: - winner_criteria properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. required: - feed_url - frequency properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. 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: - Actions - Campaigns - Resend x-custom-config: methodNameSnake: create_resend methodNameCamel: createResend x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/content: get: summary: Mailchimp Get Campaign Content description: Get the the HTML and plain-text content for a campaign. operationId: getCampaignsIdContent 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Campaign Content description: The HTML and plain-text content for a campaign. properties: variate_contents: type: array title: Variate Contents description: Content options for multivariate campaigns. items: type: object properties: content_label: type: string title: Content Label description: Label used to identify the content option. example: Green header plain_text: type: string title: Plain Text description: >- The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. html: type: string title: Campaign HTML description: The raw HTML for the campaign. example: >- *|MC:SUBJECT|* plain_text: type: string title: Plain Text description: >- The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. html: type: string title: Campaign HTML description: The raw HTML for the campaign. archive_html: type: string title: Campaign Archive HTML description: The Archive HTML for the campaign. example: >- My Subject _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: - Campaigns - Content x-custom-config: methodNameSnake: get_content methodNameCamel: getContent x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Set Campaign Content description: Set the content for a campaign. operationId: putCampaignsIdContent parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: body name: body description: '' required: true schema: type: object title: Campaign Content description: The HTML and plain-text content for a campaign properties: plain_text: type: string title: Plain Text description: >- The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. html: type: string title: Campaign HTML description: The raw HTML for the campaign. url: type: string title: Campaign URL description: When importing a campaign, the URL where the HTML lives. template: type: object title: Template Content description: Use this template to generate the HTML content of the campaign required: - id properties: id: type: integer title: Template ID description: The id of the template to use. sections: type: object title: Template Sections description: >- Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template. archive: type: object title: Upload Archive description: >- Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/). required: - archive_content properties: archive_content: type: string title: Archive Content description: The base64-encoded representation of the archive file. archive_type: type: string enum: - zip - tar.gz - tar.bz2 - tar - tgz - tbz title: Archive Type description: The type of encoded file. Defaults to zip. variate_contents: type: array title: Variate Contents description: >- Content options for [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/). Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided. items: type: object required: - content_label properties: content_label: type: string title: Content Label description: The label used to identify the content option. plain_text: type: string title: Plain Text description: >- The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. html: type: string title: Campaign HTML description: The raw HTML for the campaign. url: type: string title: Campaign URL description: When importing a campaign, the URL for the HTML. template: type: object title: Template Content description: >- Use this template to generate the HTML content for the campaign. required: - id properties: id: type: integer title: Template ID description: The id of the template to use. sections: type: object title: Template Sections description: >- Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template. archive: type: object title: Upload Archive description: >- Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/). required: - archive_content properties: archive_content: type: string title: Archive Content description: >- The base64-encoded representation of the archive file. archive_type: type: string enum: - zip - tar.gz - tar.bz2 - tar - tgz - tbz title: Archive Type description: The type of encoded file. Defaults to zip. example: example_value responses: '200': description: '' schema: type: object title: Campaign Content description: The HTML and plain-text content for a campaign. properties: variate_contents: type: array title: Variate Contents description: Content options for multivariate campaigns. items: type: object properties: content_label: type: string title: Content Label description: Label used to identify the content option. example: Green header plain_text: type: string title: Plain Text description: >- The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. html: type: string title: Campaign HTML description: The raw HTML for the campaign. example: >- *|MC:SUBJECT|* plain_text: type: string title: Plain Text description: >- The plain-text portion of the campaign. If left unspecified, we'll generate this automatically. html: type: string title: Campaign HTML description: The raw HTML for the campaign. archive_html: type: string title: Campaign Archive HTML description: The Archive HTML for the campaign. example: >- My Subject _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: - Campaigns - Content x-custom-config: methodNameSnake: set_content methodNameCamel: setContent x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/feedback: get: summary: Mailchimp List Campaign Feedback description: Get team feedback while you're working together on a Mailchimp campaign. operationId: getCampaignsIdFeedback 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Campaign Reports description: A summary of the comment feedback for a specific campaign. properties: feedback: type: array items: type: object title: Campaign Feedback description: A specific feedback message from a specific campaign. required: - message properties: feedback_id: type: integer title: Feedback ID description: The individual id for the feedback item. readOnly: true parent_id: type: integer title: Parent ID description: If a reply, the id of the parent feedback item. readOnly: true block_id: type: integer title: Block ID description: >- The block id for the editable block that the feedback addresses. message: type: string title: Message description: The content of the feedback. is_complete: type: boolean title: Complete description: The status of feedback. created_by: type: string title: Created By description: The login name of the user who created the feedback. readOnly: true created_at: type: string title: Created At description: >- The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true updated_at: type: string title: Updated At description: >- The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true source: type: string title: Source description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: Campaign Feedback description: A collection of feedback items for a campaign. campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Campaigns - Feedback x-custom-config: methodNameSnake: get_feedback methodNameCamel: getFeedback x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Campaign Feedback description: Add feedback on a specific campaign. operationId: postCampaignsIdFeedback parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: body name: body description: '' required: true schema: type: object title: Campaign Feedback description: A specific feedback message from a specific campaign. required: - message properties: block_id: type: integer title: Block ID description: >- The block id for the editable block that the feedback addresses. message: type: string title: Message description: The content of the feedback. is_complete: type: boolean title: Complete description: The status of feedback. example: example_value responses: '200': description: '' schema: type: object title: Campaign Feedback description: A specific feedback message from a specific campaign. properties: feedback_id: type: integer title: Feedback ID description: The individual id for the feedback item. readOnly: true parent_id: type: integer title: Parent ID description: If a reply, the id of the parent feedback item. readOnly: true block_id: type: integer title: Block ID description: >- The block id for the editable block that the feedback addresses. message: type: string title: Message description: The content of the feedback. is_complete: type: boolean title: Complete description: The status of feedback. created_by: type: string title: Created By description: The login name of the user who created the feedback. readOnly: true created_at: type: string title: Created At description: >- The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true updated_at: type: string title: Updated At description: >- The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true source: type: string title: Source description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Campaigns - Feedback x-custom-config: methodNameSnake: add_feedback methodNameCamel: addFeedback x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/feedback/{feedback_id}: get: summary: Mailchimp Get Campaign Feedback Message description: Get a specific feedback message from a campaign. operationId: getCampaignsIdFeedbackId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: path name: feedback_id x-title: Feedback ID type: string required: true description: The unique id for the feedback message. example: '500123' responses: '200': description: '' schema: type: object title: Campaign Feedback description: A specific feedback message from a specific campaign. properties: feedback_id: type: integer title: Feedback ID description: The individual id for the feedback item. readOnly: true parent_id: type: integer title: Parent ID description: If a reply, the id of the parent feedback item. readOnly: true block_id: type: integer title: Block ID description: >- The block id for the editable block that the feedback addresses. message: type: string title: Message description: The content of the feedback. is_complete: type: boolean title: Complete description: The status of feedback. created_by: type: string title: Created By description: The login name of the user who created the feedback. readOnly: true created_at: type: string title: Created At description: >- The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true updated_at: type: string title: Updated At description: >- The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true source: type: string title: Source description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Campaigns - Feedback x-custom-config: methodNameSnake: get_feedback_message methodNameCamel: getFeedbackMessage x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Campaign Feedback Message description: Update a specific feedback message for a campaign. operationId: patchCampaignsIdFeedbackId parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: path name: feedback_id x-title: Feedback ID type: string required: true description: The unique id for the feedback message. example: '500123' - in: body name: body description: '' required: true schema: type: object title: Campaign Feedback description: A specific feedback message from a specific campaign. properties: block_id: type: integer title: Block ID description: >- The block id for the editable block that the feedback addresses. message: type: string title: Message description: The content of the feedback. is_complete: type: boolean title: Complete description: The status of feedback. example: example_value responses: '200': description: '' schema: type: object title: Campaign Feedback description: A specific feedback message from a specific campaign. properties: feedback_id: type: integer title: Feedback ID description: The individual id for the feedback item. readOnly: true parent_id: type: integer title: Parent ID description: If a reply, the id of the parent feedback item. readOnly: true block_id: type: integer title: Block ID description: >- The block id for the editable block that the feedback addresses. message: type: string title: Message description: The content of the feedback. is_complete: type: boolean title: Complete description: The status of feedback. created_by: type: string title: Created By description: The login name of the user who created the feedback. readOnly: true created_at: type: string title: Created At description: >- The date and time the feedback item was created in ISO 8601 format. format: date-time readOnly: true updated_at: type: string title: Updated At description: >- The date and time the feedback was last updated in ISO 8601 format. format: date-time readOnly: true source: type: string title: Source description: The source of the feedback. enum: - api - email - sms - web - ios - android readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Campaigns - Feedback x-custom-config: methodNameSnake: update_feedback_message methodNameCamel: updateFeedbackMessage x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Campaign Feedback Message description: Remove a specific feedback message for a campaign. operationId: deleteCampaignsIdFeedbackId parameters: - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: path name: feedback_id x-title: Feedback ID type: string required: true description: The unique id for the feedback message. example: '500123' 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: - Campaigns - Feedback x-custom-config: methodNameSnake: delete_feedback_message methodNameCamel: deleteFeedbackMessage x-microcks-operation: delay: 0 dispatcher: FALLBACK /campaigns/{campaign_id}/send-checklist: get: summary: Mailchimp Get Campaign Send Checklist description: >- Review the send checklist for a campaign, and resolve any issues before sending. operationId: getCampaignsIdSendChecklist 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Send Checklist description: The send checklist for the campaign. properties: is_ready: type: boolean title: Ready? description: Whether the campaign is ready to send. items: type: array title: Items description: >- A list of feedback items to review before sending your campaign. items: type: object properties: type: type: string title: Type description: The item type. enum: - success - warning - error id: type: integer title: ID description: The ID for the specific item. heading: type: string title: Heading description: The heading for the specific item. details: type: string title: Details description: Details about the specific feedback item. _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: - Campaigns - Checklist - Send x-custom-config: methodNameSnake: get_send_checklist methodNameCamel: getSendChecklist x-microcks-operation: delay: 0 dispatcher: FALLBACK /connected-sites: get: summary: Mailchimp List Connected Sites description: Get all connected sites in an account. operationId: getConnectedSites 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Connected Sites description: A collection of connected sites in the account. properties: sites: type: array items: type: object title: Connected Site description: Information about a specific connected site. properties: foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the site. readOnly: true example: >- a180c384d7db88b if created in-app, MC001 if created via API store_id: type: string title: Store ID description: >- The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. readOnly: true example: MC001 platform: type: string title: Connected Site Platform description: The platform of the connected site. readOnly: true example: shopify, magento, bigcommerce, woocommerce domain: type: string title: Domain description: The connected site domain. readOnly: true example: example.myshopify.com site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: >- The URL used for any integrations that offer built-in support for connected sites. example: >- https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: >- A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: >- created_at: type: string title: Creation Time format: date-time description: >- The date and time the connected site was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the connected site was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:35:00+00:00' _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: Connected Sites description: An array of objects, each representing a connected site. 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: - Connected - Connected Sites x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Connected Site description: Create a new Mailchimp connected site. operationId: postConnectedSites parameters: - name: body in: body description: '' required: true schema: type: object title: Connected Site description: Information about a specific connected site. required: - foreign_id - domain properties: foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the site. example: MC001 domain: type: string title: Domain description: The connected site domain. example: example.com example: example_value responses: '200': description: '' schema: type: object title: Connected Site description: Information about a specific connected site. properties: foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the site. readOnly: true example: a180c384d7db88b if created in-app, MC001 if created via API store_id: type: string title: Store ID description: >- The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. readOnly: true example: MC001 platform: type: string title: Connected Site Platform description: The platform of the connected site. readOnly: true example: shopify, magento, bigcommerce, woocommerce domain: type: string title: Domain description: The connected site domain. readOnly: true example: example.myshopify.com site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: >- The URL used for any integrations that offer built-in support for connected sites. example: >- https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: >- A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: >- created_at: type: string title: Creation Time format: date-time description: >- The date and time the connected site was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the connected site was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:35:00+00:00' _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: - Connected - Connected Sites x-custom-config: methodNameSnake: create methodNameCamel: create x-microcks-operation: delay: 0 dispatcher: FALLBACK /connected-sites/{connected_site_id}: get: summary: Mailchimp Get Connected Site description: Get information about a specific connected site. operationId: getConnectedSitesId 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 example: example_value - 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 example: example_value - in: path name: connected_site_id x-title: Connected Site Foreign ID type: string required: true description: The unique identifier for the site. example: '500123' responses: '200': description: '' schema: type: object title: Connected Site description: Information about a specific connected site. properties: foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the site. readOnly: true example: a180c384d7db88b if created in-app, MC001 if created via API store_id: type: string title: Store ID description: >- The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change. readOnly: true example: MC001 platform: type: string title: Connected Site Platform description: The platform of the connected site. readOnly: true example: shopify, magento, bigcommerce, woocommerce domain: type: string title: Domain description: The connected site domain. readOnly: true example: example.myshopify.com site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: >- The URL used for any integrations that offer built-in support for connected sites. example: >- https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: >- A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. example: >- created_at: type: string title: Creation Time format: date-time description: >- The date and time the connected site was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the connected site was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:35:00+00:00' _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: - Connected - Connected_site_id x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Connected Site description: Remove a connected site from your Mailchimp account. operationId: deleteConnectedSitesId parameters: - in: path name: connected_site_id x-title: Connected Site Foreign ID type: string required: true description: The unique identifier for the site. example: '500123' 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: - Connected - Connected_site_id x-custom-config: methodNameSnake: remove methodNameCamel: remove x-microcks-operation: delay: 0 dispatcher: FALLBACK /connected-sites/{connected_site_id}/actions/verify-script-installation: post: summary: Mailchimp Verify Connected Site Script description: >- Verify that the connected sites script has been installed, either via the script URL or fragment. operationId: postConnectedSitesIdActionsVerifyScriptInstallation x-pro-required: true parameters: - in: path name: connected_site_id x-title: Connected Site Foreign ID type: string required: true description: The unique identifier for the site. example: '500123' 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: - Actions - Connected - Connected_site_id - Installation - Scripts - Verify x-custom-config: methodNameSnake: verify_script_installation methodNameCamel: verifyScriptInstallation x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations: get: summary: Mailchimp List Conversations description: >- Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages arent available using this endpoint. operationId: getConversations 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: has_unread_messages x-title: Has Unread Messages in: query description: Whether the conversation has any unread messages. required: false type: string enum: - 'true' - 'false' example: example_value - name: list_id x-title: List ID in: query description: The unique id for the list. required: false type: string example: '500123' - name: campaign_id x-title: Campaign ID in: query description: The unique id for the campaign. required: false type: string example: '500123' responses: '200': description: '' schema: type: object title: Tracked Conversations description: A collection of this account's tracked conversations. properties: conversations: type: array items: type: object title: Conversation description: >- Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: id: type: string title: ID description: A string that uniquely identifies this conversation. readOnly: true message_count: type: integer title: Message Count description: The total number of messages in this conversation. readOnly: true campaign_id: type: string title: Campaign ID description: >- The unique identifier of the campaign for this conversation. readOnly: true list_id: type: string title: List ID description: The unique identifier of the list for this conversation. readOnly: true unread_messages: type: integer title: Unread Messages description: The number of unread messages in this conversation. readOnly: true from_label: type: string title: From Label description: A label representing the sender of this message. readOnly: true from_email: type: string title: From Email description: >- A label representing the email of the sender of this message. readOnly: true subject: type: string title: Subject description: The subject of the message. readOnly: true last_message: type: object title: Last Message description: The most recent message in the conversation. properties: from_label: type: string title: From Label description: A label representing the sender of this message. readOnly: true from_email: type: string title: From Email description: >- A label representing the email of the sender of this message. readOnly: true subject: type: string title: Subject description: The subject of this message. readOnly: true message: type: string title: Message description: The plain-text content of the message. readOnly: true read: type: boolean title: Read description: Whether this message has been marked as read. timestamp: type: string title: Timestamp description: >- The date and time the message was either sent or received in ISO 8601 format. format: date-time 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: Conversations description: A list of conversations. 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: true tags: - Conversations x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations/{conversation_id}: get: summary: Mailchimp Get Conversation description: >- Get details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages arent available using this endpoint. operationId: getConversationsId 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 example: example_value - 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 example: example_value - in: path name: conversation_id x-title: Conversation ID type: string required: true description: The unique id for the conversation. example: '500123' responses: '200': description: '' schema: type: object title: Conversation description: >- Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: id: type: string title: ID description: A string that uniquely identifies this conversation. readOnly: true message_count: type: integer title: Message Count description: The total number of messages in this conversation. readOnly: true campaign_id: type: string title: Campaign ID description: The unique identifier of the campaign for this conversation. readOnly: true list_id: type: string title: List ID description: The unique identifier of the list for this conversation. readOnly: true unread_messages: type: integer title: Unread Messages description: The number of unread messages in this conversation. readOnly: true from_label: type: string title: From Label description: A label representing the sender of this message. readOnly: true from_email: type: string title: From Email description: A label representing the email of the sender of this message. readOnly: true subject: type: string title: Subject description: The subject of the message. readOnly: true last_message: type: object title: Last Message description: The most recent message in the conversation. properties: from_label: type: string title: From Label description: A label representing the sender of this message. readOnly: true from_email: type: string title: From Email description: >- A label representing the email of the sender of this message. readOnly: true subject: type: string title: Subject description: The subject of this message. readOnly: true message: type: string title: Message description: The plain-text content of the message. readOnly: true read: type: boolean title: Read description: Whether this message has been marked as read. timestamp: type: string title: Timestamp description: >- The date and time the message was either sent or received in ISO 8601 format. format: date-time 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: true tags: - Conversations x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations/{conversation_id}/messages: get: summary: Mailchimp List Messages description: >- Get messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages arent available using this endpoint. operationId: getConversationsIdMessages 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 example: example_value - 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 example: example_value - in: path name: conversation_id x-title: Conversation ID type: string required: true description: The unique id for the conversation. example: '500123' - name: is_read x-title: Is Read in: query description: Whether a conversation message has been marked as read. required: false type: string enum: - 'true' - 'false' example: example_value - name: before_timestamp x-title: Before Timestamp in: query description: >- Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value - name: since_timestamp x-title: Since Timestamp in: query description: >- Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value responses: '200': description: '' schema: type: object title: Collection of Conversation Messages description: Messages from a specific conversation. properties: conversation_messages: type: array items: type: object title: Conversation Message description: >- An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: id: type: string title: ID description: A string that uniquely identifies this message readOnly: true conversation_id: type: string title: Conversation ID description: A string that identifies this message's conversation readOnly: true list_id: type: integer title: List ID description: The list's web ID readOnly: true from_label: type: string title: From Label description: A label representing the sender of this message readOnly: true from_email: type: string title: From Email description: >- A label representing the email of the sender of this message subject: type: string title: Subject description: The subject of this message message: type: string title: Message description: The plain-text content of the message read: type: boolean title: Read description: Whether this message has been marked as read timestamp: type: string title: Timestamp description: >- The date and time the message was either sent or received in ISO 8601 format. format: date-time 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: Conversation Messages description: >- An array of objects, each representing a conversation messages resources. conversation_id: type: string title: Conversation ID description: A string that identifies this conversation. 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: true tags: - Conversations - Messages x-custom-config: methodNameSnake: get_conversation_messages methodNameCamel: getConversationMessages x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations/{conversation_id}/messages/{message_id}: get: summary: Mailchimp Get Message description: >- Get an individual message in a conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages arent available using this endpoint. operationId: getConversationsIdMessagesId 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 example: example_value - 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 example: example_value - in: path name: conversation_id x-title: Conversation ID type: string required: true description: The unique id for the conversation. example: '500123' - in: path name: message_id x-title: Message ID type: string required: true description: The unique id for the conversation message. example: '500123' responses: '200': description: '' schema: type: object title: Conversation Message description: >- An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account. properties: id: type: string title: ID description: A string that uniquely identifies this message readOnly: true conversation_id: type: string title: Conversation ID description: A string that identifies this message's conversation readOnly: true list_id: type: integer title: List ID description: The list's web ID readOnly: true from_label: type: string title: From Label description: A label representing the sender of this message readOnly: true from_email: type: string title: From Email description: A label representing the email of the sender of this message subject: type: string title: Subject description: The subject of this message message: type: string title: Message description: The plain-text content of the message read: type: boolean title: Read description: Whether this message has been marked as read timestamp: type: string title: Timestamp description: >- The date and time the message was either sent or received in ISO 8601 format. format: date-time 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: true tags: - Conversations - Messages x-custom-config: methodNameSnake: get_conversation_message methodNameCamel: getConversationMessage x-microcks-operation: delay: 0 dispatcher: FALLBACK /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger: post: summary: Mailchimp Customer Journeys Api Trigger for a Contact description: >- A step trigger in a Customer Journey. To use it, create a starting point or step from the Customer Journey builder in the app using the Customer Journeys API condition. Well provide a url during the process that includes the {journey_id} and {step_id}. Youll then be able to use this endpoint to trigger the condition for the posted contact. operationId: postCustomerJourneysJourneysIdStepsIdActionsTrigger parameters: - in: path name: journey_id x-title: Journey ID type: integer required: true description: The id for the Journey. example: '500123' - in: path name: step_id x-title: Step ID type: integer required: true description: The id for the Step. example: '500123' - name: body in: body description: '' required: true schema: type: object title: Subscriber in Customer Journey's audience description: Information about subscribers in a Customer Journey's audience. required: - email_address properties: email_address: type: string title: Email Address description: The list member's email address. example: example_value responses: '204': description: An empty response schema: 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: - Actions - Customers - Journeys - Steps - Trigger x-custom-config: methodNameSnake: trigger methodNameCamel: trigger x-microcks-operation: delay: 0 dispatcher: FALLBACK /file-manager/files: get: summary: Mailchimp List Stored Files description: >- Get a list of available images and files stored in the File Manager for the account. operationId: getFileManagerFiles 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: type x-title: File Type in: query description: The file type for the File Manager file. required: false type: string example: example_value - name: created_by x-title: Created By in: query description: The Mailchimp account user who created the File Manager file. required: false type: string example: example_value - name: before_created_at x-title: Before Created At in: query description: >- Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: since_created_at x-title: Since Created At in: query description: >- Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - added_date - name - size example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: '' schema: type: object title: File Manager description: >- A list of available images and files stored in the File Manager for the account. properties: files: type: array items: type: object title: Gallery File description: An individual file listed in the File Manager. properties: id: type: integer title: File ID description: The unique id of the file. readOnly: true folder_id: type: integer title: Folder ID description: The id of the folder. type: enum: - image - file type: string title: File Type description: The type of file in the File Manager. readOnly: true name: type: string title: File Name description: The name of the file. full_size_url: type: string title: File URL description: The url of the full-size file. format: uri readOnly: true thumbnail_url: type: string title: Thumbnail URL description: The url of the thumbnail preview. format: uri readOnly: true size: type: integer title: File Size description: The size of the file in bytes. readOnly: true created_at: type: string title: Created Date description: >- The date and time a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The username of the profile that uploaded the file. readOnly: true width: type: integer title: Image Width description: The width of the image. readOnly: true height: type: integer title: Image Height description: The height of an image. 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: Files description: ' A list of files and images in an account.' total_file_size: type: number title: Total File Size description: The total size of all File Manager files in bytes. 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: - Files - Managers x-custom-config: methodNameSnake: files methodNameCamel: files x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add File description: Upload a new image or file to the File Manager. operationId: postFileManagerFiles parameters: - name: body in: body required: true schema: type: object title: Gallery File description: An individual file listed in the File Manager. required: - name - file_data properties: folder_id: type: integer title: Folder ID description: The id of the folder. name: type: string title: File Name description: The name of the file. file_data: type: string title: File Data description: The base64-encoded contents of the file. description: '' example: example_value responses: '200': description: '' schema: type: object title: Gallery File description: An individual file listed in the File Manager. properties: id: type: integer title: File ID description: The unique id of the file. readOnly: true folder_id: type: integer title: Folder ID description: The id of the folder. type: enum: - image - file type: string title: File Type description: The type of file in the File Manager. readOnly: true name: type: string title: File Name description: The name of the file. full_size_url: type: string title: File URL description: The url of the full-size file. format: uri readOnly: true thumbnail_url: type: string title: Thumbnail URL description: The url of the thumbnail preview. format: uri readOnly: true size: type: integer title: File Size description: The size of the file in bytes. readOnly: true created_at: type: string title: Created Date description: >- The date and time a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The username of the profile that uploaded the file. readOnly: true width: type: integer title: Image Width description: The width of the image. readOnly: true height: type: integer title: Image Height description: The height of an image. 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: - Files - Managers x-custom-config: methodNameSnake: upload methodNameCamel: upload x-microcks-operation: delay: 0 dispatcher: FALLBACK /file-manager/files/{file_id}: get: summary: Mailchimp Get File description: Get information about a specific file in the File Manager. operationId: getFileManagerFilesId 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 example: example_value - 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 example: example_value - in: path name: file_id x-title: File ID type: string required: true description: The unique id for the File Manager file. example: '500123' responses: '200': description: '' schema: type: object title: Gallery File description: An individual file listed in the File Manager. properties: id: type: integer title: File ID description: The unique id of the file. readOnly: true folder_id: type: integer title: Folder ID description: The id of the folder. type: enum: - image - file type: string title: File Type description: The type of file in the File Manager. readOnly: true name: type: string title: File Name description: The name of the file. full_size_url: type: string title: File URL description: The url of the full-size file. format: uri readOnly: true thumbnail_url: type: string title: Thumbnail URL description: The url of the thumbnail preview. format: uri readOnly: true size: type: integer title: File Size description: The size of the file in bytes. readOnly: true created_at: type: string title: Created Date description: >- The date and time a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The username of the profile that uploaded the file. readOnly: true width: type: integer title: Image Width description: The width of the image. readOnly: true height: type: integer title: Image Height description: The height of an image. 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: - File Manager - Files - Managers x-custom-config: methodNameSnake: get_file methodNameCamel: getFile x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update File description: Update a file in the File Manager. operationId: patchFileManagerFilesId parameters: - in: path name: file_id x-title: File ID type: string required: true description: The unique id for the File Manager file. example: '500123' - name: body in: body required: true schema: type: object title: Gallery File description: An individual file listed in the File Manager. properties: folder_id: type: integer title: Folder ID description: >- The id of the folder. Setting `folder_id` to `0` will remove a file from its current folder. name: type: string title: File Name description: The name of the file. description: '' example: example_value responses: '200': description: '' schema: type: object title: Gallery File description: An individual file listed in the File Manager. properties: id: type: integer title: File ID description: The unique id of the file. readOnly: true folder_id: type: integer title: Folder ID description: The id of the folder. type: enum: - image - file type: string title: File Type description: The type of file in the File Manager. readOnly: true name: type: string title: File Name description: The name of the file. full_size_url: type: string title: File URL description: The url of the full-size file. format: uri readOnly: true thumbnail_url: type: string title: Thumbnail URL description: The url of the thumbnail preview. format: uri readOnly: true size: type: integer title: File Size description: The size of the file in bytes. readOnly: true created_at: type: string title: Created Date description: >- The date and time a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The username of the profile that uploaded the file. readOnly: true width: type: integer title: Image Width description: The width of the image. readOnly: true height: type: integer title: Image Height description: The height of an image. 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: - File Manager - Files - Managers x-custom-config: methodNameSnake: update_file methodNameCamel: updateFile x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete File description: Remove a specific file from the File Manager. operationId: deleteFileManagerFilesId parameters: - in: path name: file_id x-title: File ID type: string required: true description: The unique id for the File Manager file. example: '500123' 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: - File Manager - Files - Managers x-custom-config: methodNameSnake: delete_file methodNameCamel: deleteFile x-microcks-operation: delay: 0 dispatcher: FALLBACK /file-manager/folders: get: summary: Mailchimp List Folders description: Get a list of all folders in the File Manager. operationId: getFileManagerFolders 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: created_by x-title: Created By in: query description: The Mailchimp account user who created the File Manager file. required: false type: string example: example_value - name: before_created_at x-title: Before Created At in: query description: >- Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: since_created_at x-title: Since Created At in: query description: >- Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' responses: '200': description: '' schema: type: object title: File Manager Folders description: A list of all folders in the File Manager. properties: folders: type: array items: type: object title: Gallery Folder description: An individual folder listed in the File Manager. properties: id: type: integer title: Folder ID description: The unique id for the folder. readOnly: true name: type: string title: Folder Name description: The name of the folder. file_count: type: integer title: File Count description: The number of files in the folder. readOnly: true created_at: type: string title: Created Date format: date-time description: >- The date and time a file was added to the File Manager in ISO 8601 format. readOnly: true created_by: type: string title: Created By description: The username of the profile that created the folder. 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: File Manager Folders description: A list of all folders in the File Manager. 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: - Files - Folders - Managers x-custom-config: methodNameSnake: list_folders methodNameCamel: listFolders x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Folder description: Create a new folder in the File Manager. operationId: postFileManagerFolders parameters: - name: body in: body required: true schema: type: object title: Gallery Folder description: An individual folder listed in the File Manager. required: - name properties: name: type: string title: Folder Name description: The name of the folder. description: '' example: example_value responses: '200': description: '' schema: type: object title: Gallery Folder description: An individual folder listed in the File Manager. properties: id: type: integer title: Folder ID description: The unique id for the folder. readOnly: true name: type: string title: Folder Name description: The name of the folder. file_count: type: integer title: File Count description: The number of files in the folder. readOnly: true created_at: type: string title: Created Date format: date-time description: >- The date and time a file was added to the File Manager in ISO 8601 format. readOnly: true created_by: type: string title: Created By description: The username of the profile that created the folder. 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: - Files - Folders - Managers x-custom-config: methodNameSnake: create_folder methodNameCamel: createFolder x-microcks-operation: delay: 0 dispatcher: FALLBACK /file-manager/folders/{folder_id}: get: summary: Mailchimp Get Folder description: Get information about a specific folder in the File Manager. operationId: getFileManagerFoldersId 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 example: example_value - 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 example: example_value - in: path name: folder_id x-title: Folder ID type: string required: true description: The unique id for the File Manager folder. example: '500123' responses: '200': description: '' schema: type: object title: Gallery Folder description: An individual folder listed in the File Manager. properties: id: type: integer title: Folder ID description: The unique id for the folder. readOnly: true name: type: string title: Folder Name description: The name of the folder. file_count: type: integer title: File Count description: The number of files in the folder. readOnly: true created_at: type: string title: Created Date format: date-time description: >- The date and time a file was added to the File Manager in ISO 8601 format. readOnly: true created_by: type: string title: Created By description: The username of the profile that created the folder. 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: - File Manager - Files - Folders - Managers x-custom-config: methodNameSnake: get_folder methodNameCamel: getFolder x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Folder description: Update a specific File Manager folder. operationId: patchFileManagerFoldersId parameters: - in: path name: folder_id x-title: Folder ID type: string required: true description: The unique id for the File Manager folder. example: '500123' - name: body in: body required: true schema: type: object title: Gallery Folder description: An individual folder listed in the File Manager. required: - name properties: name: type: string title: Folder Name description: The name of the folder. description: '' example: example_value responses: '200': description: '' schema: type: object title: Gallery Folder description: An individual folder listed in the File Manager. properties: id: type: integer title: Folder ID description: The unique id for the folder. readOnly: true name: type: string title: Folder Name description: The name of the folder. file_count: type: integer title: File Count description: The number of files in the folder. readOnly: true created_at: type: string title: Created Date format: date-time description: >- The date and time a file was added to the File Manager in ISO 8601 format. readOnly: true created_by: type: string title: Created By description: The username of the profile that created the folder. 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: - File Manager - Files - Folders - Managers x-custom-config: methodNameSnake: update_folder methodNameCamel: updateFolder x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Folder description: Delete a specific folder in the File Manager. operationId: deleteFileManagerFoldersId parameters: - in: path name: folder_id x-title: Folder ID type: string required: true description: The unique id for the File Manager folder. example: '500123' 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: - File Manager - Files - Folders - Managers x-custom-config: methodNameSnake: delete_folder methodNameCamel: deleteFolder x-microcks-operation: delay: 0 dispatcher: FALLBACK /file-manager/folders/{folder_id}/files: get: summary: Mailchimp List Stored Files description: Get a list of available images and files stored in this folder. operationId: getFileManagerFoldersFiles parameters: - in: path name: folder_id x-title: Folder ID type: string required: true description: The unique id for the File Manager folder. example: '500123' - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: type x-title: File Type in: query description: The file type for the File Manager file. required: false type: string example: example_value - name: created_by x-title: Created By in: query description: The Mailchimp account user who created the File Manager file. required: false type: string example: example_value - name: before_created_at x-title: Before Created At in: query description: >- Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: since_created_at x-title: Since Created At in: query description: >- Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - added_date - name - size example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: '' schema: type: object title: File Manager description: >- A list of available images and files stored in the File Manager for the account. properties: files: type: array items: type: object title: Gallery File description: An individual file listed in the File Manager. properties: id: type: integer title: File ID description: The unique id of the file. readOnly: true folder_id: type: integer title: Folder ID description: The id of the folder. type: enum: - image - file type: string title: File Type description: The type of file in the File Manager. readOnly: true name: type: string title: File Name description: The name of the file. full_size_url: type: string title: File URL description: The url of the full-size file. format: uri readOnly: true thumbnail_url: type: string title: Thumbnail URL description: The url of the thumbnail preview. format: uri readOnly: true size: type: integer title: File Size description: The size of the file in bytes. readOnly: true created_at: type: string title: Created Date description: >- The date and time a file was added to the File Manager in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The username of the profile that uploaded the file. readOnly: true width: type: integer title: Image Width description: The width of the image. readOnly: true height: type: integer title: Image Height description: The height of an image. 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: Files description: ' A list of files and images in an account.' total_file_size: type: number title: Total File Size description: The total size of all File Manager files in bytes. 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: - Files - Folders - Managers x-custom-config: methodNameSnake: folders_files methodNameCamel: foldersFiles x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists: get: summary: Mailchimp Get Lists Info description: Get information about all lists in the account. operationId: getLists 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: before_date_created x-title: Before Date Created in: query required: false description: >- Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string example: example_value - name: since_date_created x-title: Since Date Created in: query required: false description: >- Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string example: example_value - name: before_campaign_last_sent x-title: Before Campaign Last Sent in: query required: false description: >- Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string example: example_value - name: since_campaign_last_sent x-title: Since Campaign Last Sent in: query required: false description: >- Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string example: example_value - name: email x-title: Subscriber Email description: >- Restrict results to lists that include a specific subscriber's email address. in: query required: false type: string example: user@example.com - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - date_created example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: has_ecommerce_store x-title: Has Ecommerce Store in: query required: false description: >- Restrict results to lists that contain an active, connected, undeleted ecommerce store. type: boolean example: example_value - name: include_total_contacts x-title: Include Total Contacts in: query description: >- Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. required: false type: boolean example: example_value responses: '200': description: '' schema: type: object title: Subscriber Lists description: >- A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization. properties: lists: type: array items: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: >- The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: >- [Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws. properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: >- A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: >- The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: >- Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: >- [Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list. properties: from_name: type: string title: Sender's Name description: >- The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: >- The default from email for campaigns sent to this list. subject: type: string title: Subject description: >- The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: >- The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: >- The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: >- The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: >- Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: >- Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: >- The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: >- The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: >- Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: >- Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup. default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: >- Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: >- Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: >- The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: >- The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: >- The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: >- The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: >- The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: >- The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: >- The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: >- The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: >- The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: >- The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: >- The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: >- The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: >- The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: >- The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: >- The date and time of the last time someone unsubscribed from this list in ISO 8601 format. 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: Lists description: An array of objects, each representing a list. total_items: type: integer title: Item Count description: >- The total number of items matching the query regardless of pagination. readOnly: true constraints: type: object title: Collection Authorization description: >- Do particular authorization constraints around this collection limit creation of new instances? properties: may_create: type: boolean title: Resource creation authorization description: May the user create additional instances of this resource? max_instances: type: integer title: Max instances description: >- How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited. current_total_instances: type: integer title: Current total instances description: >- How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited. required: - may_create - max_instances _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 required: - lists 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: - Lists x-custom-config: methodNameSnake: get_all_lists methodNameCamel: getAllLists x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add List description: Create a new list in your Mailchimp account. operationId: postLists parameters: - name: body in: body required: true schema: type: object title: Subscriber List description: Information about a specific list. required: - name - permission_reminder - email_type_option - contact - campaign_defaults properties: name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: >- [Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws. required: - company - address1 - city - country properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: >- A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: >- The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: >- Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: >- [Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list. required: - from_name - from_email - subject - language properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: >- The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: >- The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false email_type_option: type: boolean title: Email Type Option description: >- Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. double_optin: type: boolean title: Double Opt In description: >- Whether or not to require the subscriber to confirm subscription via email. default: false marketing_permissions: type: boolean title: Marketing Permissions description: >- Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false example: example_value responses: '200': description: '' schema: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: >- The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: >- [Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws. properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: >- A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: >- The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: >- Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: >- [Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list. properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: >- The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: >- The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: >- The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: >- Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: >- Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: >- The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: >- The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: >- Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: >- Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup. default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: >- Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: >- Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: >- The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: >- The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: >- The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: >- The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: >- The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: >- The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: >- The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: >- The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: >- The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: >- The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: >- The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: >- The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: >- The date and time of the last time someone unsubscribed from this list in ISO 8601 format. 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: - Lists x-custom-config: methodNameSnake: create_list methodNameCamel: createList x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}: get: summary: Mailchimp Get List Info description: >- Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned. operationId: getListsId 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: include_total_contacts x-title: Include Total Contacts in: query description: >- Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. required: false type: boolean example: example_value responses: '200': description: '' schema: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: >- The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: >- [Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws. properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: >- A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: >- The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: >- Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: >- [Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list. properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: >- The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: >- The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: >- The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: >- Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: >- Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: >- The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: >- The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: >- Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: >- Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup. default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: >- Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: >- Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: >- The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: >- The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: >- The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: >- The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: >- The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: >- The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: >- The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: >- The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: >- The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: >- The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: >- The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: >- The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: >- The date and time of the last time someone unsubscribed from this list in ISO 8601 format. 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: - List_id x-custom-config: methodNameSnake: get_list methodNameCamel: getList x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Lists description: Update the settings for a specific list. operationId: patchListsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Subscriber List description: Information about a specific list. required: - name - permission_reminder - email_type_option - contact - campaign_defaults properties: name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: >- [Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws. required: - company - address1 - city - state - zip - country properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: >- A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: >- The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: >- Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: >- [Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list. required: - from_name - from_email - subject - language properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: >- The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: >- The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false email_type_option: type: boolean title: Email Type Option description: >- Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. double_optin: type: boolean title: Double Opt In description: >- Whether or not to require the subscriber to confirm subscription via email. default: false marketing_permissions: type: boolean title: Marketing Permissions description: >- Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false example: example_value responses: '200': description: '' schema: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: >- The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: >- [Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws. properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: >- A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: >- The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: >- Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: >- [Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list. properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: >- The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: >- The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: >- The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: >- Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: >- Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: >- The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: >- The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: >- Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: >- Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup. default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: >- Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: >- Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: >- The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: >- The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: >- The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: >- The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: >- The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: >- The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: >- The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: >- The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: >- The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: >- The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: >- The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: >- The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: >- The date and time of the last time someone unsubscribed from this list in ISO 8601 format. 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: - List_id x-custom-config: methodNameSnake: update_list methodNameCamel: updateList x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete List description: >- Delete a list from your Mailchimp account. If you delete a list, you'll lose the list historyincluding subscriber activity, unsubscribes, complaints, and bounces. Youll also lose subscribers email addresses, unless you exported and backed up your list. operationId: deleteListsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' 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: - List_id x-custom-config: methodNameSnake: delete_list methodNameCamel: deleteList x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Batch Subscribe or Unsubscribe description: Batch subscribe or unsubscribe list members. operationId: postListsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: skip_merge_validation x-title: Skip Merge Validation in: query description: >- If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: skip_duplicate_check x-title: Skip Duplicate Check in: query description: >- If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Members to Subscribe/Unsubscribe to/from a List in batch description: Members to subscribe to or unsubscribe from a list. required: - members properties: members: type: array title: List Members description: >- An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call. items: type: object title: Add List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time sync_tags: type: boolean title: Sync Tags description: >- Whether this batch operation will replace all existing tags with tags in request. update_existing: type: boolean title: Update Existing Members description: >- Whether this batch operation will change existing members' subscription status. example: example_value responses: '200': description: '' schema: type: object title: Batch update List members description: Batch update list members. properties: new_members: type: array title: New members description: >- An array of objects, each representing a new member that was added to the list. items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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 updated_members: type: array title: Updated Members description: >- An array of objects, each representing an existing list member whose subscription status was updated. items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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 errors: type: array title: Errors description: >- An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details. items: type: object properties: email_address: type: string title: Member Email address description: The email address that could not be added or updated. error: type: string title: Error message description: >- The error message indicating why the email address could not be added or updated. error_code: type: string title: Error code description: A unique code that identifies this specifc error. enum: - ERROR_CONTACT_EXISTS - ERROR_GENERIC field: type: string title: Field description: >- If the error is field-related, information about which field is at issue. field_message: type: string title: Field message description: Message indicating how to resolve a field-related error. total_created: type: integer title: Item Count description: >- The total number of items matching the query, irrespective of pagination. example: 42 total_updated: type: integer title: Item Count description: >- The total number of items matching the query, irrespective of pagination. example: 42 error_count: type: integer title: Item Count description: >- The total number of items matching the query, irrespective of pagination. example: 42 _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: - List_id x-custom-config: methodNameSnake: batch_list_members methodNameCamel: batchListMembers x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/abuse-reports: get: summary: Mailchimp List Abuse Reports description: Get all abuse reports for a specific list. operationId: getListsIdAbuseReports 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaints description: >- A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: abuse_reports: type: array items: type: object title: Abuse Complaint description: >- Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The list id for the abuse report. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true date: type: string title: Date description: Date for the abuse report 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: Abuse Reports description: >- An array of objects, each representing an abuse report resource. list_id: type: string title: List ID description: The list id for the abuse report. 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: - Abuse - List_id - Reports x-custom-config: methodNameSnake: get_list_abuse_reports methodNameCamel: getListAbuseReports x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/abuse-reports/{report_id}: get: summary: Mailchimp Get Abuse Report description: Get details about a specific abuse report. operationId: getListsIdAbuseReportsId 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: report_id in: path required: true type: string description: The id for the abuse report. example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaint description: >- Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The list id for the abuse report. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true date: type: string title: Date description: Date for the abuse report 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: - Abuse - List_id - Lists - Reports x-custom-config: methodNameSnake: get_list_abuse_report_details methodNameCamel: getListAbuseReportDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/activity: get: summary: Mailchimp List Recent Activity description: >- Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity. operationId: getListsIdActivity 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Activity description: >- Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity. properties: activity: type: array title: List Activity description: Recent list activity. items: type: object title: Daily List Activity description: >- One day's worth of list activity. Doesn't include Automation activity. properties: day: type: string title: Day description: The date for the activity summary. readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails sent on the date for the activity summary. readOnly: true unique_opens: type: integer title: Unique Opens description: The number of unique opens. readOnly: true recipient_clicks: type: integer title: Recipient Clicks description: The number of clicks. readOnly: true hard_bounce: type: integer title: Hard Bounces description: The number of hard bounces. readOnly: true soft_bounce: type: integer title: Soft Bounces description: The number of soft bounces readOnly: true subs: type: integer title: Subscribes description: The number of subscribes. readOnly: true unsubs: type: integer title: Unsubscribes description: The number of unsubscribes. readOnly: true other_adds: type: integer title: Other Adds description: >- The number of subscribers who may have been added outside of the [double opt-in process](https://mailchimp.com/help/about-double-opt-in/), such as imports or API activity. readOnly: true other_removes: type: integer title: Other Removes description: >- The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers). 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 list_id: type: string title: List ID description: The unique id for the list. 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: - Activity - List_id x-custom-config: methodNameSnake: get_list_recent_activity methodNameCamel: getListRecentActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/clients: get: summary: Mailchimp List Top Email Clients description: Get a list of the top email clients based on user-agent strings. operationId: getListsIdClients 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Email Clients description: The top email clients based on user-agent strings. properties: clients: type: array title: Email Clients description: An array of top email clients. items: type: object title: Email Client description: The email client. properties: client: type: string title: Client description: The name of the email client. readOnly: true members: type: integer title: Members description: >- The number of subscribed members who used this email client. readOnly: true list_id: type: string title: List ID description: The list id. 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: - Clients - List_id x-custom-config: methodNameSnake: get_list_clients methodNameCamel: getListClients x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/growth-history: get: summary: Mailchimp List Growth History Data description: Get a month-by-month summary of a specific list's growth activity. operationId: getListsIdGrowthHistory 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - month example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: '' schema: type: object title: Growth History description: A month-by-month summary of a specific list's growth activity. properties: history: type: array items: type: object title: Growth History description: >- A summary of a specific list's growth activity for a specific month and year. properties: list_id: type: string title: List ID description: The list id for the growth activity report. readOnly: true month: type: string title: Month description: The month that the growth history is describing. readOnly: true existing: type: integer title: Existing description: (deprecated) readOnly: true imports: type: integer title: Imports description: (deprecated) readOnly: true optins: type: integer title: Opt-in description: (deprecated) readOnly: true subscribed: type: integer title: Subscribed description: >- Total subscribed members on the list at the end of the month. readOnly: true unsubscribed: type: integer title: Unsubscribed description: >- Newly unsubscribed members on the list for a specific month. readOnly: true reconfirm: type: integer title: Reconfirm description: >- Newly reconfirmed members on the list for a specific month. readOnly: true cleaned: type: integer title: Cleaned description: >- Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true pending: type: integer title: Pending description: Pending members on the list for a specific month. readOnly: true deleted: type: integer title: Deleted description: Newly deleted members on the list for a specific month. readOnly: true transactional: type: integer title: Transactional description: >- Subscribers that have been sent transactional emails via Mandrill. 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: Members description: >- An array of objects, each representing a monthly growth report for a list. list_id: type: string title: List ID description: The list id. 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: - Growth - History - List_id x-custom-config: methodNameSnake: get_list_growth_history methodNameCamel: getListGrowthHistory x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/growth-history/{month}: get: summary: Mailchimp Get Growth History by Month description: >- Get a summary of a specific list's growth activity for a specific month and year. operationId: getListsIdGrowthHistoryId 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: month in: path required: true type: string description: A specific month of list growth history. example: example_value responses: '200': description: '' schema: type: object title: Growth History description: >- A summary of a specific list's growth activity for a specific month and year. properties: list_id: type: string title: List ID description: The list id for the growth activity report. readOnly: true month: type: string title: Month description: The month that the growth history is describing. readOnly: true existing: type: integer title: Existing description: (deprecated) readOnly: true imports: type: integer title: Imports description: (deprecated) readOnly: true optins: type: integer title: Opt-in description: (deprecated) readOnly: true subscribed: type: integer title: Subscribed description: Total subscribed members on the list at the end of the month. readOnly: true unsubscribed: type: integer title: Unsubscribed description: Newly unsubscribed members on the list for a specific month. readOnly: true reconfirm: type: integer title: Reconfirm description: Newly reconfirmed members on the list for a specific month. readOnly: true cleaned: type: integer title: Cleaned description: >- Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true pending: type: integer title: Pending description: Pending members on the list for a specific month. readOnly: true deleted: type: integer title: Deleted description: Newly deleted members on the list for a specific month. readOnly: true transactional: type: integer title: Transactional description: >- Subscribers that have been sent transactional emails via Mandrill. 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: - Growth - History - List_id - Month x-custom-config: methodNameSnake: get_list_growth_history_by_month methodNameCamel: getListGrowthHistoryByMonth x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories: get: summary: Mailchimp List Interest Categories description: Get information about a list's interest categories. operationId: getListsIdInterestCategories parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: type x-title: Interest Group Type in: query required: false description: Restrict results a type of interest group type: string example: example_value responses: '200': description: '' schema: type: object title: Interest Groupings description: Information about this list's interest categories. properties: list_id: type: string title: List ID description: The ID for the list that this category belongs to. readOnly: true categories: type: array title: Interest Categories description: This array contains individual interest categories. items: type: object title: Interest Category description: >- Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: >- The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: >- The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: >- Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _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: - Categories - Interest - List_id x-custom-config: methodNameSnake: get_list_interest_categories methodNameCamel: getListInterestCategories x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Interest Category description: Create a new interest category. operationId: postListsIdInterestCategories parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Interest Category description: >- Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. required: - title - type properties: title: type: string title: Name description: >- The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: >- The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: >- Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden example: example_value responses: '200': description: '' schema: type: object title: Interest Category description: >- Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: >- The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: >- The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: >- Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _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: - Categories - Interest - List_id x-custom-config: methodNameSnake: create_list_interest_category methodNameCamel: createListInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories/{interest_category_id}: get: summary: Mailchimp Get Interest Category Info description: Get information about a specific interest category. operationId: getListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Interest Category description: >- Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: >- The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: >- The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: >- Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _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: - Categories - Interest - List_id - Lists x-custom-config: methodNameSnake: get_interest_category methodNameCamel: getInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Interest Category description: Update a specific interest category. operationId: patchListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Interest Category description: >- Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. required: - title - type properties: title: type: string title: Name description: >- The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: >- The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: >- Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden example: example_value responses: '200': description: '' schema: type: object title: Interest Category description: >- Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: >- The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: >- The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: >- Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _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: - Categories - Interest - List_id - Lists x-custom-config: methodNameSnake: update_interest_category methodNameCamel: updateInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Interest Category description: Delete a specific interest category. operationId: deleteListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' 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: - Categories - Interest - List_id - Lists x-custom-config: methodNameSnake: delete_interest_category methodNameCamel: deleteInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories/{interest_category_id}/interests: get: summary: Mailchimp List Interests in Category description: Get a list of this category's interests. operationId: getListsIdInterestCategoriesIdInterests parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Interests description: A list of this category's interests properties: interests: type: array items: type: object title: Interest description: >- Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: >- The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _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: Interests description: An array of this category's interests list_id: type: string title: List ID description: The unique list id that the interests belong to. category_id: type: string title: Interest Category ID description: The id for the interest category. 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: - Categories - Interest - Interests - List_id x-custom-config: methodNameSnake: list_interest_category_interests methodNameCamel: listInterestCategoryInterests x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Interest in Category description: Create a new interest or 'group name' for a specific category. operationId: postListsIdInterestCategoriesIdInterests parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Interest description: >- Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. required: - name properties: name: type: string title: Interest Name description: >- The name of the interest. This can be shown publicly on a subscription form. display_order: type: integer title: Display Order description: The display order for interests. example: example_value responses: '200': description: '' schema: type: object title: Interest description: >- Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: >- The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _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: - Categories - Interest - Interests - List_id x-custom-config: methodNameSnake: create_interest_category_interest methodNameCamel: createInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}: get: summary: Mailchimp Get Interest in Category description: Get interests or 'group names' for a specific category. operationId: getListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Interest description: >- Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: >- The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _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: - Categories - Interest - Interests - List_id - Lists x-custom-config: methodNameSnake: get_interest_category_interest methodNameCamel: getInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Interest in Category description: Update interests or 'group names' for a specific category. operationId: patchListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' - name: body in: body required: true description: '' schema: type: object title: Interest description: >- Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. required: - name properties: name: type: string title: Interest Name description: >- The name of the interest. This can be shown publicly on a subscription form. display_order: type: integer title: Display Order description: The display order for interests. example: example_value responses: '200': description: '' schema: type: object title: Interest description: >- Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: >- The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _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: - Categories - Interest - Interests - List_id - Lists x-custom-config: methodNameSnake: update_interest_category_interest methodNameCamel: updateInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Interest in Category description: Delete interests or group names in a specific category. operationId: deleteListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' 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: - Categories - Interest - Interests - List_id - Lists x-custom-config: methodNameSnake: delete_interest_category_interest methodNameCamel: deleteInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments: get: summary: Mailchimp List Segments description: Get information about all available segments for a specific list. operationId: previewASegment 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: type x-title: Segment Type in: query required: false description: Limit results based on segment type. type: string example: example_value - name: since_created_at x-title: Since Created At in: query description: >- Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: before_created_at x-title: Before Created At in: query description: >- Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: include_cleaned in: query x-title: Include Cleaned description: Include cleaned members in response required: false type: boolean x-example: false example: example_value - name: include_transactional in: query x-title: Include Transactional description: Include transactional members in response required: false type: boolean x-example: false example: example_value - name: include_unsubscribed in: query x-title: Include Unsubscribed description: Include unsubscribed members in response required: false type: boolean x-example: false example: example_value - name: since_updated_at x-title: Since Updated At in: query description: >- Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' - name: before_updated_at x-title: Before Updated At in: query description: >- Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: '2026-01-15T10:30:00Z' responses: '200': description: '' schema: type: object title: Collection of Segments description: A list of available segments. properties: segments: type: array items: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: >- The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: >- The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: >- The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: >- The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: >- The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. list_id: type: string title: List ID description: The list id. 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: Lists description: An array of objects, each representing a list segment. list_id: type: string title: List ID description: The list id. 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: - List_id - Segments x-custom-config: methodNameSnake: list_segments methodNameCamel: listSegments x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Segment description: Create a new segment in a specific list. operationId: postListsIdSegments parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: List description: Information about a specific list segment. required: - name properties: name: type: string title: Segment Name description: The name of the segment. static_segment: type: array title: Static Segment description: >- An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field. items: type: string options: type: object title: Conditions description: >- The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions. properties: match: type: string title: Match description: 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. 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: Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. example: example_value responses: '200': description: '' schema: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: >- The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: >- The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: >- The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: >- The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. 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: Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. list_id: type: string title: List ID description: The list id. 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: - List_id - Segments x-custom-config: methodNameSnake: create_segment methodNameCamel: createSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments/{segment_id}: get: summary: Mailchimp Get Segment Info description: Get information about a specific segment. operationId: getListsIdSegmentsId 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: include_cleaned in: query x-title: Include Cleaned description: Include cleaned members in response required: false type: boolean x-example: false example: example_value - name: include_transactional in: query x-title: Include Transactional description: Include transactional members in response required: false type: boolean x-example: false example: example_value - name: include_unsubscribed in: query x-title: Include Unsubscribed description: Include unsubscribed members in response required: false type: boolean x-example: false example: example_value responses: '200': description: '' schema: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: >- The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: >- The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: >- The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: >- The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. 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: Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. list_id: type: string title: List ID description: The list id. 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: - List_id - Lists - Segments x-custom-config: methodNameSnake: get_segment methodNameCamel: getSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Segment description: Delete a specific segment in a list. operationId: deleteListsIdSegmentsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' 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: - List_id - Lists - Segments x-custom-config: methodNameSnake: delete_segment methodNameCamel: deleteSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Segment description: Update a specific segment in a list. operationId: patchListsIdSegmentsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: List description: Information about a specific list segment. required: - name properties: name: type: string title: Segment Name description: The name of the segment. static_segment: type: array title: Static Segment description: >- An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the `options` field. items: type: string options: type: object title: Conditions description: >- The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions. properties: match: type: string title: Match description: Match type. enum: - any - all conditions: type: array title: Segment Conditions description: An array of segment conditions. items: 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. example: example_value responses: '200': description: '' schema: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: >- The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: >- The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: >- The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: >- The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. 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: Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. list_id: type: string title: List ID description: The list id. 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: - List_id - Lists - Segments x-custom-config: methodNameSnake: update_segment methodNameCamel: updateSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Batch Add or Remove Members description: Batch add/remove list members to static segment operationId: postListsIdSegmentsId parameters: - name: body in: body description: '' required: true schema: type: object title: Members to add/remove to/from a static segment description: Members to add/remove to/from a static segment properties: members_to_add: type: array title: Members to add to the static segment description: >- An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. items: type: string members_to_remove: type: array title: Members to remove from the static segment description: >- An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Batch add/remove List members to/from static segment description: Batch add/remove List members to/from static segment properties: members_added: type: array title: Members Added description: >- An array of objects, each representing a new member that was added to the static segment. items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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 members_removed: type: array title: Members Removed description: >- An array of objects, each representing an existing list member that got deleted from the static segment. items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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 errors: type: array title: Errors description: >- An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details. items: type: object properties: email_addresses: type: array title: Email addresses added to the static segment or removed description: Email addresses added to the static segment or removed items: type: string error: type: string title: Error message description: >- The error message indicating why the email addresses could not be added or updated. total_added: type: integer title: Item Count description: >- The total number of items matching the query, irrespective of pagination. example: 42 total_removed: type: integer title: Item Count description: >- The total number of items matching the query, irrespective of pagination. example: 42 error_count: type: integer title: Item Count description: >- The total number of items matching the query, irrespective of pagination. example: 42 _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: - List_id - Lists - Segments x-custom-config: methodNameSnake: batch_segment_members methodNameCamel: batchSegmentMembers x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments/{segment_id}/members: get: summary: Mailchimp List Members in Segment description: Get information about members in a saved segment. operationId: getListsIdSegmentsIdMembers 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: include_cleaned in: query x-title: Include Cleaned description: Include cleaned members in response required: false type: boolean x-example: false example: example_value - name: include_transactional in: query x-title: Include Transactional description: Include transactional members in response required: false type: boolean x-example: false example: example_value - name: include_unsubscribed in: query x-title: Include Unsubscribed description: Include unsubscribed members in response required: false type: boolean x-example: false example: example_value responses: '200': description: '' schema: type: object title: Segment Members description: View members in a specific list segment. properties: members: type: array items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true list_id: type: string title: List ID description: The list id. 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: Members description: An array of objects, each representing a specific list member. 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: - List_id - Members - Segments x-custom-config: methodNameSnake: get_segment_members_list methodNameCamel: getSegmentMembersList x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member to Segment description: Add a member to a static segment. operationId: postListsIdSegmentsIdMembers parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object required: - email_address properties: email_address: type: string title: Email Address description: Email address for a subscriber. example: example_value responses: '200': description: '' schema: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true list_id: type: string title: List ID description: The list id. 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: - List_id - Members - Segments x-custom-config: methodNameSnake: create_segment_member methodNameCamel: createSegmentMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}: delete: summary: Mailchimp Remove List Member From Segment description: Remove a member from the specified static segment. operationId: deleteListsIdSegmentsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value 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: - List_id - Lists - Members - Segments x-custom-config: methodNameSnake: remove_segment_member methodNameCamel: removeSegmentMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/tag-search: get: summary: Mailchimp Search for Tags on a List by Name. description: >- Search for tags on a list by name. If no name is provided, will return all tags on the list. operationId: searchTagsByName parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: name x-title: Name in: query description: >- The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned. required: false type: string example: Example Title responses: '200': description: '' schema: type: object title: Tag search results description: A list of tags matching the input query. properties: tags: type: array title: Tags description: A list of matching tags. readOnly: true items: properties: id: type: integer title: Tag ID description: The unique id for the tag. readOnly: true name: type: string title: Tag Name description: The name of the tag. total_items: type: integer title: Item Count description: >- The total number of items matching the query regardless of pagination. 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 x-custom-config: methodNameSnake: tag_search methodNameCamel: tagSearch deprecated: false tags: - List_id - Search x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members: get: summary: Mailchimp List Members Info description: Get information about members in a specific Mailchimp list. operationId: getListsIdMembers 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: email_type x-title: Email Type in: query required: false description: The email type. type: string example: user@example.com - name: status x-title: Subscriber Status in: query required: false description: The subscriber's status. type: string enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived example: example_value - name: since_timestamp_opt x-title: Since Timestamp Opt in: query description: >- Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: example_value - name: before_timestamp_opt x-title: Before Timestamp Opt in: query description: >- Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: example_value - name: since_last_changed x-title: Since Last Changed in: query description: >- Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: example_value - name: before_last_changed x-title: Before Last Changed in: query description: >- Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: example_value - name: unique_email_id x-title: Unique Email ID in: query description: >- A unique identifier for the email address across all Mailchimp lists. required: false type: string example: user@example.com - name: vip_only x-title: VIP Only in: query description: >- A filter to return only the list's VIP members. Passing `true` will restrict results to VIP list members, passing `false` will return all list members. required: false type: boolean example: example_value - name: interest_category_id x-title: Interest Category ID in: query description: The unique id for the interest category. required: false type: string example: '500123' - name: interest_ids x-title: Interest Ids in: query required: false description: >- Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories. type: string example: example_value - name: interest_match x-title: Interest Match in: query required: false enum: - any - all - none description: >- Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. "any" will match a member with any of the interest supplied, "all" will only match members with every interest supplied, and "none" will match members without any of the interest supplied. type: string example: example_value - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - timestamp_opt - timestamp_signup - last_changed example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: since_last_campaign x-title: Since Last Campaign in: query required: false description: >- Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter. type: boolean example: example_value - name: unsubscribed_since x-title: Unsubscribed Since in: query required: false description: >- Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error. type: string example: example_value responses: '200': description: '' schema: type: object title: List Members description: >- Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. properties: members: type: array items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: >- The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: >- Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: >- The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: >- The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: >- The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: >- Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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: Members description: An array of objects, each representing a specific list member. list_id: type: string title: List ID description: The list id. 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: - List_id - Members x-custom-config: methodNameSnake: get_list_members_info methodNameCamel: getListMembersInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member to List description: Add a new member to the list. operationId: postListsIdMembers parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: skip_merge_validation x-title: Skip Merge Validation in: query description: >- If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. required: - email_address - status properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time tags: type: array title: Tags on a member description: The tags that are associated with a member. items: type: string description: >- The name of the tag that will be associated with this member. example: example_value responses: '200': description: '' schema: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: >- The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: >- Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: >- Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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: - List_id - Members x-custom-config: methodNameSnake: add_list_member methodNameCamel: addListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}: get: summary: Mailchimp Get Member Info description: >- Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member. operationId: getListsIdMembersId 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value responses: '200': description: '' schema: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: >- The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: >- Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: >- Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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: - List_id - Lists - Members x-custom-config: methodNameSnake: get_list_member methodNameCamel: getListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Add or Update List Member description: Add or update a list member. operationId: putListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: skip_merge_validation x-title: Skip Merge Validation in: query description: >- If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. required: - email_address - status_if_new properties: email_address: type: string title: Email Address description: >- Email address for a subscriber. This value is required only if the email address is not already present on the list. status_if_new: type: string title: New Member Status description: >- Subscriber's status. This value is required only if the email address is not already present on the list. enum: - subscribed - unsubscribed - cleaned - pending - transactional email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time example: example_value responses: '200': description: '' schema: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: >- The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: >- Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: >- Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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: - List_id - Lists - Members x-custom-config: methodNameSnake: set_list_member methodNameCamel: setListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update List Member description: Update information for a specific list member. operationId: patchListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: skip_merge_validation x-title: Skip Merge Validation in: query description: >- If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time example: example_value responses: '200': description: '' schema: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: >- The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: >- Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: >- Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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: - List_id - Lists - Members x-custom-config: methodNameSnake: update_list_member methodNameCamel: updateListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Archive List Member description: >- Archive a list member. To permanently delete, use the delete-permanent action. operationId: deleteListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value 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: - List_id - Lists - Members x-custom-config: methodNameSnake: delete_list_member methodNameCamel: deleteListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/activity: get: summary: Mailchimp View Recent Activity 50 description: >- Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivity parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - 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 example: example_value - 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 example: example_value - in: query name: action x-title: Action type: array required: false items: type: string collectionFormat: csv enum: - - abuse - - bounce - - click - - open - - sent - - unsub - - ecomm description: A comma seperated list of actions to return. example: example_value responses: '200': description: '' schema: type: object title: Member Activity Events description: The last 50 member events for a list. properties: activity: type: array title: Activity description: An array of objects, each representing a member event. items: type: object title: Member Activity description: Member activity events. properties: action: type: string title: Action Type description: The type of action recorded for the subscriber. timestamp: type: string title: Timestamp format: date-time description: The date and time recorded for the action. url: type: string title: URL description: For clicks, the URL the subscriber clicked on. type: type: string title: Campaign Type description: The type of campaign that was sent. campaign_id: type: string title: Campaign ID description: The web-based ID for the campaign. title: type: string title: Campaign Title description: If set, the campaign's title. parent_campaign: type: string title: Parent Campaign ID description: The ID of the parent campaign. email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true list_id: type: string title: List ID description: The list id. 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: - Activity - List_id - Members x-custom-config: methodNameSnake: get_list_member_activity methodNameCamel: getListMemberActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/activity-feed: get: summary: Mailchimp View Recent Activity description: >- Get a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivityFeed parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: query name: activity_filters x-title: Activity Filters type: array required: false items: type: string collectionFormat: csv enum: - - bounce - - click - - conversation - - ecommerce_signup - - event - - web_engagement - - generic_signup - - landing_page_signup - - marketing_permission - - note - - open - - order - - postcard_sent - - sent - - signup - - squatter_signup - - unsub - - website_signup - - survey_response - - sms_bulk_sent - - inbox_thread - - qbo_payment_link - - video_call_transcripts description: >- A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,bounce,click". example: example_value responses: '200': description: '' schema: type: object title: Member Activity Events description: The member activity events for a given member. x-hidden: false properties: activity: type: array title: Activity description: >- An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas). readOnly: true items: x-discriminator: propertyName: activity_type type: string x-oneOf: - type: object title: Email Opens description: Activity feed item representing opening an email. properties: activity_type: type: string description: The type of event activity. x-value: open enum: - open created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. - type: object title: Email Clicks description: >- Activity feed item representing having a link clicked by a contact. properties: activity_type: type: string description: The type of event activity. x-value: click enum: - click created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. link_clicked: type: string title: Link Clicked description: The URL of the link that was clicked. - type: object title: Email Bounced description: >- Activity feed item representing an email to this contact bouncing. properties: activity_type: type: string description: The type of event activity. x-value: bounce enum: - bounce created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. bounce_type: type: string title: Bounce Type description: The type of bounce. enum: - hard - soft bounce_has_open_activity: type: boolean title: Bounce Has Open Activity description: >- Indicates if the email associated with this bounce also has open activity on the same campaign. - type: object title: List Unsubscribed description: >- Activity feed item representing this contact unsubscribing from a list. properties: activity_type: type: string description: The type of event activity. x-value: unsub enum: - unsub created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Text description: The title of the campaign. is_admin_unsubscribed: type: boolean title: Is Admin Unsubscribed description: Indicates if an admin unsubscribed a contact. unsubscribe_reason: type: string title: Unsubscribe Reason description: >- Indicates the reason that the contact was unsubscribed. - type: object title: Email Sent description: >- Activity feed item representing having an email sent to the contact. properties: activity_type: type: string description: The type of event activity. x-value: sent enum: - sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. - type: object title: Email Conversation description: >- Activity feed item representing an individual reply in a conversation. properties: activity_type: type: string description: The type of event activity. x-value: conversation enum: - conversation created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. thread_id: type: string title: Thread ID description: >- The thread's unique id of the conversation referenced in this event. message_text: type: string title: Message Text description: The body of the message in this conversation. created_by: type: string title: Created By description: The username of the person who created this event. is_user: type: boolean title: Is User description: >- Indicates that the message created by a user (as opposed to a contact). has_read: type: boolean title: Has Read description: Indicates that the message has been read. from_email: type: string title: From Email description: The email of the contact who sent the reply. avatar_url: type: string title: Avatar URL description: The gravatar URL of the contact who sent the reply. - type: object title: Note description: >- Activity feed item representing a note on the contact record. properties: activity_type: type: string description: The type of event activity. x-value: note enum: - note created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. updated_at_timestamp: type: string title: Updated At Timestamp format: date-time description: The updated at timestamp in ISO8601. note_id: type: string title: Note ID description: The note's unique id. note_text: type: string title: Note Text description: The note's text. created_by: type: string title: Created By description: The person who created the note. avatar_url: type: string title: Avatar URL description: The URL of the contact's profile gravatar image. - type: object title: Marketing Permission description: >- Activity feed item indicating if a marketing permission was added or updated. properties: activity_type: type: string description: The type of event activity. x-value: marketing_permission enum: - marketing_permission created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. marketing_permission_text: type: string title: Marketing Permission Text description: The text describing this marketing permission. updated_by: type: string title: Updated By description: The name of the contact who updated this permission. marketing_permission_opted_in: type: boolean title: Marketing Permission Opted In description: >- Indicates if the marketing permission is enabled or not. - type: object title: Postcard Sent description: >- Activity feed item representing a time when a contact was sent a particular postcard. properties: activity_type: type: string description: The type of event activity. x-value: postcard_sent enum: - postcard_sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Squatter Signup description: >- Activity feed item to representing a contact signing up for the audience from a squatter page. properties: activity_type: type: string description: The type of event activity. x-value: squatter_signup enum: - squatter_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Website Signup description: >- Activity feed item to representing a contact signing up for the contact through a website page. properties: activity_type: type: string description: The type of event activity. x-value: website_signup enum: - website_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Landing Page Signup description: >- Activity feed item to representing a contact signing up for the list via a landing page. properties: activity_type: type: string description: The type of event activity. x-value: landing_page_signup enum: - landing_page_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Ecommerce Signup description: >- Activity feed item to representing a contact signing up for the list via a ecommerce store. properties: activity_type: type: string description: The type of event activity. x-value: ecommerce_signup enum: - ecommerce_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. store_name: type: string title: Store Name description: The name of the store. - type: object title: Generic Signup description: >- Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to). properties: activity_type: type: string description: The type of event activity. x-value: generic_signup enum: - generic_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. signup_category: type: string title: Signup Category description: How was this user added to the list. - type: object title: Ecommerce Order description: Activity feed item that represents an order. properties: activity_type: type: string description: The type of event activity. x-value: order enum: - order created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_type: type: string title: Outreach Type description: The type of outreach that triggered the event. outreach_title: type: string title: Outreach Title description: The title of the outreach. order_id: type: string title: Order ID description: The unique order id. order_total: type: string title: Order Total description: The order total formatted as a string. order_items: type: array title: Order Items description: An array of items that have been ordered. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: >- The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: >- The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: >- The total discount amount applied to a line item. _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 store_name: type: string title: Store Name description: The name of the store for an order. order_url: type: string title: Order URL description: The order URL. integration_platform: type: string title: Integration Platform description: >- The name of the integration platform this order originated through. - type: object title: Contact Activity Event description: Activity feed item that represents a generic event. properties: activity_type: type: string description: The type of event activity. x-value: event enum: - event created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. event_name: type: string title: Event Name description: The name of the event. event_properties: type: array title: Event Properties items: x-skip-validation: true type: string description: >- An arbitrary datastore containing properties for the given event. - type: object title: Survey response description: Represents when a contact completes and submits a survey properties: activity_type: type: string description: The type of event activity. x-value: survey_response enum: - survey_response created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. survey_id: type: string title: Survey ID description: The survey's unique id. survey_title: type: string title: Survey Title description: The title of the survey. - type: object title: SMS Bulk Sent description: >- Activity feed item representing an SMS campaign sent to the contact. properties: activity_type: type: string description: The type of event activity. x-value: sms_bulk_sent enum: - sms_bulk_sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the SMS campaign. - type: object title: Inbox Thread description: >- Activity feed item representing a thread located in Inbox. properties: activity_type: type: string description: The type of event activity. x-value: inbox_thread enum: - inbox_thread created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: Thread ID description: The ID of the thread. thread_subject: type: string title: Thread Subject description: The subject of the thread. thread_url: type: string title: Thread URL description: The url of the thread. thread_direction: type: string title: Thread Direction description: >- The direction of the message noting if it is outbound or inbound. enum: - INBOUND - OUTBOUND thread_author: type: string title: Thread Author description: The author of the thread. - type: object title: QBO Payment Link description: Activity feed item representing a payment link from QBO. properties: activity_type: type: string description: The type of event activity. x-value: qbo_payment_link enum: - qbo_payment_link created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: id description: The QuickBooks payment link id. qbo_payment_external_id: type: string title: QBO Payment External ID description: The external QuickBooks payment id. integration_platform: type: string title: Integration Platform description: The platform Mailchimp is integrated with. enum: - quickbooks - type: object title: Video Call Transcripts description: Activity feed item representing a video call transcript. properties: activity_type: type: string description: The type of event activity. x-value: video_call_transcripts enum: - video_call_transcripts created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: id description: The id for video call transcripts. scheduled_meeting_start_timestamp: type: string title: Scheduled Meeting Start Timestamp format: date-time description: The Scheduled Meeting Start timestamp in ISO8601. expire_at_timestamp: type: string title: Expire At Timestamp format: date-time description: The Expire At timestamp in ISO8601. email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true list_id: type: string title: List ID description: The list id. 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: - Activity - Feed - List_id - Members x-custom-config: methodNameSnake: get_list_member_activity_feed methodNameCamel: getListMemberActivityFeed x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/tags: get: summary: Mailchimp List Member Tags description: Get the tags on a list member. operationId: getListMemberTags parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Collection of Tags description: A list of tags assigned to a list member. properties: tags: type: array title: Tags description: A list of tags assigned to the list member. readOnly: false items: properties: id: type: integer title: Tag ID description: The unique id for the tag. readOnly: true name: type: string title: Tag Name description: The name of the tag. date_added: type: string title: Date Added description: >- The date and time the tag was added to the list member in ISO 8601 format. format: date-time 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: - List_id - Members x-custom-config: methodNameSnake: get_list_member_tags methodNameCamel: getListMemberTags x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add or Remove Member Tags description: >- Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. operationId: postListMemberTags parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: body in: body required: true description: '' schema: type: object title: Member Tags description: A list of tags assigned to a list member. required: - tags properties: tags: type: array title: Tags description: A list of tags assigned to the list member. items: type: object title: Member Tag description: >- Add or remove tags on a member by declaring a tag either active or inactive on a member. required: - name - status properties: name: type: string title: Tag Name description: The name of the tag. status: type: string title: Status description: >- The status for the tag on the member, pass in active to add a tag or inactive to remove it. enum: - inactive - active is_syncing: type: boolean title: Is Syncing description: >- When is_syncing is true, automations based on the tags in the request will not fire example: example_value 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: - List_id - Members x-custom-config: methodNameSnake: update_list_member_tags methodNameCamel: updateListMemberTags x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/events: get: summary: Mailchimp List Member Events description: Get events for a contact. operationId: getListsIdMembersIdEvents parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Collection of Events description: A collection of events for a given contact properties: events: type: array items: type: object title: Event description: A specific event for a contact. properties: occurred_at: type: string title: Occurred Time description: The date and time the event occurred in ISO 8601 format. format: date-time readOnly: true name: type: string title: Event Name description: >- The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length properties: type: object title: Properties description: An optional list of properties additionalProperties: type: string title: Events description: An array of objects, each representing an event. 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: - Events - List_id - Members x-custom-config: methodNameSnake: get_list_member_events methodNameCamel: getListMemberEvents x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Event description: Add an event for a list member. operationId: postListMemberEvents parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: body in: body description: '' required: true schema: type: object title: Events description: A new event for a specific list member required: - name properties: name: type: string title: Event Name description: >- The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length properties: type: object title: Properties description: An optional list of properties additionalProperties: type: string is_syncing: type: boolean title: Is Syncing description: >- Events created with the is_syncing value set to `true` will not trigger automations. occurred_at: type: string title: Occurred Time description: The date and time the event occurred in ISO 8601 format. format: date-time example: example_value 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: - Events - List_id - Members x-custom-config: methodNameSnake: create_list_member_event methodNameCamel: createListMemberEvent x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/goals: get: summary: Mailchimp List Member Goal Events description: Get the last 50 Goal events for a member on a specific list. operationId: getListsIdMembersIdGoals parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Collection of Member Activity Events description: The last 50 Goal events for a member on a specific list. properties: goals: type: array title: Goal Activity description: The last 50 Goal events triggered by a member. items: type: object title: Goal description: A single instance of a goal activity. properties: goal_id: type: integer title: Goal ID description: The id for a Goal event. event: type: string title: Event Name description: The name/type of Goal event triggered. last_visited_at: type: string title: Last Visit Date description: >- The date and time the user last triggered the Goal event in ISO 8601 format. format: date-time data: type: string title: Additional Data description: Any extra data passed with the Goal event. list_id: type: string title: List ID description: The list id. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. 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: - Goals - List_id - Members x-custom-config: methodNameSnake: getListMemberGoals methodNameCamel: getListMemberGoals x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/notes: get: summary: Mailchimp List Recent Member Notes description: Get recent notes for a specific list member. operationId: getListsIdMembersIdNotes parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: sort_field x-title: Sort By Field description: Returns notes sorted by the specified field. in: query required: false type: string enum: - created_at - updated_at - note_id example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Collection of Notes description: >- The last 10 notes for a specific list member, based on date created. properties: notes: type: array items: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: >- The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. 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: Notes description: An array of objects, each representing a note resource. email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true list_id: type: string title: List ID description: The list id. 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: - List_id - Members - Notes x-custom-config: methodNameSnake: get_list_member_notes methodNameCamel: getListMemberNotes x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member Note description: Add a new note for a specific subscriber. operationId: postListsIdMembersIdNotes parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: body in: body required: true description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: note: type: string title: Note description: >- The content of the note. Note length is limited to 1,000 characters. example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: >- The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. 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: - List_id - Members - Notes x-custom-config: methodNameSnake: create_list_member_note methodNameCamel: createListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}: get: summary: Mailchimp Get Member Note description: Get a specific note for a specific list member. operationId: getListsIdMembersIdNotesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: note_id x-title: Note ID in: path description: The id for the note. required: true type: string example: '500123' - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: >- The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. 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: - List_id - Lists - Members - Notes x-custom-config: methodNameSnake: get_list_member_note methodNameCamel: getListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Note description: Update a specific note for a specific list member. operationId: patchListsIdMembersIdNotesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: note_id x-title: Note ID in: path description: The id for the note. required: true type: string example: '500123' - name: body in: body required: true description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: note: type: string title: Note description: >- The content of the note. Note length is limited to 1,000 characters. example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: >- The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. 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: - List_id - Lists - Members - Notes x-custom-config: methodNameSnake: update_list_member_note methodNameCamel: updateListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Note description: Delete a specific note for a specific list member. operationId: deleteListsIdMembersIdNotesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: note_id x-title: Note ID in: path description: The id for the note. required: true type: string example: '500123' 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: - List_id - Lists - Members - Notes x-custom-config: methodNameSnake: delete_list_member_note methodNameCamel: deleteListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent: post: summary: Mailchimp Delete List Member description: >- Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member. parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value 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: - Actions - List_id - Lists - Members x-custom-config: methodNameSnake: delete_list_member_permanent methodNameCamel: deleteListMemberPermanent operationId: postListsIdMembersHashActionsDeletePermanent x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/merge-fields: get: summary: Mailchimp List Merge Fields description: Get a list of all merge fields for an audience. operationId: getListsIdMergeFields parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: type x-title: Merge Type in: query required: false description: The merge field type. type: string example: example_value - name: required x-title: Required in: query required: false description: Whether it's a required merge field. type: boolean example: example_value responses: '200': description: '' schema: type: object title: Collection of Merge Fields description: >- The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_fields: type: array items: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: >- The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: >- The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: >- The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: >- In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: >- In a phone field, the phone number type: US or International. date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: >- In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: >- In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. 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: Merge Fields description: An array of objects, each representing a merge field resource. list_id: type: string title: List ID description: The list id. 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: - Fields - List_id - Merge x-custom-config: methodNameSnake: get_list_merge_fields methodNameCamel: getListMergeFields x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Merge Field description: Add a new merge field for a specific audience. operationId: postListsIdMergeFields parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. required: - name - type properties: tag: type: string title: Merge Tag description: >- The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: >- The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip required: type: boolean title: Required description: Whether the merge field is required to import a contact. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: >- The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: >- In an address field, the default country code if none supplied. items: type: string phone_format: type: string title: Phone Type description: >- In a phone field, the phone number type: US or International. date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: >- In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. example: example_value responses: '200': description: '' schema: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: >- The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: >- The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: >- The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: >- In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: >- In a phone field, the phone number type: US or International. date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: >- In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. 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: - Fields - List_id - Merge x-custom-config: methodNameSnake: add_list_merge_field methodNameCamel: addListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/merge-fields/{merge_id}: get: summary: Mailchimp Get Merge Field description: Get information about a specific merge field. operationId: getListsIdMergeFieldsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: merge_id x-title: Merge ID description: The id for the merge field. in: path required: true type: string example: '500123' - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: >- The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: >- The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: >- The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: >- In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: >- In a phone field, the phone number type: US or International. date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: >- In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. 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: - Fields - List_id - Lists - Merge x-custom-config: methodNameSnake: get_list_merge_field methodNameCamel: getListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Merge Field description: Update a specific merge field. operationId: patchListsIdMergeFieldsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: merge_id x-title: Merge ID description: The id for the merge field. in: path required: true type: string example: '500123' - name: body in: body description: '' schema: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. required: - name properties: tag: type: string title: Merge Tag description: >- The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). required: type: boolean title: Required description: Whether the merge field is required to import a contact. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: >- The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: >- In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: >- In a phone field, the phone number type: US or International. date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: >- In a radio or dropdown non-group field, the available options for members to pick from. items: type: string example: - First Choice - Second Choice - Third Choice help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. required: true example: example_value responses: '200': description: '' schema: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: >- The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: >- The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: >- The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: >- In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: >- In a phone field, the phone number type: US or International. date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: >- In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. 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: - Fields - List_id - Lists - Merge x-custom-config: methodNameSnake: update_list_merge_field methodNameCamel: updateListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Merge Field description: Delete a specific merge field. operationId: deleteListsIdMergeFieldsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: merge_id x-title: Merge ID description: The id for the merge field. in: path required: true type: string example: '500123' 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: - Fields - List_id - Lists - Merge x-custom-config: methodNameSnake: delete_list_merge_field methodNameCamel: deleteListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/webhooks: get: summary: Mailchimp List Webhooks description: Get information about all webhooks for a specific list. operationId: getListsIdWebhooks parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Webhooks description: Manage webhooks for a specific list. properties: webhooks: type: array items: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: >- The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: >- Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: >- Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: >- Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: >- Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: >- Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: >- Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: >- The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: >- Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: >- Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: >- Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _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: Webhooks description: An array of objects, each representing a specific list member. list_id: type: string title: List ID description: The list id. 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: - List_id - Webhooks x-custom-config: methodNameSnake: get_list_webhooks methodNameCamel: getListWebhooks x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Webhook description: Create a new webhook for a specific list. operationId: postListsIdWebhooks parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body description: '' schema: type: object title: Add Webhook description: Configure a webhook for the given list. properties: url: type: string title: URL description: A valid URL for the Webhook. example: http://yourdomain.com/webhook events: type: object title: Events description: >- The events that can trigger the webhook and whether they are enabled. properties: subscribe: type: boolean title: Subscribed description: >- Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: >- Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: >- Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: >- Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: >- Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: >- Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: >- The possible sources of any events that can trigger the webhook and whether they are enabled. properties: user: type: boolean title: User description: >- Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: >- Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: >- Whether the webhook is triggered by actions initiated via the API. example: true required: true example: example_value responses: '200': description: '' schema: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: >- The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: >- Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: >- Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: >- Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: >- Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: >- Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: >- Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: >- The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: >- Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: >- Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: >- Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _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: - List_id - Webhooks x-custom-config: methodNameSnake: create_list_webhook methodNameCamel: createListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/webhooks/{webhook_id}: get: summary: Mailchimp Get Webhook Info description: Get information about a specific webhook. operationId: getListsIdWebhooksId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: webhook_id in: path description: The webhook's id. type: string required: true example: '500123' responses: '200': description: '' schema: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: >- The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: >- Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: >- Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: >- Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: >- Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: >- Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: >- Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: >- The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: >- Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: >- Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: >- Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _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: - List_id - Webhooks x-custom-config: methodNameSnake: get_list_webhook methodNameCamel: getListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Webhook description: Delete a specific webhook in a list. operationId: deleteListsIdWebhooksId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: webhook_id in: path description: The webhook's id. type: string required: true example: '500123' 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: - List_id - Webhooks x-custom-config: methodNameSnake: delete_list_webhook methodNameCamel: deleteListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Webhook description: Update the settings for an existing webhook. operationId: patchListsIdWebhooksId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: webhook_id in: path description: The webhook's id. type: string required: true example: '500123' - name: body in: body description: '' schema: type: object title: Add Webhook description: Configure a webhook for the given list. properties: url: type: string title: URL description: A valid URL for the Webhook. example: http://yourdomain.com/webhook events: type: object title: Events description: >- The events that can trigger the webhook and whether they are enabled. properties: subscribe: type: boolean title: Subscribed description: >- Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: >- Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: >- Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: >- Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: >- Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: >- Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: >- The possible sources of any events that can trigger the webhook and whether they are enabled. properties: user: type: boolean title: User description: >- Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: >- Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: >- Whether the webhook is triggered by actions initiated via the API. example: true required: true example: example_value responses: '200': description: '' schema: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: >- The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: >- Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: >- Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: >- Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: >- Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: >- Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: >- Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: >- The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: >- Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: >- Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: >- Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _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: - List_id - Webhooks x-custom-config: methodNameSnake: update_list_webhook methodNameCamel: updateListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/signup-forms: get: summary: Mailchimp List Signup Forms description: Get signup forms for a specific list. operationId: getListsIdSignupForms parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Signup Forms description: List Signup Forms. properties: signup_forms: type: array items: type: object title: Signup Form description: List signup form. properties: header: type: object title: Signup form header options description: Options for customizing your signup form header. properties: image_url: type: string title: Header Image URL description: Header image URL. example: >- http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png text: type: string title: Header Text description: Header text. example: Header Text goes here image_width: type: string title: Image width description: Image width, in pixels. example: '800' image_height: type: string title: Image height description: Image height, in pixels. example: '200' image_alt: type: string title: Image Alt description: Alt text for the image. example: This is an image image_link: type: string title: Image Link description: The URL that the header image will link to. example: gotothisimage.com image_align: type: string title: Image align description: Image alignment. enum: - none - left - center - right example: center image_border_width: type: string title: Image border width description: Image border width. example: '2' image_border_style: type: string title: Image border style description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid image_border_color: type: string title: Image border color description: Image border color. example: '#896d6d' image_target: type: string title: Image target description: Image link target. enum: - _blank - 'null' example: _blank contents: type: array items: type: object title: Collection of Content for List Signup Forms description: Collection of Content for List Signup Forms. properties: section: type: string title: Content Section Name description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message value: type: string title: Content Section Value description: The content section text. example: Signup message goes here title: Signup form body content description: The signup form body content. styles: type: array items: type: object title: Collection of Element style for List Signup Forms description: Collection of Element style for List Signup Forms. properties: selector: type: string title: Selector description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background options: type: array title: Options description: A collection of options for a selector. items: type: object title: An option for Signup Form Styles description: An option for Signup Form Styles. properties: property: type: string title: Property description: A string that identifies the property. example: background-color value: type: string title: Value description: >- A string that identifies value of the property. example: '#111111' title: Signup Form element style description: >- An array of objects, each representing an element style for the signup form. signup_form_url: type: string title: Signup form URL description: Signup form URL. list_id: type: string title: List ID description: The signup form's list id. readOnly: true example: 4ca5becb8d _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: List Signup Form description: List signup form. list_id: type: string title: List ID description: The list id. 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: - Forms - List_id - Signup x-custom-config: methodNameSnake: get_list_signup_forms methodNameCamel: getListSignupForms x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Customize Signup Form description: Customize a list's default signup form. operationId: postListsIdSignupForms parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body description: '' schema: type: object title: Signup Form description: List signup form. properties: header: type: object title: Signup form header options description: Options for customizing your signup form header. properties: image_url: type: string title: Header Image URL description: Header image URL. example: >- http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png text: type: string title: Header Text description: Header text. example: Header Text goes here image_width: type: string title: Image width description: Image width, in pixels. example: '800' image_height: type: string title: Image height description: Image height, in pixels. example: '200' image_alt: type: string title: Image Alt description: Alt text for the image. example: This is an image image_link: type: string title: Image Link description: The URL that the header image will link to. example: gotothisimage.com image_align: type: string title: Image align description: Image alignment. enum: - none - left - center - right example: center image_border_width: type: string title: Image border width description: Image border width. example: '2' image_border_style: type: string title: Image border style description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid image_border_color: type: string title: Image border color description: Image border color. example: '#896d6d' image_target: type: string title: Image target description: Image link target. enum: - _blank - 'null' example: _blank contents: type: array items: type: object title: Collection of Content for List Signup Forms description: Collection of Content for List Signup Forms. properties: section: type: string title: Content Section Name description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message value: type: string title: Content Section Value description: The content section text. example: Signup message goes here title: Signup form body content description: The signup form body content. styles: type: array items: type: object title: Collection of Element style for List Signup Forms description: Collection of Element style for List Signup Forms. properties: selector: type: string title: Selector description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background options: type: array title: Options description: A collection of options for a selector. items: type: object title: An option for Signup Form Styles description: An option for Signup Form Styles. properties: property: type: string title: Property description: A string that identifies the property. example: background-color value: type: string title: Value description: A string that identifies value of the property. example: '#111111' title: Signup Form element style description: >- An array of objects, each representing an element style for the signup form. required: true example: example_value responses: '200': description: '' schema: type: object title: Signup Form description: List signup form. properties: header: type: object title: Signup form header options description: Options for customizing your signup form header. properties: image_url: type: string title: Header Image URL description: Header image URL. example: >- http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png text: type: string title: Header Text description: Header text. example: Header Text goes here image_width: type: string title: Image width description: Image width, in pixels. example: '800' image_height: type: string title: Image height description: Image height, in pixels. example: '200' image_alt: type: string title: Image Alt description: Alt text for the image. example: This is an image image_link: type: string title: Image Link description: The URL that the header image will link to. example: gotothisimage.com image_align: type: string title: Image align description: Image alignment. enum: - none - left - center - right example: center image_border_width: type: string title: Image border width description: Image border width. example: '2' image_border_style: type: string title: Image border style description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid image_border_color: type: string title: Image border color description: Image border color. example: '#896d6d' image_target: type: string title: Image target description: Image link target. enum: - _blank - 'null' example: _blank contents: type: array items: type: object title: Collection of Content for List Signup Forms description: Collection of Content for List Signup Forms. properties: section: type: string title: Content Section Name description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message value: type: string title: Content Section Value description: The content section text. example: Signup message goes here title: Signup form body content description: The signup form body content. styles: type: array items: type: object title: Collection of Element style for List Signup Forms description: Collection of Element style for List Signup Forms. properties: selector: type: string title: Selector description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background options: type: array title: Options description: A collection of options for a selector. items: type: object title: An option for Signup Form Styles description: An option for Signup Form Styles. properties: property: type: string title: Property description: A string that identifies the property. example: background-color value: type: string title: Value description: A string that identifies value of the property. example: '#111111' title: Signup Form element style description: >- An array of objects, each representing an element style for the signup form. signup_form_url: type: string title: Signup form URL description: Signup form URL. list_id: type: string title: List ID description: The signup form's list id. readOnly: true example: 4ca5becb8d _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: - Forms - List_id - Signup x-custom-config: methodNameSnake: update_list_signup_form methodNameCamel: updateListSignupForm x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/locations: get: summary: Mailchimp List Locations description: >- Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address. operationId: getListsIdLocations 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 example: example_value - 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 example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Locations description: A summary of List's locations. properties: locations: type: array items: type: object title: List Location properties: country: type: string title: Country Name description: The name of the country. readOnly: true cc: type: string title: cc description: The ISO 3166 2 digit country code. readOnly: true percent: type: number title: percent description: The percent of subscribers in the country. readOnly: true total: type: integer title: total description: The total number of subscribers in the country. readOnly: true title: Locations description: >- An array of objects, each representing a list's top subscriber locations. list_id: type: string title: List ID description: The unique id for the list. 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: - List_id - Locations x-custom-config: methodNameSnake: get_list_locations methodNameCamel: getListLocations x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/surveys: get: summary: Mailchimp Get Information About All Surveys for a List description: Get information about all available surveys for a specific list. operationId: getListsIdSurveys parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' 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: - List_id - Surveys x-custom-config: methodNameSnake: get_all_surveys_for_list methodNameCamel: getAllSurveysForList x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/surveys/{survey_id}: get: summary: Mailchimp Get Survey description: Get details about a specific survey. operationId: getListsIdSurveysId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' responses: '200': description: '' 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: - List_id - Lists - Surveys x-custom-config: methodNameSnake: get_survey methodNameCamel: getSurvey x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/surveys/{survey_id}/actions/publish: post: summary: Mailchimp Publish a Survey description: >- Publish a survey that is in draft, unpublished, or has been previously published and edited. parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' responses: '200': description: Survey Published 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: - Actions - List_id - Publish - Surveys x-custom-config: methodNameSnake: publish_survey methodNameCamel: publishSurvey operationId: postListsIdSurveysIdActionsPublish x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/surveys/{survey_id}/actions/unpublish: post: summary: Mailchimp Unpublish a Survey description: Unpublish a survey that has been published. parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' responses: '200': description: Survey Instance 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: - Actions - List_id - Surveys x-custom-config: methodNameSnake: unpublish_survey methodNameCamel: unpublishSurvey operationId: postListsIdSurveysIdActionsUnpublish x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/surveys/{survey_id}/actions/create-email: post: summary: Mailchimp Create a Survey Campaign description: >- Utilize the List ID and Survey ID to generate a Campaign that links to your survey. parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' responses: '200': description: Campaign Instance schema: type: object title: Campaign description: A summary of an individual campaign's settings and content. required: - type properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: The date and time the campaign was created in ISO 8601 format. readOnly: true archive_url: type: string title: Archive URL description: The link to the campaign's archive version. readOnly: true long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send 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 campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: true recipients: type: object title: List description: List settings for the campaign. required: - list_id properties: list_id: type: string title: List ID description: The unique list id. 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/save-and-manage-segments/) 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: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: Use Mailchimp Conversation feature to manage replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: true drag_and_drop: type: boolean title: Drag And Drop Campaign description: Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. required: - winner_criteria properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. required: - feed_url - frequency properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/). daily_send: type: object title: Daily Sending Days description: The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. 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: - Actions - Email - List_id - Surveys x-custom-config: methodNameSnake: create_email methodNameCamel: createEmail operationId: postListsIdSurveysIdActionsCreateEmail x-microcks-operation: delay: 0 dispatcher: FALLBACK /landing-pages: get: description: Get all landing pages. operationId: getAllLandingPages parameters: - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - created_at - updated_at example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: Landing Pages Collection schema: type: object description: A collection of landing pages. properties: landing_pages: type: array description: The landing pages on the account items: type: object title: Landing Page description: >- A summary of an individual landing page's settings and content. properties: id: type: string title: Landing Page ID description: A string that uniquely identifies this landing page. readOnly: true example: 030092c2e1f0 name: type: string title: Landing Page Name description: The name of this landing page. readOnly: false title: type: string title: Landing Page title description: >- The title of this landing page seen in the browser's title bar. readOnly: false description: type: string title: Landing Page description description: The description of this landing page. readOnly: false template_id: type: integer title: Landing Page template_id description: The template_id of this landing page. readOnly: true status: type: string title: Landing Page status description: The status of this landing page. enum: - published - unpublished - draft readOnly: true list_id: type: string title: Landing Page list id description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false store_id: type: string title: Store ID description: The ID of the store associated with this landing page. readOnly: false web_id: type: integer title: Landing Page Web ID description: The ID used in the Mailchimp web application. created_by_source: type: string title: Created By Source description: Created by mobile or web readOnly: true url: type: string title: Published url description: The url of the published landing page. readOnly: true created_at: type: string title: Created At description: The time this landing page was created. format: date-time readOnly: true published_at: type: string title: Published at description: The time this landing page was published. format: date-time readOnly: true unpublished_at: type: string title: Unpublished at description: The time this landing page was unpublished. format: date-time readOnly: true updated_at: type: string title: Updated_at description: The time this landing page was updated at. format: date-time readOnly: true tracking: type: object title: Tracking Settings description: The tracking settings applied to this landing page. properties: track_with_mailchimp: type: boolean title: Track with Mailchimp description: >- Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). enable_restricted_data_processing: type: boolean title: Enable restricted data processing description: >- Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). _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 tags: - Landing - Pages x-custom-config: methodNameSnake: get_all methodNameCamel: getAll summary: Mailchimp List Landing Pages x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Landing Page description: Create a new Mailchimp landing page. parameters: - name: body in: body description: '' required: true schema: type: object title: Landing Page description: A summary of an individual page's properties. properties: name: type: string title: Landing Page Name description: The name of this landing page. title: type: string title: Landing Page title description: >- The title of this landing page seen in the browser's title bar. description: type: string title: Landing Page description description: The description of this landing page. store_id: type: string title: Store ID description: The ID of the store associated with this landing page. list_id: type: string title: Landing Page list id description: The list's ID associated with this landing page. type: type: string title: Landing Page Template Type description: The type of template the landing page has. enum: - signup - product example: signup template_id: type: integer title: Landing Page template_id description: The template_id of this landing page. example: 1001 tracking: type: object title: Tracking Settings description: The tracking settings applied to this landing page. properties: track_with_mailchimp: type: boolean title: Track with Mailchimp description: >- Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). enable_restricted_data_processing: type: boolean title: Enable restricted data processing description: >- Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). example: example_value - in: query name: use_default_list x-title: Use Default List type: boolean required: false description: >- Will create the Landing Page using the account's Default List instead of requiring a list_id. example: example_value responses: '200': description: '' schema: type: object title: Landing Page description: A summary of an individual landing page's settings and content. properties: id: type: string title: Landing Page ID description: A string that uniquely identifies this landing page. readOnly: true example: 030092c2e1f0 name: type: string title: Landing Page Name description: The name of this landing page. readOnly: false title: type: string title: Landing Page title description: >- The title of this landing page seen in the browser's title bar. readOnly: false description: type: string title: Landing Page description description: The description of this landing page. readOnly: false template_id: type: integer title: Landing Page template_id description: The template_id of this landing page. readOnly: true status: type: string title: Landing Page status description: The status of this landing page. enum: - published - unpublished - draft readOnly: true list_id: type: string title: Landing Page list id description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false store_id: type: string title: Store ID description: The ID of the store associated with this landing page. readOnly: false web_id: type: integer title: Landing Page Web ID description: The ID used in the Mailchimp web application. created_by_source: type: string title: Created By Source description: Created by mobile or web readOnly: true url: type: string title: Published url description: The url of the published landing page. readOnly: true created_at: type: string title: Created At description: The time this landing page was created. format: date-time readOnly: true published_at: type: string title: Published at description: The time this landing page was published. format: date-time readOnly: true unpublished_at: type: string title: Unpublished at description: The time this landing page was unpublished. format: date-time readOnly: true updated_at: type: string title: Updated_at description: The time this landing page was updated at. format: date-time readOnly: true tracking: type: object title: Tracking Settings description: The tracking settings applied to this landing page. properties: track_with_mailchimp: type: boolean title: Track with Mailchimp description: >- Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). enable_restricted_data_processing: type: boolean title: Enable restricted data processing description: >- Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). _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: - Landing - Pages x-custom-config: methodNameSnake: create methodNameCamel: create operationId: postAllLandingPages x-microcks-operation: delay: 0 dispatcher: FALLBACK /landing-pages/{page_id}: get: summary: Mailchimp Get Landing Page Info description: Get information about a specific page. 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 example: example_value - 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 example: example_value - in: path name: page_id x-title: Landing Page unique ID type: string required: true description: The unique id for the page. example: '500123' responses: '200': description: Landing Pages Instance schema: type: object title: Landing Page description: A summary of an individual landing page's settings and content. properties: id: type: string title: Landing Page ID description: A string that uniquely identifies this landing page. readOnly: true example: 030092c2e1f0 name: type: string title: Landing Page Name description: The name of this landing page. readOnly: false title: type: string title: Landing Page title description: >- The title of this landing page seen in the browser's title bar. readOnly: false description: type: string title: Landing Page description description: The description of this landing page. readOnly: false template_id: type: integer title: Landing Page template_id description: The template_id of this landing page. readOnly: true status: type: string title: Landing Page status description: The status of this landing page. enum: - published - unpublished - draft readOnly: true list_id: type: string title: Landing Page list id description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false store_id: type: string title: Store ID description: The ID of the store associated with this landing page. readOnly: false web_id: type: integer title: Landing Page Web ID description: The ID used in the Mailchimp web application. created_by_source: type: string title: Created By Source description: Created by mobile or web readOnly: true url: type: string title: Published url description: The url of the published landing page. readOnly: true created_at: type: string title: Created At description: The time this landing page was created. format: date-time readOnly: true published_at: type: string title: Published at description: The time this landing page was published. format: date-time readOnly: true unpublished_at: type: string title: Unpublished at description: The time this landing page was unpublished. format: date-time readOnly: true updated_at: type: string title: Updated_at description: The time this landing page was updated at. format: date-time readOnly: true tracking: type: object title: Tracking Settings description: The tracking settings applied to this landing page. properties: track_with_mailchimp: type: boolean title: Track with Mailchimp description: >- Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). enable_restricted_data_processing: type: boolean title: Enable restricted data processing description: >- Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). _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: - Landing - Landing Pages - Pages x-custom-config: methodNameSnake: get_page methodNameCamel: getPage operationId: getLandingPageId x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Landing Page description: Update a landing page. parameters: - in: path name: page_id x-title: Landing Page unique ID type: string required: true description: The unique id for the page. example: '500123' - name: body in: body description: '' required: true schema: type: object title: Landing Page description: A summary of an individual page's properties. properties: name: type: string title: Landing Page Name description: The name of this landing page. title: type: string title: Landing Page title description: >- The title of this landing page seen in the browser's title bar. description: type: string title: Landing Page description description: The description of this landing page. store_id: type: string title: Store ID description: The ID of the store associated with this landing page. list_id: type: string title: Landing Page list id description: The list's ID associated with this landing page. tracking: type: object title: Tracking Settings description: The tracking settings applied to this landing page. properties: track_with_mailchimp: type: boolean title: Track with Mailchimp description: >- Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). enable_restricted_data_processing: type: boolean title: Enable restricted data processing description: >- Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). example: example_value responses: '200': description: '' schema: type: object title: Landing Page description: A summary of an individual landing page's settings and content. properties: id: type: string title: Landing Page ID description: A string that uniquely identifies this landing page. readOnly: true example: 030092c2e1f0 name: type: string title: Landing Page Name description: The name of this landing page. readOnly: false title: type: string title: Landing Page title description: >- The title of this landing page seen in the browser's title bar. readOnly: false description: type: string title: Landing Page description description: The description of this landing page. readOnly: false template_id: type: integer title: Landing Page template_id description: The template_id of this landing page. readOnly: true status: type: string title: Landing Page status description: The status of this landing page. enum: - published - unpublished - draft readOnly: true list_id: type: string title: Landing Page list id description: The list's ID associated with this landing page. example: fde02ad86b readOnly: false store_id: type: string title: Store ID description: The ID of the store associated with this landing page. readOnly: false web_id: type: integer title: Landing Page Web ID description: The ID used in the Mailchimp web application. created_by_source: type: string title: Created By Source description: Created by mobile or web readOnly: true url: type: string title: Published url description: The url of the published landing page. readOnly: true created_at: type: string title: Created At description: The time this landing page was created. format: date-time readOnly: true published_at: type: string title: Published at description: The time this landing page was published. format: date-time readOnly: true unpublished_at: type: string title: Unpublished at description: The time this landing page was unpublished. format: date-time readOnly: true updated_at: type: string title: Updated_at description: The time this landing page was updated at. format: date-time readOnly: true tracking: type: object title: Tracking Settings description: The tracking settings applied to this landing page. properties: track_with_mailchimp: type: boolean title: Track with Mailchimp description: >- Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/). enable_restricted_data_processing: type: boolean title: Enable restricted data processing description: >- Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/). _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: - Landing - Landing Pages - Pages x-custom-config: methodNameSnake: update_page methodNameCamel: updatePage operationId: patchLandingPageId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Landing Page description: Delete a landing page. parameters: - in: path name: page_id x-title: Landing Page unique ID type: string required: true description: The unique id for the page. example: '500123' 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: - Landing - Landing Pages - Pages x-custom-config: methodNameSnake: delete_page methodNameCamel: deletePage operationId: deleteLandingPageId x-microcks-operation: delay: 0 dispatcher: FALLBACK /landing-pages/{page_id}/actions/publish: post: summary: Mailchimp Publish Landing Page description: >- Publish a landing page that is in draft, unpublished, or has been previously published and edited. parameters: - in: path name: page_id x-title: Landing Page unique ID type: string required: true description: The unique id for the page. example: '500123' 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: - Actions - Landing - Pages - Publish x-custom-config: methodNameSnake: publish_page methodNameCamel: publishPage operationId: postLandingPageIdActionsPublish x-microcks-operation: delay: 0 dispatcher: FALLBACK /landing-pages/{page_id}/actions/unpublish: post: summary: Mailchimp Unpublish Landing Page description: Unpublish a landing page that is in draft or has been published. parameters: - in: path name: page_id x-title: Landing Page unique ID type: string required: true description: The unique id for the page. example: '500123' 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: - Actions - Landing - Landing Pages - Pages x-custom-config: methodNameSnake: unpublish_page methodNameCamel: unpublishPage operationId: postLandingPageIdActionsUnpublish x-microcks-operation: delay: 0 dispatcher: FALLBACK /landing-pages/{page_id}/content: get: summary: Mailchimp Get Landing Page Content description: Get the the HTML for your landing page. 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 example: example_value - 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 example: example_value - in: path name: page_id x-title: Landing Page unique ID type: string required: true description: The unique id for the page. example: '500123' responses: '200': description: '' schema: type: object title: Landing Page Content description: The HTML content for a landing page. properties: html: type: string title: Landing Page HTML description: The raw HTML for the landing page. json: type: string title: Landing Page JSON description: The JSON Structure for the landing page _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: - Content - Landing - Pages x-custom-config: methodNameSnake: get_page_content methodNameCamel: getPageContent operationId: getLandingPageIdContent x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports: get: summary: Mailchimp List Campaign Reports description: Get campaign reports. operationId: getReports 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: type x-title: Campaign Type in: query description: The campaign type. required: false type: string enum: - regular - plaintext - absplit - rss - variate example: example_value - name: before_send_time x-title: Before Send Time in: query description: >- Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value - name: since_send_time x-title: Since Send Time in: query description: >- Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string format: date-time required: false example: example_value responses: '200': description: '' schema: type: object title: Campaign Reports description: A list of reports containing campaigns marked as Sent. properties: reports: type: array items: type: object title: Campaign Report description: Report details about a sent campaign. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. campaign_title: type: string title: Campaign Title description: The title of the campaign. readOnly: true type: type: string title: Campaign Type description: >- The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). list_id: type: string title: List ID description: The unique list id. readOnly: true 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 subject_line: type: string title: Campaign Subject Line description: The subject line for the campaign. readOnly: true preview_text: type: string title: Campaign Preview Text description: The preview text for the campaign. emails_sent: type: integer title: Emails Sent description: The total number of emails sent for this campaign. abuse_reports: type: integer title: Abuse Reports description: The number of abuse reports generated for this campaign. unsubscribed: type: integer title: Unsubscribe Count description: >- The total number of unsubscribed members for this campaign. readOnly: true send_time: type: string format: date-time title: Send Time description: >- The date and time a campaign was sent in ISO 8601 format. readOnly: true rss_last_send: type: string format: date-time title: RSS Last Send description: >- For RSS campaigns, the date and time of the last send in ISO 8601 format. readOnly: true bounces: type: object title: Bounces description: >- An object describing the bounce summary for the campaign. properties: hard_bounces: type: integer title: Hard Bounces description: The total number of hard bounced email addresses. soft_bounces: type: integer title: Soft Bounces description: The total number of soft bounced email addresses. syntax_errors: type: integer title: Syntax Errors description: >- The total number of addresses that were syntax-related bounces. forwards: type: object title: Forwards description: >- An object describing the forwards and forward activity for the campaign. properties: forwards_count: type: integer title: Total Forwards description: How many times the campaign has been forwarded. forwards_opens: type: integer title: Forward Opens description: >- How many times the forwarded campaign has been opened. opens: type: object title: Opens description: An object describing the open activity for the campaign. properties: opens_total: type: integer title: Total Opens description: The total number of opens for a campaign. unique_opens: type: integer title: Unique Opens description: The total number of unique opens. open_rate: type: number title: Open Rate description: >- The number of unique opens divided by the total number of successful deliveries. last_open: type: string format: date-time title: Last Open description: >- The date and time of the last recorded open in ISO 8601 format. clicks: type: object title: Clicks description: >- An object describing the click activity for the campaign. properties: clicks_total: type: integer title: Total Clicks description: The total number of clicks for the campaign. unique_clicks: type: integer title: Unique Clicks description: >- The total number of unique clicks for links across a campaign. unique_subscriber_clicks: type: integer title: Unique Subscriber Clicks description: >- The total number of subscribers who clicked on a campaign. click_rate: type: number title: Click Rate description: >- The number of unique clicks divided by the total number of successful deliveries. last_click: type: string format: date-time title: Last Click description: >- The date and time of the last recorded click for the campaign in ISO 8601 format. facebook_likes: type: object title: Facebook Likes description: An object describing campaign engagement on Facebook. properties: recipient_likes: type: integer title: Recipient Likes description: >- The number of recipients who liked the campaign on Facebook. unique_likes: type: integer title: Unique Likes description: The number of unique likes. facebook_likes: type: integer title: Facebook Likes description: The number of Facebook likes for the campaign. industry_stats: type: object title: Industry Stats description: The average campaign statistics for your industry. properties: type: type: string title: Industry Type description: >- The type of business industry associated with your account. For example: retail, education, etc. open_rate: type: number title: Open Rate description: The industry open rate. click_rate: type: number title: Click Rate description: The industry click rate. bounce_rate: type: number title: Bounce Rate description: The industry bounce rate. unopen_rate: type: number title: Unopened Rate description: The industry unopened rate. unsub_rate: type: number title: Unsubscribe Rate description: The industry unsubscribe rate. abuse_rate: type: number title: Abuse Rate description: The industry abuse rate. list_stats: type: object title: List Stats description: >- The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: sub_rate: type: number title: Average Subscription Rate description: >- The average number of subscriptions per month for the list. readOnly: true unsub_rate: type: number title: Average Unsubscription Rate description: >- The average number of unsubscriptions per month for the list. readOnly: true open_rate: type: number title: Open Rate description: >- The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true click_rate: type: number title: Click Rate description: >- The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true ab_split: type: object title: A/B Split Stats description: >- General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Campaign A description: Stats for Campaign A. properties: bounces: type: integer title: Bounces description: Bounces for Campaign A. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign A. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign A. recipient_clicks: type: integer title: Recipient Clicks description: Recipient Clicks for Campaign A. forwards: type: integer title: Forwards description: Forwards for Campaign A. forwards_opens: type: integer title: Forward Opens description: Opens from forwards for Campaign A. opens: type: integer title: Opens description: Opens for Campaign A. last_open: type: string title: Last Open description: The last open for Campaign A. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign A. b: type: object title: Campaign B description: Stats for Campaign B. properties: bounces: type: integer title: Bounces description: Bounces for Campaign B. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign B. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign B. recipient_clicks: type: integer title: Recipient Clicks description: Recipients clicks for Campaign B. forwards: type: integer title: Forwards description: Forwards for Campaign B. forwards_opens: type: integer title: Forward Opens description: Opens for forwards from Campaign B. opens: type: integer title: Opens description: Opens for Campaign B. last_open: type: string title: Last Open description: The last open for Campaign B. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign B. timewarp: type: array title: Timewarp Stats description: >- An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: type: object properties: gmt_offset: type: integer title: GMT Offset description: >- For campaigns sent with timewarp, the time zone group the member is apart of. opens: type: integer title: Opens description: The number of opens. last_open: type: string format: date-time title: Last Open description: >- The date and time of the last open in ISO 8601 format. unique_opens: type: integer title: Unique Opens description: The number of unique opens. clicks: type: integer title: Clicks description: The number of clicks. last_click: type: string format: date-time title: Last Click description: >- The date and time of the last click in ISO 8601 format. unique_clicks: type: integer title: Unique Clicks description: The number of unique clicks. bounces: type: integer title: Bounces description: The number of bounces. timeseries: type: array title: Timeseries description: >- An hourly breakdown of the performance of the campaign over the first 24 hours. items: type: object properties: timestamp: type: string format: date-time title: Timestamp description: >- The date and time for the series in ISO 8601 format. emails_sent: type: integer title: Emails Sent description: The number of emails sent in the timeseries. unique_opens: type: integer title: Unique Opens description: The number of unique opens in the timeseries. recipients_clicks: type: integer title: Recipient Clicks description: The number of clicks in the timeseries. share_report: type: object title: Share Report description: >- The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_url: type: string title: Report URL description: The URL for the VIP report. readOnly: true share_password: type: string title: Report Password description: >- If password protected, the password for the VIP report. readOnly: true ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true currency_code: type: string title: Three letter currency code for this user readOnly: true example: USD delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: >- The total number of emails canceled for this campaign. 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: Lists description: An array of objects, each representing a report resource. 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: - Reports x-custom-config: methodNameSnake: get_all_campaign_reports methodNameCamel: getAllCampaignReports x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}: get: summary: Mailchimp Get Campaign Report description: Get report details for a specific sent campaign. operationId: getReportsId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Campaign Report description: Report details about a sent campaign. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. campaign_title: type: string title: Campaign Title description: The title of the campaign. readOnly: true type: type: string title: Campaign Type description: >- The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). list_id: type: string title: List ID description: The unique list id. readOnly: true 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 subject_line: type: string title: Campaign Subject Line description: The subject line for the campaign. readOnly: true preview_text: type: string title: Campaign Preview Text description: The preview text for the campaign. emails_sent: type: integer title: Emails Sent description: The total number of emails sent for this campaign. abuse_reports: type: integer title: Abuse Reports description: The number of abuse reports generated for this campaign. unsubscribed: type: integer title: Unsubscribe Count description: The total number of unsubscribed members for this campaign. readOnly: true send_time: type: string format: date-time title: Send Time description: The date and time a campaign was sent in ISO 8601 format. readOnly: true rss_last_send: type: string format: date-time title: RSS Last Send description: >- For RSS campaigns, the date and time of the last send in ISO 8601 format. readOnly: true bounces: type: object title: Bounces description: An object describing the bounce summary for the campaign. properties: hard_bounces: type: integer title: Hard Bounces description: The total number of hard bounced email addresses. soft_bounces: type: integer title: Soft Bounces description: The total number of soft bounced email addresses. syntax_errors: type: integer title: Syntax Errors description: >- The total number of addresses that were syntax-related bounces. forwards: type: object title: Forwards description: >- An object describing the forwards and forward activity for the campaign. properties: forwards_count: type: integer title: Total Forwards description: How many times the campaign has been forwarded. forwards_opens: type: integer title: Forward Opens description: How many times the forwarded campaign has been opened. opens: type: object title: Opens description: An object describing the open activity for the campaign. properties: opens_total: type: integer title: Total Opens description: The total number of opens for a campaign. unique_opens: type: integer title: Unique Opens description: The total number of unique opens. open_rate: type: number title: Open Rate description: >- The number of unique opens divided by the total number of successful deliveries. last_open: type: string format: date-time title: Last Open description: >- The date and time of the last recorded open in ISO 8601 format. clicks: type: object title: Clicks description: An object describing the click activity for the campaign. properties: clicks_total: type: integer title: Total Clicks description: The total number of clicks for the campaign. unique_clicks: type: integer title: Unique Clicks description: >- The total number of unique clicks for links across a campaign. unique_subscriber_clicks: type: integer title: Unique Subscriber Clicks description: The total number of subscribers who clicked on a campaign. click_rate: type: number title: Click Rate description: >- The number of unique clicks divided by the total number of successful deliveries. last_click: type: string format: date-time title: Last Click description: >- The date and time of the last recorded click for the campaign in ISO 8601 format. facebook_likes: type: object title: Facebook Likes description: An object describing campaign engagement on Facebook. properties: recipient_likes: type: integer title: Recipient Likes description: >- The number of recipients who liked the campaign on Facebook. unique_likes: type: integer title: Unique Likes description: The number of unique likes. facebook_likes: type: integer title: Facebook Likes description: The number of Facebook likes for the campaign. industry_stats: type: object title: Industry Stats description: The average campaign statistics for your industry. properties: type: type: string title: Industry Type description: >- The type of business industry associated with your account. For example: retail, education, etc. open_rate: type: number title: Open Rate description: The industry open rate. click_rate: type: number title: Click Rate description: The industry click rate. bounce_rate: type: number title: Bounce Rate description: The industry bounce rate. unopen_rate: type: number title: Unopened Rate description: The industry unopened rate. unsub_rate: type: number title: Unsubscribe Rate description: The industry unsubscribe rate. abuse_rate: type: number title: Abuse Rate description: The industry abuse rate. list_stats: type: object title: List Stats description: >- The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: sub_rate: type: number title: Average Subscription Rate description: >- The average number of subscriptions per month for the list. readOnly: true unsub_rate: type: number title: Average Unsubscription Rate description: >- The average number of unsubscriptions per month for the list. readOnly: true open_rate: type: number title: Open Rate description: >- The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true click_rate: type: number title: Click Rate description: >- The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true ab_split: type: object title: A/B Split Stats description: >- General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Campaign A description: Stats for Campaign A. properties: bounces: type: integer title: Bounces description: Bounces for Campaign A. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign A. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign A. recipient_clicks: type: integer title: Recipient Clicks description: Recipient Clicks for Campaign A. forwards: type: integer title: Forwards description: Forwards for Campaign A. forwards_opens: type: integer title: Forward Opens description: Opens from forwards for Campaign A. opens: type: integer title: Opens description: Opens for Campaign A. last_open: type: string title: Last Open description: The last open for Campaign A. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign A. b: type: object title: Campaign B description: Stats for Campaign B. properties: bounces: type: integer title: Bounces description: Bounces for Campaign B. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign B. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign B. recipient_clicks: type: integer title: Recipient Clicks description: Recipients clicks for Campaign B. forwards: type: integer title: Forwards description: Forwards for Campaign B. forwards_opens: type: integer title: Forward Opens description: Opens for forwards from Campaign B. opens: type: integer title: Opens description: Opens for Campaign B. last_open: type: string title: Last Open description: The last open for Campaign B. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign B. timewarp: type: array title: Timewarp Stats description: >- An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: type: object properties: gmt_offset: type: integer title: GMT Offset description: >- For campaigns sent with timewarp, the time zone group the member is apart of. opens: type: integer title: Opens description: The number of opens. last_open: type: string format: date-time title: Last Open description: The date and time of the last open in ISO 8601 format. unique_opens: type: integer title: Unique Opens description: The number of unique opens. clicks: type: integer title: Clicks description: The number of clicks. last_click: type: string format: date-time title: Last Click description: The date and time of the last click in ISO 8601 format. unique_clicks: type: integer title: Unique Clicks description: The number of unique clicks. bounces: type: integer title: Bounces description: The number of bounces. timeseries: type: array title: Timeseries description: >- An hourly breakdown of the performance of the campaign over the first 24 hours. items: type: object properties: timestamp: type: string format: date-time title: Timestamp description: The date and time for the series in ISO 8601 format. emails_sent: type: integer title: Emails Sent description: The number of emails sent in the timeseries. unique_opens: type: integer title: Unique Opens description: The number of unique opens in the timeseries. recipients_clicks: type: integer title: Recipient Clicks description: The number of clicks in the timeseries. share_report: type: object title: Share Report description: >- The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_url: type: string title: Report URL description: The URL for the VIP report. readOnly: true share_password: type: string title: Report Password description: If password protected, the password for the VIP report. readOnly: true ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true currency_code: type: string title: Three letter currency code for this user readOnly: true example: USD delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: The total number of emails canceled for this campaign. 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: - Reports x-custom-config: methodNameSnake: get_campaign_report methodNameCamel: getCampaignReport x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/abuse-reports: get: summary: Mailchimp List Abuse Reports description: Get a list of abuse complaints for a specific campaign. operationId: getReportsIdAbuseReportsId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaints description: A list of abuse complaints for a specific list. properties: abuse_reports: type: array items: type: object title: Abuse Complaint description: >- Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The unique id of the list for the abuse report. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true date: type: string title: Date description: Date for the abuse report format: date-time 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: Abuse Reports description: >- An array of objects, each representing an abuse report resource. campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Abuse - Reports x-custom-config: methodNameSnake: get_campaign_abuse_reports methodNameCamel: getCampaignAbuseReports x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/abuse-reports/{report_id}: get: summary: Mailchimp Get Abuse Report description: Get information about a specific abuse report for a campaign. operationId: getReportsIdAbuseReportsIdId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: report_id in: path required: true type: string description: The id for the abuse report. example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaint description: >- Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The unique id of the list for the abuse report. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true date: type: string title: Date description: Date for the abuse report format: date-time 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: - Abuse - Reports x-custom-config: methodNameSnake: get_campaign_abuse_report methodNameCamel: getCampaignAbuseReport x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/advice: get: summary: Mailchimp List Campaign Feedback description: >- Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more. operationId: getReportsIdAdvice 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Campaign Advice Report description: A list of feedback based on a campaign's statistics. properties: advice: type: array items: type: object title: Campaign Advice description: Campaign feedback details. properties: type: type: string title: Advice Type description: The sentiment type for a feedback message. enum: - negative - positive - neutral readOnly: true message: type: string title: Advice Message description: The advice message. 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: Campaign Advice description: >- An array of objects, each representing a point of campaign feedback. campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Advice - Reports x-custom-config: methodNameSnake: get_campaign_advice methodNameCamel: getCampaignAdvice x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/click-details: get: summary: Mailchimp List Campaign Details description: >- Get information about clicks on specific links in your Mailchimp campaigns. operationId: getReportsIdClickDetails 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: sort_field x-title: Sort By Field description: Returns click reports sorted by the specified field. in: query required: false type: string enum: - total_clicks - unique_clicks example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: '' schema: type: object title: Click Detail Report description: >- A list of URLs and unique IDs included in HTML and plain-text versions of a campaign. properties: urls_clicked: type: array items: type: object title: Click Detail Report description: A report of links clicked in a specific campaign. properties: id: type: string title: URL ID description: The unique id for the link. readOnly: true url: type: string title: URL description: The URL for the link in the campaign. readOnly: true total_clicks: type: integer title: Total Clicks description: The number of total clicks for a link. readOnly: true click_percentage: type: number title: Click Percentage description: >- The percentage of total clicks a link generated for a campaign. readOnly: true unique_clicks: type: integer title: Unique Clicks description: Number of unique clicks for a link. readOnly: true unique_click_percentage: type: number title: Unique Click Percentage description: >- The percentage of unique clicks a link generated for a campaign. readOnly: true last_click: type: string title: Last Click description: >- The date and time for the last recorded click for a link in ISO 8601 format. format: date-time readOnly: true ab_split: type: object title: A/B Split description: >- A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Group A description: Stats for Group A. properties: total_clicks_a: type: integer title: Total Clicks Group A description: The total number of clicks for Group A. readOnly: true click_percentage_a: type: number title: Click Percentage Group A description: The percentage of total clicks for Group A. readOnly: true unique_clicks_a: type: integer title: Unique Clicks Group A description: The number of unique clicks for Group A. readOnly: true unique_click_percentage_a: type: number title: Unique Click Percentage Group A description: The percentage of unique clicks for Group A. readOnly: true b: type: object title: Group B description: Stats for Group B. properties: total_clicks_b: type: integer title: Total Clicks Group B description: The total number of clicks for Group B. readOnly: true click_percentage_b: type: number title: Click Percentage Group B description: The percentage of total clicks for Group B. readOnly: true unique_clicks_b: type: integer title: Unique Clicks Group B description: The number of unique clicks for Group B. readOnly: true unique_click_percentage_b: type: number title: Unique Click Percentage Group B description: The percentage of unique clicks for Group B. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. 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: URLs Clicked description: >- An array of objects, each representing a specific URL contained in the campaign. campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Click - Reports x-custom-config: methodNameSnake: get_campaign_click_details methodNameCamel: getCampaignClickDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/click-details/{link_id}: get: summary: Mailchimp Get Campaign Link Details description: Get click details for a specific link in a campaign. operationId: getReportsIdClickDetailsId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: link_id x-title: Link ID description: The id for the link. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Click Detail Report description: A report of links clicked in a specific campaign. properties: id: type: string title: URL ID description: The unique id for the link. readOnly: true url: type: string title: URL description: The URL for the link in the campaign. readOnly: true total_clicks: type: integer title: Total Clicks description: The number of total clicks for a link. readOnly: true click_percentage: type: number title: Click Percentage description: >- The percentage of total clicks a link generated for a campaign. readOnly: true unique_clicks: type: integer title: Unique Clicks description: Number of unique clicks for a link. readOnly: true unique_click_percentage: type: number title: Unique Click Percentage description: >- The percentage of unique clicks a link generated for a campaign. readOnly: true last_click: type: string title: Last Click description: >- The date and time for the last recorded click for a link in ISO 8601 format. format: date-time readOnly: true ab_split: type: object title: A/B Split description: >- A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Group A description: Stats for Group A. properties: total_clicks_a: type: integer title: Total Clicks Group A description: The total number of clicks for Group A. readOnly: true click_percentage_a: type: number title: Click Percentage Group A description: The percentage of total clicks for Group A. readOnly: true unique_clicks_a: type: integer title: Unique Clicks Group A description: The number of unique clicks for Group A. readOnly: true unique_click_percentage_a: type: number title: Unique Click Percentage Group A description: The percentage of unique clicks for Group A. readOnly: true b: type: object title: Group B description: Stats for Group B. properties: total_clicks_b: type: integer title: Total Clicks Group B description: The total number of clicks for Group B. readOnly: true click_percentage_b: type: number title: Click Percentage Group B description: The percentage of total clicks for Group B. readOnly: true unique_clicks_b: type: integer title: Unique Clicks Group B description: The number of unique clicks for Group B. readOnly: true unique_click_percentage_b: type: number title: Unique Click Percentage Group B description: The percentage of unique clicks for Group B. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Click - Reports x-custom-config: methodNameSnake: get_campaign_click_details_for_link methodNameCamel: getCampaignClickDetailsForLink x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/click-details/{link_id}/members: get: summary: Mailchimp List Clicked Link Subscribers description: >- Get information about list members who clicked on a specific link in a campaign. operationId: getReportsIdClickDetailsIdMembers 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: link_id x-title: Link ID description: The id for the link. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Click Detail Members description: >- A collection of members who clicked on a specific link within a campaign. properties: members: type: array items: type: object title: Click Detail Member description: >- A subscriber who clicked a specific URL in a specific campaign. properties: email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true clicks: type: integer title: Total Clicks description: >- The total number of times the subscriber clicked on the link. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true url_id: type: string title: URL ID description: The id for the tracked URL in the campaign. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true contact_status: type: string title: Member Status description: >- The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. 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: Lists description: >- An array of objects, each representing a member who clicked a specific link within a campaign. campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Click - Members - Reports x-custom-config: methodNameSnake: get_subscribers_info methodNameCamel: getSubscribersInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}: get: summary: Mailchimp Get Clicked Link Subscriber description: >- Get information about a specific subscriber who clicked a link in a specific campaign. operationId: getReportsIdClickDetailsIdMembersId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: link_id x-title: Link ID description: The id for the link. in: path required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Click Detail Member description: A subscriber who clicked a specific URL in a specific campaign. properties: email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true clicks: type: integer title: Total Clicks description: The total number of times the subscriber clicked on the link. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true url_id: type: string title: URL ID description: The id for the tracked URL in the campaign. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true contact_status: type: string title: Member Status description: >- The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. 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: - Click - Members - Reports x-custom-config: methodNameSnake: get_subscriber_info methodNameCamel: getSubscriberInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/open-details: get: summary: Mailchimp List Campaign Open Details description: >- Get detailed information about any campaign emails that were opened by a list member. operationId: getReportsIdOpenDetails 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: since x-title: Campaign opens since in: query required: false description: >- Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string x-example: '2016-04-12 12:00:00' example: example_value - name: sort_field x-title: Sort By Field description: Returns open reports sorted by the specified field. in: query required: false type: string enum: - opens_count example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: '' schema: type: object title: Open Detail Report description: >- A detailed report of any campaign emails that were opened by a list member. properties: members: type: array items: type: object title: Open Activity description: A list of a member's opens activity in a specific campaign. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true contact_status: type: string title: Member Status description: >- The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true opens_count: type: integer title: Opens count description: >- The total number of times the this campaign was opened by the list member. readOnly: true opens: type: array title: Time series data of opens activity description: >- An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: timestamp: type: string title: Timestamp description: >- The date and time recorded for the action in ISO 8601 format. format: date-time _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: Open Reports description: >- An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event. campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true total_opens: type: integer title: Total opens description: >- The total number of opens matching the query regardless of pagination. 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: - Open - Reports x-custom-config: methodNameSnake: get_campaign_open_details methodNameCamel: getCampaignOpenDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/open-details/{subscriber_hash}: get: summary: Mailchimp Get Opened Campaign Subscriber description: Get information about a specific subscriber who opened a campaign. operationId: getReportsIdOpenDetailsIdMembersId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Open Activity description: A list of a member's opens activity in a specific campaign. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true contact_status: type: string title: Member Status description: >- The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true opens_count: type: integer title: Opens count description: >- The total number of times the this campaign was opened by the list member. readOnly: true opens: type: array title: Time series data of opens activity description: >- An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: timestamp: type: string title: Timestamp description: >- The date and time recorded for the action in ISO 8601 format. format: date-time _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: - Open - Reports x-custom-config: methodNameSnake: get_subscriber_info_for_opened_campaign methodNameCamel: getSubscriberInfoForOpenedCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/domain-performance: get: summary: Mailchimp List Domain Performance Stats description: Get statistics for the top-performing email domains in a campaign. operationId: getReportsIdDomainPerformance 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Domain Performance description: Statistics for the top-performing email domains in a campaign. properties: domains: type: array items: type: object title: Email Domain description: A single email domain's performance properties: domain: type: string title: Domain description: >- The name of the domain (gmail.com, hotmail.com, yahoo.com). readOnly: true emails_sent: type: integer title: Total Sent description: The number of emails sent to that specific domain. readOnly: true bounces: type: integer title: Bounces description: The number of bounces at a domain. readOnly: true opens: type: integer title: Opens description: The number of opens for a domain. readOnly: true clicks: type: integer title: Clicks description: The number of clicks for a domain. readOnly: true unsubs: type: integer title: Unsubscribes description: The total number of unsubscribes for a domain. readOnly: true delivered: type: integer title: Successful Deliveries description: The number of successful deliveries for a domain. readOnly: true emails_pct: type: number title: Email Percent description: The percentage of total emails that went to this domain. readOnly: true bounces_pct: type: number title: Bounces Percent description: The percentage of total bounces from this domain. readOnly: true opens_pct: type: number title: Opens Percent description: The percentage of total opens from this domain. readOnly: true clicks_pct: type: number title: Clicks Percent description: The percentage of total clicks from this domain. readOnly: true unsubs_pct: type: number title: Unsubscribes Percent description: The percentage of total unsubscribes from this domain. readOnly: true title: Lists description: The top 5 email domains based on total delivered emails. readOnly: true total_sent: type: integer title: Total Sent description: The total number of emails sent for the campaign. readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Domains - Performance - Reports x-custom-config: methodNameSnake: get_domain_performance_for_campaign methodNameCamel: getDomainPerformanceForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/eepurl: get: summary: Mailchimp List Eepurl Activity description: Get a summary of social activity for the campaign, tracked by EepURL. operationId: getReportsIdEepurl 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Eepurl Activity description: A summary of social activity for the campaign, tracked by EepURL. properties: twitter: type: object title: Twitter Stats description: A summary of Twitter activity for a campaign. properties: tweets: type: integer title: Tweet Count description: The number of tweets including a link to the campaign. readOnly: true first_tweet: type: string title: First Tweet Timestamp description: >- The day and time of the first recorded tweet with a link to the campaign. readOnly: true last_tweet: type: string title: Last Tweet Timestamp description: >- The day and time of the last recorded tweet with a link to the campaign. readOnly: true retweets: type: integer title: Retweet Count description: >- The number of retweets that include a link to the campaign. readOnly: true statuses: type: array title: Twitter Status description: A summary of tweets that include a link to the campaign. readOnly: true items: type: object title: Twitter Status description: An individual tweet. properties: status: type: string title: Status Body description: The body of the tweet. readOnly: true screen_name: type: string title: Screen Name description: The Twitter handle for the author of the tweet. readOnly: true status_id: type: string title: Status ID description: The individual id for the tweet. readOnly: true datetime: type: string title: Datetime description: A timestamp for the tweet. format: date-time readOnly: true is_retweet: type: boolean title: Is Retweet description: >- A 'true' or 'false' status of whether the tweet is a retweet. readOnly: true clicks: type: object title: Click Summary description: A summary of the click-throughs on the campaign's URL. readOnly: true properties: clicks: type: integer title: Clicks description: The total number of clicks to the campaign's URL. readOnly: true first_click: type: string title: First Click description: The timestamp for the first click to the URL. format: date-time readOnly: true last_click: type: string title: Last Click description: The timestamp for the last click to the URL. format: date-time readOnly: true locations: type: array title: Click Locations description: A summary of the top click locations. readOnly: true items: type: object title: Location description: An individual click location. properties: country: type: string title: Country description: The two-digit country code for a recorded click. region: type: string title: Region description: >- If available, a specific region where the click was recorded. example: NY referrers: type: array title: Referrers description: A summary of the top referrers for the campaign. readOnly: true items: type: object title: Referrer description: A single instance of a campaign referral. properties: referrer: type: string title: Referrer description: A referrer (truncated to 100 bytes). clicks: type: integer title: Clicks description: The number of clicks a single referrer generated. first_click: type: string title: First Click description: The timestamp for the first click from this referrer. format: date-time last_click: type: string title: Last Click description: The timestamp for the last click from this referrer. format: date-time x-title: Referrers eepurl: type: string title: Eepurl description: The shortened link used for tracking. readOnly: true campaign_id: type: string title: Campaign ID description: The unique id for the campaign. 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: - Eepurl - Reports x-custom-config: methodNameSnake: get_eepurl_activity_for_campaign methodNameCamel: getEepurlActivityForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/email-activity: get: summary: Mailchimp List Email Activity description: Get a list of member's subscriber activity in a specific campaign. operationId: getReportsIdEmailActivity 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: since x-title: Email Activity since in: query required: false description: >- Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string example: example_value responses: '200': description: '' schema: type: object title: Email Activity description: A list of member's subscriber activity in a specific campaign. properties: emails: type: array items: type: object title: Email Activity description: >- A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true activity: type: array title: Member Activity description: >- An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: action: type: string title: Action description: >- One of the following actions: 'open', 'click', or 'bounce' type: type: string title: Type description: >- If the action is a 'bounce', the type of bounce received: 'hard', 'soft'. timestamp: type: string title: Timestamp description: >- The date and time recorded for the action in ISO 8601 format. format: date-time url: type: string title: URL description: >- If the action is a 'click', the URL on which the member clicked. ip: type: string title: IP description: The IP address recorded for the action. _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: Sent To description: An array of members that were sent the campaign. campaign_id: type: string title: Campaign ID description: The unique id for the sent campaign. 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: - Activity - Email - Reports x-custom-config: methodNameSnake: get_email_activity_for_campaign methodNameCamel: getEmailActivityForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/email-activity/{subscriber_hash}: get: summary: Mailchimp Get Subscriber Email Activity description: >- Get a specific list member's activity in a campaign including opens, clicks, and bounces. operationId: getReportsIdEmailActivityId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: since x-title: Email Activity since in: query required: false description: >- Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. type: string example: example_value responses: '200': description: '' schema: type: object title: Email Activity description: >- A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces. properties: campaign_id: type: string title: Campaign ID description: The unique id for the campaign. readOnly: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. readOnly: true email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true activity: type: array title: Member Activity description: >- An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign. items: type: object title: Member Activity description: A summary of the interaction with the campaign. properties: action: type: string title: Action description: >- One of the following actions: 'open', 'click', or 'bounce' type: type: string title: Type description: >- If the action is a 'bounce', the type of bounce received: 'hard', 'soft'. timestamp: type: string title: Timestamp description: >- The date and time recorded for the action in ISO 8601 format. format: date-time url: type: string title: URL description: >- If the action is a 'click', the URL on which the member clicked. ip: type: string title: IP description: The IP address recorded for the action. _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: - Activity - Email - Reports x-custom-config: methodNameSnake: get_email_activity_for_subscriber methodNameCamel: getEmailActivityForSubscriber x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/locations: get: summary: Mailchimp List Top Open Activities description: Get top open locations for a specific campaign. operationId: getReportsIdLocations 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: Open Locations description: Top open locations for a specific campaign. properties: locations: type: array items: type: object properties: country_code: type: string title: Country Code description: The ISO 3166 2 digit country code. readOnly: true region: type: string title: Region description: >- An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region. readOnly: true region_name: type: string title: Region Name description: >- The name of the region, if we have one. For blank "region" values, this will be "Rest of Country". readOnly: true opens: type: integer title: Opens description: The number of unique campaign opens for a region. readOnly: true title: Lists description: >- An array of objects, each representing a top location for opens. campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Locations - Reports x-custom-config: methodNameSnake: get_locations_for_campaign methodNameCamel: getLocationsForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/sent-to: get: summary: Mailchimp List Campaign Recipients description: Get information about campaign recipients. operationId: getReportsIdSentTo 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Sent-To description: A list of subscribers who were sent a specific campaign. properties: sent_to: type: array items: type: object title: Sent To description: A subscriber's status for a specific campaign. properties: email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true status: type: string title: Delivery Status description: >- The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft open_count: type: integer title: Open Count description: >- The number of times a campaign was opened by this member. last_open: type: string title: Last Open description: >- The date and time of the last open for this member in ISO 8601 format. format: date-time absplit_group: type: string title: A/B Split Group description: >- For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner gmt_offset: type: integer title: GMT Offset description: >- For campaigns sent with timewarp, the time zone group the member is apart of. campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true list_id: type: string title: List ID description: The unique list id. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. 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: Sent To description: An array of objects, each representing a campaign recipient. campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Reports - Sent x-custom-config: methodNameSnake: get_campaign_recipients methodNameCamel: getCampaignRecipients x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/sent-to/{subscriber_hash}: get: summary: Mailchimp Get Campaign Recipient Info description: Get information about a specific campaign recipient. operationId: getReportsIdSentToId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Sent To description: A subscriber's status for a specific campaign. properties: email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true status: type: string title: Delivery Status description: >- The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/). enum: - sent - hard - soft open_count: type: integer title: Open Count description: The number of times a campaign was opened by this member. last_open: type: string title: Last Open description: >- The date and time of the last open for this member in ISO 8601 format. format: date-time absplit_group: type: string title: A/B Split Group description: For A/B Split Campaigns, the group the member was apart of. enum: - a - b - winner gmt_offset: type: integer title: GMT Offset description: >- For campaigns sent with timewarp, the time zone group the member is apart of. campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true list_id: type: string title: List ID description: The unique list id. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. 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: - Reports - Sent x-custom-config: methodNameSnake: get_campaign_recipient methodNameCamel: getCampaignRecipient x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/sub-reports: get: summary: Mailchimp List Child Campaign Reports description: >- Get a list of reports with child campaigns for a specific parent campaign. operationId: getReportsIdSubReportsId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Campaign Sub-Reports description: >- A list of reports containing child campaigns for a specific campaign. properties: reports: type: array items: type: object title: Campaign Report description: Report details about a sent campaign. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. campaign_title: type: string title: Campaign Title description: The title of the campaign. readOnly: true type: type: string title: Campaign Type description: >- The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto). list_id: type: string title: List ID description: The unique list id. readOnly: true 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 subject_line: type: string title: Campaign Subject Line description: The subject line for the campaign. readOnly: true preview_text: type: string title: Campaign Preview Text description: The preview text for the campaign. emails_sent: type: integer title: Emails Sent description: The total number of emails sent for this campaign. abuse_reports: type: integer title: Abuse Reports description: The number of abuse reports generated for this campaign. unsubscribed: type: integer title: Unsubscribe Count description: >- The total number of unsubscribed members for this campaign. readOnly: true send_time: type: string format: date-time title: Send Time description: >- The date and time a campaign was sent in ISO 8601 format. readOnly: true rss_last_send: type: string format: date-time title: RSS Last Send description: >- For RSS campaigns, the date and time of the last send in ISO 8601 format. readOnly: true bounces: type: object title: Bounces description: >- An object describing the bounce summary for the campaign. properties: hard_bounces: type: integer title: Hard Bounces description: The total number of hard bounced email addresses. soft_bounces: type: integer title: Soft Bounces description: The total number of soft bounced email addresses. syntax_errors: type: integer title: Syntax Errors description: >- The total number of addresses that were syntax-related bounces. forwards: type: object title: Forwards description: >- An object describing the forwards and forward activity for the campaign. properties: forwards_count: type: integer title: Total Forwards description: How many times the campaign has been forwarded. forwards_opens: type: integer title: Forward Opens description: >- How many times the forwarded campaign has been opened. opens: type: object title: Opens description: An object describing the open activity for the campaign. properties: opens_total: type: integer title: Total Opens description: The total number of opens for a campaign. unique_opens: type: integer title: Unique Opens description: The total number of unique opens. open_rate: type: number title: Open Rate description: >- The number of unique opens divided by the total number of successful deliveries. last_open: type: string format: date-time title: Last Open description: >- The date and time of the last recorded open in ISO 8601 format. clicks: type: object title: Clicks description: >- An object describing the click activity for the campaign. properties: clicks_total: type: integer title: Total Clicks description: The total number of clicks for the campaign. unique_clicks: type: integer title: Unique Clicks description: >- The total number of unique clicks for links across a campaign. unique_subscriber_clicks: type: integer title: Unique Subscriber Clicks description: >- The total number of subscribers who clicked on a campaign. click_rate: type: number title: Click Rate description: >- The number of unique clicks divided by the total number of successful deliveries. last_click: type: string format: date-time title: Last Click description: >- The date and time of the last recorded click for the campaign in ISO 8601 format. facebook_likes: type: object title: Facebook Likes description: An object describing campaign engagement on Facebook. properties: recipient_likes: type: integer title: Recipient Likes description: >- The number of recipients who liked the campaign on Facebook. unique_likes: type: integer title: Unique Likes description: The number of unique likes. facebook_likes: type: integer title: Facebook Likes description: The number of Facebook likes for the campaign. industry_stats: type: object title: Industry Stats description: The average campaign statistics for your industry. properties: type: type: string title: Industry Type description: >- The type of business industry associated with your account. For example: retail, education, etc. open_rate: type: number title: Open Rate description: The industry open rate. click_rate: type: number title: Click Rate description: The industry click rate. bounce_rate: type: number title: Bounce Rate description: The industry bounce rate. unopen_rate: type: number title: Unopened Rate description: The industry unopened rate. unsub_rate: type: number title: Unsubscribe Rate description: The industry unsubscribe rate. abuse_rate: type: number title: Abuse Rate description: The industry abuse rate. list_stats: type: object title: List Stats description: >- The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list. properties: sub_rate: type: number title: Average Subscription Rate description: >- The average number of subscriptions per month for the list. readOnly: true unsub_rate: type: number title: Average Unsubscription Rate description: >- The average number of unsubscriptions per month for the list. readOnly: true open_rate: type: number title: Open Rate description: >- The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true click_rate: type: number title: Click Rate description: >- The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list. readOnly: true ab_split: type: object title: A/B Split Stats description: >- General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns. properties: a: type: object title: Campaign A description: Stats for Campaign A. properties: bounces: type: integer title: Bounces description: Bounces for Campaign A. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign A. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign A. recipient_clicks: type: integer title: Recipient Clicks description: Recipient Clicks for Campaign A. forwards: type: integer title: Forwards description: Forwards for Campaign A. forwards_opens: type: integer title: Forward Opens description: Opens from forwards for Campaign A. opens: type: integer title: Opens description: Opens for Campaign A. last_open: type: string title: Last Open description: The last open for Campaign A. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign A. b: type: object title: Campaign B description: Stats for Campaign B. properties: bounces: type: integer title: Bounces description: Bounces for Campaign B. abuse_reports: type: integer title: Abuse Reports description: Abuse reports for Campaign B. unsubs: type: integer title: Unsubscribes description: Unsubscribes for Campaign B. recipient_clicks: type: integer title: Recipient Clicks description: Recipients clicks for Campaign B. forwards: type: integer title: Forwards description: Forwards for Campaign B. forwards_opens: type: integer title: Forward Opens description: Opens for forwards from Campaign B. opens: type: integer title: Opens description: Opens for Campaign B. last_open: type: string title: Last Open description: The last open for Campaign B. unique_opens: type: integer title: Unique Opens description: Unique opens for Campaign B. timewarp: type: array title: Timewarp Stats description: >- An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp. items: type: object properties: gmt_offset: type: integer title: GMT Offset description: >- For campaigns sent with timewarp, the time zone group the member is apart of. opens: type: integer title: Opens description: The number of opens. last_open: type: string format: date-time title: Last Open description: >- The date and time of the last open in ISO 8601 format. unique_opens: type: integer title: Unique Opens description: The number of unique opens. clicks: type: integer title: Clicks description: The number of clicks. last_click: type: string format: date-time title: Last Click description: >- The date and time of the last click in ISO 8601 format. unique_clicks: type: integer title: Unique Clicks description: The number of unique clicks. bounces: type: integer title: Bounces description: The number of bounces. timeseries: type: array title: Timeseries description: >- An hourly breakdown of the performance of the campaign over the first 24 hours. items: type: object properties: timestamp: type: string format: date-time title: Timestamp description: >- The date and time for the series in ISO 8601 format. emails_sent: type: integer title: Emails Sent description: The number of emails sent in the timeseries. unique_opens: type: integer title: Unique Opens description: The number of unique opens in the timeseries. recipients_clicks: type: integer title: Recipient Clicks description: The number of clicks in the timeseries. share_report: type: object title: Share Report description: >- The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/). properties: share_url: type: string title: Report URL description: The URL for the VIP report. readOnly: true share_password: type: string title: Report Password description: >- If password protected, the password for the VIP report. readOnly: true ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true currency_code: type: string title: Three letter currency code for this user readOnly: true example: USD delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: >- The total number of emails canceled for this campaign. 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: Reports description: An array of objects, each representing a report resource. campaign_id: type: string title: Campaign ID description: Unique identifier of the parent campaign 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: - Reports x-custom-config: methodNameSnake: get_sub_reports_for_campaign methodNameCamel: getSubReportsForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/unsubscribed: get: summary: Mailchimp List Unsubscribed Members description: >- Get information about members who have unsubscribed from a specific campaign. operationId: getReportsIdUnsubscribed 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' responses: '200': description: '' schema: type: object title: Unsubscribes description: A list of members who have unsubscribed from a specific campaign. properties: unsubscribes: type: array items: type: object title: Unsubscribes description: A member who unsubscribed from a specific campaign. properties: email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true timestamp: type: string title: Timestamp description: >- The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true reason: type: string title: Unsubscribe Reason description: >- If available, the reason listed by the member for unsubscribing. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. 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: Lists description: >- An array of objects, each representing a member who unsubscribed from a campaign. campaign_id: type: string title: Campaign ID description: The campaign id. 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: - Reports - Unsubscribed x-custom-config: methodNameSnake: get_unsubscribed_list_for_campaign methodNameCamel: getUnsubscribedListForCampaign x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/unsubscribed/{subscriber_hash}: get: summary: Mailchimp Get Unsubscribed Member description: >- Get information about a specific list member who unsubscribed from a campaign. operationId: getReportsIdUnsubscribedId 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: >- The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Unsubscribes description: A member who unsubscribed from a specific campaign. properties: email_id: type: string title: Email Hash description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. readOnly: true timestamp: type: string title: Timestamp description: The date and time the member opted-out in ISO 8601 format. format: date-time readOnly: true reason: type: string title: Unsubscribe Reason description: >- If available, the reason listed by the member for unsubscribing. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true list_is_active: type: boolean title: List Status description: >- The status of the list used, namely if it's deleted or disabled. 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: - Reports - Unsubscribed x-custom-config: methodNameSnake: get_unsubscribed_list_member methodNameCamel: getUnsubscribedListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/ecommerce-product-activity: get: description: Get breakdown of product activity for a campaign 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - title - total_revenue - total_purchased example: example_value responses: '200': description: Ecommerce Product Activity Instance schema: type: object description: A collection of ecommerce products. properties: products: type: array items: type: object properties: title: type: string sku: type: string image_url: type: string total_revenue: type: number total_purchased: type: number currency_code: type: string recommendation_total: type: integer recommendation_purchased: type: integer 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: - Activity - Ecommerce - Product - Reports x-custom-config: methodNameSnake: get_ecommerce_product_activity_for_campaign methodNameCamel: getEcommerceProductActivityForCampaign summary: Mailchimp List Campaign Product Activity operationId: getReportsIdEcommerceProductActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates: get: summary: Mailchimp List Templates description: Get a list of an account's available templates. operationId: getTemplates 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: created_by x-title: Created By in: query description: The Mailchimp account user who created the template. required: false type: string example: example_value - name: since_date_created x-title: Since Date Created in: query description: >- Restrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: example_value - name: before_date_created x-title: Before Date Created in: query description: >- Restrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00. required: false type: string example: example_value - name: type x-title: Template Type in: query required: false description: Limit results based on template type. type: string example: example_value - name: category x-title: Category in: query description: Limit results based on category. required: false type: string example: example_value - name: folder_id x-title: Folder ID in: query description: The unique folder id. required: false type: string example: '500123' - name: sort_field x-title: Sort By Field description: Returns user templates sorted by the specified field. in: query required: false type: string enum: - date_created - date_edited - name example: example_value - name: content_type x-title: Content Type in: query required: false description: >- Limit results based on how the template's content is put together. Only templates of type `user` can be filtered by `content_type`. If you want to retrieve saved templates created with the legacy email editor, then filter `content_type` to `template`. If you'd rather pull your saved templates for the new editor, filter to `multichannel`. For code your own templates, filter to `html`. type: string enum: - html - template - multichannel example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: '' schema: type: object title: Templates description: A list an account's available templates. properties: templates: type: array items: type: object title: Template Instance description: Information about a specific template. properties: id: type: integer title: Template ID description: The individual id for the template. readOnly: true type: type: string title: Template Type description: The type of template (user, base, or gallery). readOnly: true name: type: string title: Template Name description: The name of the template. drag_and_drop: type: boolean title: Drag and Drop description: Whether the template uses the drag and drop editor. readOnly: true responsive: type: boolean title: Responsive description: >- Whether the template contains media queries to make it responsive. readOnly: true category: type: string title: Template Category description: If available, the category the template is listed in. readOnly: true date_created: type: string title: Date Created description: >- The date and time the template was created in ISO 8601 format. format: date-time readOnly: true date_edited: type: string title: Date Edited description: >- The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The login name for template's creator. readOnly: true edited_by: type: string title: Edited By description: The login name who last edited the template. readOnly: true active: type: boolean title: Active description: >- User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true folder_id: type: string title: Folder ID description: The id of the folder the template is currently in. thumbnail: type: string title: Template Thumbnail description: If available, the URL for a thumbnail of the template. readOnly: true share_url: type: string title: Share URL description: >- The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true content_type: type: string title: Content Type description: How the template's content is put together. enum: - template - multichannel - html 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: User Templates description: All of an account's saved or custom templates. 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: - Templates x-custom-config: methodNameSnake: list methodNameCamel: list x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Template description: >- Create a new template for the account. Only Classic templates are supported. operationId: postTemplates parameters: - in: body name: body description: '' required: true schema: type: object title: Template Instance description: Information about a specific template. required: - name - html properties: name: type: string title: Template Name description: The name of the template. example: Freddie's Jokes folder_id: type: string title: Folder ID description: The id of the folder the template is currently in. example: a4b830b html: type: string title: Template HTML description: >- The raw HTML for the template. We support the Mailchimp [Template Language](https://mailchimp.com/help/getting-started-with-mailchimps-template-language/) in any HTML code passed via the API. example: example_value responses: '200': description: '' schema: type: object title: Template Instance description: Information about a specific template. properties: id: type: integer title: Template ID description: The individual id for the template. readOnly: true type: type: string title: Template Type description: The type of template (user, base, or gallery). readOnly: true name: type: string title: Template Name description: The name of the template. drag_and_drop: type: boolean title: Drag and Drop description: Whether the template uses the drag and drop editor. readOnly: true responsive: type: boolean title: Responsive description: >- Whether the template contains media queries to make it responsive. readOnly: true category: type: string title: Template Category description: If available, the category the template is listed in. readOnly: true date_created: type: string title: Date Created description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true date_edited: type: string title: Date Edited description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The login name for template's creator. readOnly: true edited_by: type: string title: Edited By description: The login name who last edited the template. readOnly: true active: type: boolean title: Active description: >- User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true folder_id: type: string title: Folder ID description: The id of the folder the template is currently in. thumbnail: type: string title: Template Thumbnail description: If available, the URL for a thumbnail of the template. readOnly: true share_url: type: string title: Share URL description: >- The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true content_type: type: string title: Content Type description: How the template's content is put together. enum: - template - multichannel - html 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: - Templates x-custom-config: methodNameSnake: create methodNameCamel: create x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/{template_id}: get: summary: Mailchimp Get Template Info description: Get information about a specific template. operationId: getTemplatesId 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 example: example_value - 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 example: example_value - name: template_id x-title: Template ID in: path description: The unique id for the template. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Template Instance description: Information about a specific template. properties: id: type: integer title: Template ID description: The individual id for the template. readOnly: true type: type: string title: Template Type description: The type of template (user, base, or gallery). readOnly: true name: type: string title: Template Name description: The name of the template. drag_and_drop: type: boolean title: Drag and Drop description: Whether the template uses the drag and drop editor. readOnly: true responsive: type: boolean title: Responsive description: >- Whether the template contains media queries to make it responsive. readOnly: true category: type: string title: Template Category description: If available, the category the template is listed in. readOnly: true date_created: type: string title: Date Created description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true date_edited: type: string title: Date Edited description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The login name for template's creator. readOnly: true edited_by: type: string title: Edited By description: The login name who last edited the template. readOnly: true active: type: boolean title: Active description: >- User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true folder_id: type: string title: Folder ID description: The id of the folder the template is currently in. thumbnail: type: string title: Template Thumbnail description: If available, the URL for a thumbnail of the template. readOnly: true share_url: type: string title: Share URL description: >- The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true content_type: type: string title: Content Type description: How the template's content is put together. enum: - template - multichannel - html 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: - Templates x-custom-config: methodNameSnake: get_template methodNameCamel: getTemplate x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Template description: Update the name, HTML, or `folder_id` of an existing template. operationId: patchTemplatesId parameters: - name: template_id x-title: Template ID in: path description: The unique id for the template. required: true type: string example: '500123' - in: body name: body description: '' required: true schema: type: object title: Template Instance description: Information about a specific template. required: - name - html properties: name: type: string title: Template Name description: The name of the template. example: Freddie's Jokes folder_id: type: string title: Folder ID description: The id of the folder the template is currently in. example: a4b830b html: type: string title: Template HTML description: >- The raw HTML for the template. We support the Mailchimp [Template Language](https://mailchimp.com/help/getting-started-with-mailchimps-template-language/) in any HTML code passed via the API. example: example_value responses: '200': description: '' schema: type: object title: Template Instance description: Information about a specific template. properties: id: type: integer title: Template ID description: The individual id for the template. readOnly: true type: type: string title: Template Type description: The type of template (user, base, or gallery). readOnly: true name: type: string title: Template Name description: The name of the template. drag_and_drop: type: boolean title: Drag and Drop description: Whether the template uses the drag and drop editor. readOnly: true responsive: type: boolean title: Responsive description: >- Whether the template contains media queries to make it responsive. readOnly: true category: type: string title: Template Category description: If available, the category the template is listed in. readOnly: true date_created: type: string title: Date Created description: The date and time the template was created in ISO 8601 format. format: date-time readOnly: true date_edited: type: string title: Date Edited description: The date and time the template was edited in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Created By description: The login name for template's creator. readOnly: true edited_by: type: string title: Edited By description: The login name who last edited the template. readOnly: true active: type: boolean title: Active description: >- User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active. readOnly: true folder_id: type: string title: Folder ID description: The id of the folder the template is currently in. thumbnail: type: string title: Template Thumbnail description: If available, the URL for a thumbnail of the template. readOnly: true share_url: type: string title: Share URL description: >- The URL used for [template sharing](https://mailchimp.com/help/share-a-template/). readOnly: true content_type: type: string title: Content Type description: How the template's content is put together. enum: - template - multichannel - html 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: - Templates x-custom-config: methodNameSnake: update_template methodNameCamel: updateTemplate x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Template description: Delete a specific template. operationId: deleteTemplatesId parameters: - name: template_id x-title: Template ID in: path description: The unique id for the template. required: true type: string example: '500123' 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: - Templates x-custom-config: methodNameSnake: delete_template methodNameCamel: deleteTemplate x-microcks-operation: delay: 0 dispatcher: FALLBACK /templates/{template_id}/default-content: get: summary: Mailchimp View Default Content description: >- Get the sections that you can edit in a template, including each section's default content. operationId: getTemplatesIdDefaultContent 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 example: example_value - 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 example: example_value - name: template_id x-title: Template ID in: path description: The unique id for the template. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Template Default Content description: Default content for a template. properties: sections: type: object title: Sections description: >- The sections that you can edit in the template, including each section's default content. additionalProperties: description: >- The default content for the sections that you can edit in the template. _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: - Content - Templates x-custom-config: methodNameSnake: get_default_content_for_template methodNameCamel: getDefaultContentForTemplate x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/orders: get: summary: Mailchimp List Account Orders description: Get information about an account's orders. operationId: getEcommerceOrders 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: campaign_id x-title: Campaign ID in: query description: Restrict results to orders with a specific `campaign_id` value. required: false type: string example: '500123' - name: outreach_id x-title: Outreach ID in: query description: Restrict results to orders with a specific `outreach_id` value. required: false type: string example: '500123' - name: customer_id x-title: Customer ID in: query required: false description: Restrict results to orders made by a specific customer. type: string example: '500123' - name: has_outreach x-title: Has Outreach in: query required: false description: >- Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad. type: boolean example: example_value responses: '200': description: '' schema: type: object title: Orders description: A collection of orders in an account. properties: orders: type: array title: Orders description: An array of objects, each representing an order resource. items: type: object title: E-commerce Order description: Information about a specific order. properties: id: type: string title: Order Foreign ID description: A unique identifier for the order. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: >- The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 store_id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with an order. example: 839488a60b landing_site: type: string title: Landing Site description: >- The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc financial_status: type: string title: Financial Status description: >- The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). fulfillment_status: type: string title: Fulfillment Status description: >- The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the store accepts. order_total: type: number title: Order Total description: The order total associated with an order. order_url: type: string title: Order URL description: The URL for the order. discount_total: type: number title: Discount Total description: >- The total amount of the discounts to be applied to the price of the order. tax_total: type: number title: Tax Total description: The tax total associated with an order. shipping_total: type: number title: Shipping Total description: The shipping total for the order. tracking_code: type: string enum: - prec title: Tracking Code description: >- The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. processed_at_foreign: type: string title: Foreign Processed Time format: date-time description: >- The date and time the order was processed in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' cancelled_at_foreign: type: string title: Foreign Cancel Time format: date-time description: >- The date and time the order was cancelled in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' updated_at_foreign: type: string title: Foreign Update Time format: date-time description: >- The date and time the order was updated in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' shipping_address: type: object title: Shipping Address description: The shipping address for the order. properties: name: type: string title: Name description: >- The name associated with an order's shipping address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The shipping address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the shipping address. example: Suite 5000 city: type: string title: 'City ' description: The city in the order's shipping address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the order's shipping address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state the order's shipping address is located in. example: GA postal_code: type: string title: Postal Code description: >- The postal or zip code in the order's shipping address. example: '30308' country: type: string title: Country Code description: The country in the order's shipping address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the shipping address. example: US longitude: type: number title: Longitude description: The longitude for the shipping address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the shipping address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the order's shipping address example: '8675309' company: type: string title: Company description: >- The company associated with an order's shipping address. billing_address: type: object title: Billing Address description: The billing address for the order. properties: name: type: string title: Name description: The name associated with an order's billing address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The billing address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the billing address. example: Suite 5000 city: type: string title: 'City ' description: The city in the billing address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the billing address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state in the billing address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the billing address. example: '30308' country: type: string title: Country Code description: The country in the billing address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the billing address. example: US longitude: type: number title: Longitude description: The longitude for the billing address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the billing address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the billing address. example: '8675309' company: type: string title: Company description: The company associated with the billing address. promos: type: array title: Promos description: The promo codes applied on the order items: type: object properties: code: type: string title: Code description: The Promo Code amount_discounted: type: number title: Amount Discounted description: >- The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 type: type: string title: Type description: >- Type of discount. For free shipping set type to fixed enum: - fixed - percentage lines: type: array title: Order Line Items description: An array of the order's line items. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: >- The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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 outreach: type: object title: Outreach description: >- The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: type: string title: Outreach ID description: >- A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b name: type: string title: Outreach name description: The name for the outreach. example: Freddie's Jokes readOnly: true type: type: string title: Outreach type description: The type of the outreach. example: regular readOnly: true published_time: type: string format: date-time title: Outreach published time description: >- The date and time the Outreach was published in ISO 8601 format. example: '2017-06-06T13:56:12+00:00' readOnly: true tracking_number: type: string title: Tracking number description: The tracking number associated with the order. tracking_carrier: type: string title: Tracking carrier description: The tracking carrier associated with the order. tracking_url: type: string title: Tracking URL description: The tracking URL associated with the order. _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: - Orders x-custom-config: methodNameSnake: orders methodNameCamel: orders x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores: get: summary: Mailchimp List Stores description: Get information about all stores in the account. operationId: getEcommerceStores 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: '' schema: type: object title: E-commerce Stores description: A collection of stores in the account. properties: stores: type: array items: type: object title: E-commerce Store description: An individual store in an account. properties: id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true example: example_store list_id: type: string title: List ID description: >- The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. readOnly: true example: 1a2df69511 name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: >- The store domain. The store domain must be unique within a user account. example: example.com is_syncing: type: boolean title: Is Syncing description: >- Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: >- The currency format for the store. For example: `$`, ``, etc. example: $ primary_locale: type: string title: Primary Locale description: >- The primary locale for the store. For example: `en`, `de`, etc. example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 connected_site: type: object title: Connected Site description: The Connected Site associated with the store. readOnly: true properties: site_foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the connected site. readOnly: true example: >- a180c384d7db88b if created in-app, MC001 if created via API site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: >- The URL used for any integrations that offer built-in support for connected sites. readOnly: true example: >- https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: >- A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. readOnly: true example: >- automations: type: object title: Automations description: Details for the automations attached to this store. readOnly: true properties: abandoned_cart: type: object title: Abandoned Cart Automation description: abandonedCart automation details. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedCart automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedCart automation. enum: - save - sending - paused readOnly: true example: sending abandoned_browse: type: object title: Abandoned Browse Automation description: >- abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedBrowse automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedBrowse automation. enum: - save - sending - paused readOnly: true example: sending list_is_active: type: boolean title: List Status description: >- The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true created_at: type: string title: Creation Time format: date-time description: >- The date and time the store was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the store was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: Stores description: An array of objects, each representing a store. 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: - Stores x-custom-config: methodNameSnake: stores methodNameCamel: stores x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Store description: Add a new store to your Mailchimp account. operationId: postEcommerceStores parameters: - name: body in: body description: '' required: true schema: type: object title: E-commerce Store description: An individual store in an account. required: - id - list_id - name - currency_code properties: id: type: string title: Store Foreign ID description: The unique identifier for the store. example: example_store list_id: type: string title: List ID description: >- The unique identifier for the list associated with the store. The `list_id` for a specific store cannot change. example: 1a2df69511 name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: >- The store domain. This parameter is required for Connected Sites and Google Ads. example: example.com is_syncing: type: boolean title: Is Syncing description: >- Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: >- The primary locale for the store. For example: `en`, `de`, etc. example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 example: example_value responses: '200': description: '' schema: type: object title: E-commerce Store description: An individual store in an account. properties: id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true example: example_store list_id: type: string title: List ID description: >- The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. readOnly: true example: 1a2df69511 name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: >- The store domain. The store domain must be unique within a user account. example: example.com is_syncing: type: boolean title: Is Syncing description: >- Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: >- The primary locale for the store. For example: `en`, `de`, etc. example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 connected_site: type: object title: Connected Site description: The Connected Site associated with the store. readOnly: true properties: site_foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the connected site. readOnly: true example: >- a180c384d7db88b if created in-app, MC001 if created via API site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: >- The URL used for any integrations that offer built-in support for connected sites. readOnly: true example: >- https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: >- A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. readOnly: true example: >- automations: type: object title: Automations description: Details for the automations attached to this store. readOnly: true properties: abandoned_cart: type: object title: Abandoned Cart Automation description: abandonedCart automation details. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedCart automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedCart automation. enum: - save - sending - paused readOnly: true example: sending abandoned_browse: type: object title: Abandoned Browse Automation description: >- abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedBrowse automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedBrowse automation. enum: - save - sending - paused readOnly: true example: sending list_is_active: type: boolean title: List Status description: >- The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true created_at: type: string title: Creation Time format: date-time description: The date and time the store was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the store was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Stores x-custom-config: methodNameSnake: add_store methodNameCamel: addStore x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}: get: summary: Mailchimp Get Store Info description: Get information about a specific store. operationId: getEcommerceStoresId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Store description: An individual store in an account. properties: id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true example: example_store list_id: type: string title: List ID description: >- The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. readOnly: true example: 1a2df69511 name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: >- The store domain. The store domain must be unique within a user account. example: example.com is_syncing: type: boolean title: Is Syncing description: >- Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: >- The primary locale for the store. For example: `en`, `de`, etc. example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 connected_site: type: object title: Connected Site description: The Connected Site associated with the store. readOnly: true properties: site_foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the connected site. readOnly: true example: >- a180c384d7db88b if created in-app, MC001 if created via API site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: >- The URL used for any integrations that offer built-in support for connected sites. readOnly: true example: >- https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: >- A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. readOnly: true example: >- automations: type: object title: Automations description: Details for the automations attached to this store. readOnly: true properties: abandoned_cart: type: object title: Abandoned Cart Automation description: abandonedCart automation details. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedCart automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedCart automation. enum: - save - sending - paused readOnly: true example: sending abandoned_browse: type: object title: Abandoned Browse Automation description: >- abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedBrowse automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedBrowse automation. enum: - save - sending - paused readOnly: true example: sending list_is_active: type: boolean title: List Status description: >- The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true created_at: type: string title: Creation Time format: date-time description: The date and time the store was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the store was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Ecommerce - Stores x-custom-config: methodNameSnake: get_store methodNameCamel: getStore x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Store description: Update a store. operationId: patchEcommerceStoresId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Store description: An individual store in an account. properties: name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: The store domain. example: example.com is_syncing: type: boolean title: Is Syncing description: >- Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: >- The primary locale for the store. For example: `en`, `de`, etc. example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 example: example_value responses: '200': description: '' schema: type: object title: E-commerce Store description: An individual store in an account. properties: id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true example: example_store list_id: type: string title: List ID description: >- The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. readOnly: true example: 1a2df69511 name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: >- The store domain. The store domain must be unique within a user account. example: example.com is_syncing: type: boolean title: Is Syncing description: >- Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: >- The primary locale for the store. For example: `en`, `de`, etc. example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 connected_site: type: object title: Connected Site description: The Connected Site associated with the store. readOnly: true properties: site_foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the connected site. readOnly: true example: >- a180c384d7db88b if created in-app, MC001 if created via API site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: >- The URL used for any integrations that offer built-in support for connected sites. readOnly: true example: >- https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: >- A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. readOnly: true example: >- automations: type: object title: Automations description: Details for the automations attached to this store. readOnly: true properties: abandoned_cart: type: object title: Abandoned Cart Automation description: abandonedCart automation details. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedCart automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedCart automation. enum: - save - sending - paused readOnly: true example: sending abandoned_browse: type: object title: Abandoned Browse Automation description: >- abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. readOnly: true properties: is_supported: type: boolean title: Is Supported description: >- Whether this store supports the abandonedBrowse automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedBrowse automation. enum: - save - sending - paused readOnly: true example: sending list_is_active: type: boolean title: List Status description: >- The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true created_at: type: string title: Creation Time format: date-time description: The date and time the store was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the store was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Ecommerce - Stores x-custom-config: methodNameSnake: update_store methodNameCamel: updateStore x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Store description: >- Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts. operationId: deleteEcommerceStoresId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '204': description: Empty Response schema: 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: - Ecommerce - Stores x-custom-config: methodNameSnake: delete_store methodNameCamel: deleteStore x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/carts: get: summary: Mailchimp List Carts description: Get information about a store's carts. operationId: getEcommerceStoresIdCarts 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Carts description: A collection of a store's carts. properties: store_id: type: string title: Store ID description: The store id. carts: type: array title: E-commerce Store Carts description: An array of objects, each representing a cart. items: type: object title: E-commerce Cart description: Information about a specific cart. properties: id: type: string title: Cart Foreign ID description: A unique identifier for the cart. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: >- The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: >- The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: >- The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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 created_at: type: string title: Creation Time format: date-time description: >- The date and time the cart was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the cart was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Carts - Stores x-custom-config: methodNameSnake: get_store_carts methodNameCamel: getStoreCarts x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Cart description: Add a new cart to a store. operationId: postEcommerceStoresIdCarts parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Cart description: Information about a specific cart. required: - id - currency_code - customer - order_total - lines properties: id: type: string title: Cart Foreign ID description: A unique identifier for the cart. customer: type: object title: E-commerce Customer description: >- Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body. required: - id properties: id: type: string title: Customer Foreign ID description: >- A unique identifier for the customer. Limited to 50 characters. maxLength: 50 email_address: type: string title: Email Address description: The customer's email address. opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US campaign_id: type: string title: Campaign ID description: A string that uniquely identifies the campaign for a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: >- The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. required: - id - product_id - product_variant_id - quantity - price properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Cart description: Information about a specific cart. properties: id: type: string title: Cart Foreign ID description: A unique identifier for the cart. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: >- The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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 created_at: type: string title: Creation Time format: date-time description: The date and time the cart was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the cart was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Carts - Stores x-custom-config: methodNameSnake: add_store_cart methodNameCamel: addStoreCart x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/carts/{cart_id}: get: summary: Mailchimp Get Cart Info description: Get information about a specific cart. operationId: getEcommerceStoresIdCartsId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Cart description: Information about a specific cart. properties: id: type: string title: Cart Foreign ID description: A unique identifier for the cart. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: >- The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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 created_at: type: string title: Creation Time format: date-time description: The date and time the cart was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the cart was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Carts - Ecommerce - Stores x-custom-config: methodNameSnake: get_store_cart methodNameCamel: getStoreCart x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Cart description: Update a specific cart. operationId: patchEcommerceStoresIdCartsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Cart description: Information about a specific cart. properties: customer: type: object title: E-commerce Customer description: >- Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: >- The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Cart description: Information about a specific cart. properties: id: type: string title: Cart Foreign ID description: A unique identifier for the cart. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: >- The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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 created_at: type: string title: Creation Time format: date-time description: The date and time the cart was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the cart was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Carts - Ecommerce - Stores x-custom-config: methodNameSnake: update_store_cart methodNameCamel: updateStoreCart x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Cart description: Delete a cart. operationId: deleteEcommerceStoresIdCartsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' 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: - Carts - Ecommerce - Stores x-custom-config: methodNameSnake: delete_store_cart methodNameCamel: deleteStoreCart x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/carts/{cart_id}/lines: get: summary: Mailchimp List Cart Line Items description: Get information about a cart's line items. operationId: getEcommerceStoresIdCartsIdLines 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Cart Lines description: A collection of a cart's line items. properties: store_id: type: string title: Store ID description: The store id. cart_id: type: string title: Cart ID description: The cart id. lines: type: array title: Ecommerce Cart Lines description: An array of objects, each representing a cart's line item. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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: - Carts - Lines - Stores x-custom-config: methodNameSnake: get_all_cart_line_items methodNameCamel: getAllCartLineItems x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Cart Line Item description: Add a new line item to an existing cart. operationId: postEcommerceStoresIdCartsIdLines parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. required: - id - product_id - product_variant_id - quantity - price properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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: - Carts - Lines - Stores x-custom-config: methodNameSnake: add_cart_line_item methodNameCamel: addCartLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}: get: summary: Mailchimp Get Cart Line Item description: Get information about a specific cart line item. operationId: getEcommerceStoresIdCartsIdLinesId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: line_id x-title: Cart Line ID description: The id for the line item of a cart. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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: - Carts - Ecommerce - Lines - Stores x-custom-config: methodNameSnake: get_cart_line_item methodNameCamel: getCartLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Cart Line Item description: Update a specific cart line item. operationId: patchEcommerceStoresIdCartsIdLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: line_id x-title: Cart Line ID description: The id for the line item of a cart. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: >- A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _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: - Carts - Ecommerce - Lines - Stores x-custom-config: methodNameSnake: update_cart_line_item methodNameCamel: updateCartLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Cart Line Item description: Delete a specific cart line item. operationId: deleteEcommerceStoresIdCartsLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: line_id x-title: Cart Line ID description: The id for the line item of a cart. in: path required: true type: string example: '500123' 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: - Carts - Ecommerce - Lines - Stores x-custom-config: methodNameSnake: delete_cart_line_item methodNameCamel: deleteCartLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/customers: get: summary: Mailchimp List Customers description: Get information about a store's customers. operationId: getEcommerceStoresIdCustomers 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: email_address x-title: Customer Email Address in: query description: Restrict the response to customers with the email address. type: string required: false example: user@example.com responses: '200': description: '' schema: type: object title: Customers description: A collection of the store's customers. properties: store_id: type: string title: Store ID description: The store id. customers: type: array title: Customers description: An array of objects, each representing a customer of a store. items: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Customers - Stores x-custom-config: methodNameSnake: get_all_store_customers methodNameCamel: getAllStoreCustomers x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Customer description: Add a new customer to a store. operationId: postEcommerceStoresIdCustomers parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Customer description: Information about a specific customer. required: - id - email_address - opt_in_status properties: id: type: string title: Customer Foreign ID description: >- A unique identifier for the customer. Limited to 50 characters. maxLength: 50 email_address: type: string title: Email Address description: The customer's email address. opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US example: example_value responses: '200': description: '' schema: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Customers - Stores x-custom-config: methodNameSnake: add_store_customer methodNameCamel: addStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/customers/{customer_id}: get: summary: Mailchimp Get Customer Info description: Get information about a specific customer. operationId: getEcommerceStoresIdCustomersId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Customers - Ecommerce - Stores x-custom-config: methodNameSnake: get_store_customer methodNameCamel: getStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Add or Update Customer description: Add or update a customer. operationId: putEcommerceStoresIdCustomersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Customer description: >- Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. required: - id - email_address - opt_in_status properties: id: type: string title: Customer Foreign ID description: >- A unique identifier for the customer. Limited to 50 characters. maxLength: 50 email_address: type: string title: Email Address description: The customer's email address. opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US example: example_value responses: '200': description: '' schema: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Customers - Ecommerce - Stores x-custom-config: methodNameSnake: set_store_customer methodNameCamel: setStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Customer description: Update a customer. operationId: patchEcommerceStoresIdCustomersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Customer description: >- Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US example: example_value responses: '200': description: '' schema: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Customers - Ecommerce - Stores x-custom-config: methodNameSnake: update_store_customer methodNameCamel: updateStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Customer description: Delete a customer from a store. operationId: deleteEcommerceStoresIdCustomersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' 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: - Customers - Ecommerce - Stores x-custom-config: methodNameSnake: delete_store_customer methodNameCamel: deleteStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/promo-rules: get: summary: Mailchimp List Promo Rules description: Get information about a store's promo rules. operationId: getEcommerceStoresIdPromorules 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Promo Rules description: A collection of the store's promo rules. properties: store_id: type: string title: Store ID description: The store id. promo_rules: type: array title: Promo Rules description: >- An array of objects, each representing promo rules defined for a store. items: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule properties: id: type: string title: Promo Rule Foreign ID description: >- A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50. readOnly: true title: type: string title: Title description: >- The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: >- The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: >- The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: >- The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: >- The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Promo - Rules - Stores x-custom-config: methodNameSnake: list_promo_rules methodNameCamel: listPromoRules x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Promo Rule description: Add a new promo rule to a store. operationId: postEcommerceStoresIdPromorules parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule. required: - id - description - amount - type - target properties: id: type: string title: Promo Rule Foreign ID description: >- A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50. title: type: string title: Title description: >- The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: >- The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: >- The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: >- The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: >- The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule properties: id: type: string title: Promo Rule Foreign ID description: >- A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50. readOnly: true title: type: string title: Title description: >- The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: >- The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: >- The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: >- The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: >- The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Promo - Rules - Stores x-custom-config: methodNameSnake: add_promo_rules methodNameCamel: addPromoRules x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}: get: summary: Mailchimp Get Promo Rule description: Get information about a specific promo rule. operationId: getEcommerceStoresIdPromorulesId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule properties: id: type: string title: Promo Rule Foreign ID description: >- A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50. readOnly: true title: type: string title: Title description: >- The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: >- The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: >- The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: >- The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: >- The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Ecommerce - Promo - Rules - Stores x-custom-config: methodNameSnake: get_promo_rule methodNameCamel: getPromoRule x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Promo Rule description: Update a promo rule. operationId: patchEcommerceStoresIdPromorulesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule. properties: title: type: string title: Title description: >- The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: >- The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: >- The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: >- The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: >- The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule properties: id: type: string title: Promo Rule Foreign ID description: >- A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50. readOnly: true title: type: string title: Title description: >- The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: >- The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: >- The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: >- The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: >- The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Ecommerce - Promo - Rules - Stores x-custom-config: methodNameSnake: update_promo_rule methodNameCamel: updatePromoRule x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Promo Rule description: Delete a promo rule from a store. operationId: deleteEcommerceStoresIdPromorulesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' 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: - Ecommerce - Promo - Rules - Stores x-custom-config: methodNameSnake: delete_promo_rule methodNameCamel: deletePromoRule x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes: get: summary: Mailchimp List Promo Codes description: Get information about a store's promo codes. operationId: getEcommerceStoresIdPromocodes 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Promo Codes description: A collection of the store's promo codes. properties: store_id: type: string title: Store ID description: The store id. promo_codes: type: array title: Promo Codes description: >- An array of objects, each representing promo codes defined for a store. items: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code properties: id: type: string title: Promo Code Foreign ID description: A unique identifier for the promo Code. readOnly: true code: type: string title: Promo Code description: >- The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: >- The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: >- A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Ecommerce - Promo - Rules - Stores x-custom-config: methodNameSnake: get_promo_codes methodNameCamel: getPromoCodes x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Promo Code description: Add a new promo code to a store. operationId: postEcommerceStoresIdPromocodes parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code. required: - id - code - redemption_url properties: id: type: string title: Promo Code Foreign ID description: >- A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50. code: type: string title: Promo Code description: >- The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: >- The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: >- A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code properties: id: type: string title: Promo Code Foreign ID description: A unique identifier for the promo Code. readOnly: true code: type: string title: Promo Code description: >- The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: >- The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: >- A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Ecommerce - Promo - Rules - Stores x-custom-config: methodNameSnake: add_promo_code methodNameCamel: addPromoCode x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}: get: summary: Mailchimp Get Promo Code description: Get information about a specific promo code. operationId: getEcommerceStoresIdPromocodesId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: promo_code_id x-title: Promo Code ID description: The id for the promo code of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code properties: id: type: string title: Promo Code Foreign ID description: A unique identifier for the promo Code. readOnly: true code: type: string title: Promo Code description: >- The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: >- The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: >- A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Promo - Promo_code_id - Rules - Stores x-custom-config: methodNameSnake: get_promo_code methodNameCamel: getPromoCode x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Promo Code description: Update a promo code. operationId: patchEcommerceStoresIdPromocodesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: promo_code_id x-title: Promo Code ID description: The id for the promo code of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code. properties: code: type: string title: Promo Code description: >- The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: >- The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: >- A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code properties: id: type: string title: Promo Code Foreign ID description: A unique identifier for the promo Code. readOnly: true code: type: string title: Promo Code description: >- The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: >- The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: >- A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: >- The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: >- The date and time the promotion was updated in ISO 8601 format. _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: - Promo - Promo_code_id - Rules - Stores x-custom-config: methodNameSnake: update_promo_code methodNameCamel: updatePromoCode x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Promo Code description: Delete a promo code from a store. operationId: deleteEcommerceStoresIdPromocodesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: promo_code_id x-title: Promo Code ID description: The id for the promo code of a store. in: path required: true type: string example: '500123' 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: - Promo - Promo_code_id - Rules - Stores x-custom-config: methodNameSnake: delete_promo_code methodNameCamel: deletePromoCode x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/orders: get: summary: Mailchimp List Orders description: Get information about a store's orders. operationId: getEcommerceStoresIdOrders 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID in: query required: false description: Restrict results to orders made by a specific customer. type: string example: '500123' - name: has_outreach x-title: Has Outreach in: query required: false description: >- Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad. type: boolean example: example_value - name: campaign_id x-title: Campaign ID in: query description: Restrict results to orders with a specific `campaign_id` value. required: false type: string example: '500123' - name: outreach_id x-title: Outreach ID in: query description: Restrict results to orders with a specific `outreach_id` value. required: false type: string example: '500123' responses: '200': description: '' schema: type: object title: Orders description: A collection of orders in a store. properties: store_id: type: string title: Store ID description: The unique identifier for the store. orders: type: array title: Orders description: An array of objects, each representing an order in a store. items: type: object title: E-commerce Order description: Information about a specific order. properties: id: type: string title: Order Foreign ID description: A unique identifier for the order. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: >- The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 store_id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with an order. example: 839488a60b landing_site: type: string title: Landing Site description: >- The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc financial_status: type: string title: Financial Status description: >- The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). fulfillment_status: type: string title: Fulfillment Status description: >- The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the store accepts. order_total: type: number title: Order Total description: The order total associated with an order. order_url: type: string title: Order URL description: The URL for the order. discount_total: type: number title: Discount Total description: >- The total amount of the discounts to be applied to the price of the order. tax_total: type: number title: Tax Total description: The tax total associated with an order. shipping_total: type: number title: Shipping Total description: The shipping total for the order. tracking_code: type: string enum: - prec title: Tracking Code description: >- The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. processed_at_foreign: type: string title: Foreign Processed Time format: date-time description: >- The date and time the order was processed in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' cancelled_at_foreign: type: string title: Foreign Cancel Time format: date-time description: >- The date and time the order was cancelled in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' updated_at_foreign: type: string title: Foreign Update Time format: date-time description: >- The date and time the order was updated in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' shipping_address: type: object title: Shipping Address description: The shipping address for the order. properties: name: type: string title: Name description: >- The name associated with an order's shipping address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The shipping address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the shipping address. example: Suite 5000 city: type: string title: 'City ' description: The city in the order's shipping address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the order's shipping address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state the order's shipping address is located in. example: GA postal_code: type: string title: Postal Code description: >- The postal or zip code in the order's shipping address. example: '30308' country: type: string title: Country Code description: The country in the order's shipping address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the shipping address. example: US longitude: type: number title: Longitude description: The longitude for the shipping address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the shipping address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the order's shipping address example: '8675309' company: type: string title: Company description: >- The company associated with an order's shipping address. billing_address: type: object title: Billing Address description: The billing address for the order. properties: name: type: string title: Name description: The name associated with an order's billing address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The billing address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the billing address. example: Suite 5000 city: type: string title: 'City ' description: The city in the billing address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the billing address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state in the billing address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the billing address. example: '30308' country: type: string title: Country Code description: The country in the billing address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the billing address. example: US longitude: type: number title: Longitude description: The longitude for the billing address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the billing address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the billing address. example: '8675309' company: type: string title: Company description: The company associated with the billing address. promos: type: array title: Promos description: The promo codes applied on the order items: type: object properties: code: type: string title: Code description: The Promo Code amount_discounted: type: number title: Amount Discounted description: >- The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 type: type: string title: Type description: >- Type of discount. For free shipping set type to fixed enum: - fixed - percentage lines: type: array title: Order Line Items description: An array of the order's line items. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: >- The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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 outreach: type: object title: Outreach description: >- The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: type: string title: Outreach ID description: >- A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b name: type: string title: Outreach name description: The name for the outreach. example: Freddie's Jokes readOnly: true type: type: string title: Outreach type description: The type of the outreach. example: regular readOnly: true published_time: type: string format: date-time title: Outreach published time description: >- The date and time the Outreach was published in ISO 8601 format. example: '2017-06-06T13:56:12+00:00' readOnly: true tracking_number: type: string title: Tracking number description: The tracking number associated with the order. tracking_carrier: type: string title: Tracking carrier description: The tracking carrier associated with the order. tracking_url: type: string title: Tracking URL description: The tracking URL associated with the order. _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: - Orders - Stores x-custom-config: methodNameSnake: get_store_orders methodNameCamel: getStoreOrders x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Order description: Add a new order to a store. operationId: postEcommerceStoresIdOrders parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Order description: Information about a specific order. required: - id - customer - currency_code - order_total - lines properties: id: type: string title: Order Foreign ID description: A unique identifier for the order. customer: type: object title: E-commerce Customer description: >- Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body. required: - id properties: id: type: string title: Customer Foreign ID description: >- A unique identifier for the customer. Limited to 50 characters. maxLength: 50 email_address: type: string title: Email Address description: The customer's email address. opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US campaign_id: type: string title: Campaign ID description: A string that uniquely identifies the campaign for an order. example: 839488a60b landing_site: type: string title: Landing Site description: >- The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc financial_status: type: string title: Financial Status description: >- The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). fulfillment_status: type: string title: Fulfillment Status description: >- The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the store accepts. order_total: type: number title: Order Total description: The total for the order. order_url: type: string title: Order URL description: The URL for the order. discount_total: type: number title: Discount Total description: >- The total amount of the discounts to be applied to the price of the order. tax_total: type: number title: Tax Total description: The tax total for the order. shipping_total: type: number title: Shipping Total description: The shipping total for the order. tracking_code: type: string enum: - prec title: Tracking Code description: >- The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. processed_at_foreign: type: string title: Foreign Processed Time format: date-time description: The date and time the order was processed in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' cancelled_at_foreign: type: string title: Foreign Cancel Time format: date-time description: >- The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created. example: '2015-07-15T19:28:00+00:00' updated_at_foreign: type: string title: Foreign Update Time format: date-time description: The date and time the order was updated in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' shipping_address: type: object title: Shipping Address description: The shipping address for the order. properties: name: type: string title: Name description: The name associated with an order's shipping address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The shipping address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the shipping address. example: Suite 5000 city: type: string title: 'City ' description: The city in the order's shipping address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the order's shipping address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state in the shipping address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the shipping address. example: '30308' country: type: string title: Country Code description: The country in the shipping address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the shipping address. example: US longitude: type: number title: Longitude description: The longitude for the shipping address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the shipping address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the order's shipping address. example: '8675309' company: type: string title: Company description: The company associated with the shipping address. billing_address: type: object title: Billing Address description: The billing address for the order. properties: name: type: string title: Name description: The name associated with the billing address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The billing address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the billing address. example: Suite 5000 city: type: string title: 'City ' description: The city in the billing address. example: Atlanta province: type: string title: Province description: The state or normalized province in the billing address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province in the billing address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the billing address. example: '30308' country: type: string title: Country Code description: The country in the billing address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the billing address. example: US longitude: type: number title: Longitude description: The longitude for the billing address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the billing address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the billing address example: '8675309' company: type: string title: Company description: The company associated with the billing address. promos: type: array title: Promos description: The promo codes applied on the order items: type: object required: - code - type - amount_discounted properties: code: type: string title: Code description: The Promo Code amount_discounted: type: number title: Amount Discounted description: >- The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 type: type: string title: Type description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage lines: type: array title: Order Line Items description: An array of the order's line items. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. required: - id - product_id - product_variant_id - quantity - price properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for the order line item. product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with the order line item. product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the order line item. quantity: type: integer title: Quantity description: The quantity of an order line item. price: type: number title: Price description: The price of an order line item. discount: type: number title: Discount description: The total discount amount applied to this line item. outreach: type: object title: Outreach description: >- The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: type: string title: Outreach ID description: >- A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b tracking_number: type: string title: Tracking number description: The tracking number associated with the order. tracking_carrier: type: string title: Tracking carrier description: The tracking carrier associated with the order. tracking_url: type: string title: Tracking URL description: The tracking URL associated with the order. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Order description: Information about a specific order. properties: id: type: string title: Order Foreign ID description: A unique identifier for the order. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 store_id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with an order. example: 839488a60b landing_site: type: string title: Landing Site description: >- The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc financial_status: type: string title: Financial Status description: >- The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). fulfillment_status: type: string title: Fulfillment Status description: >- The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the store accepts. order_total: type: number title: Order Total description: The order total associated with an order. order_url: type: string title: Order URL description: The URL for the order. discount_total: type: number title: Discount Total description: >- The total amount of the discounts to be applied to the price of the order. tax_total: type: number title: Tax Total description: The tax total associated with an order. shipping_total: type: number title: Shipping Total description: The shipping total for the order. tracking_code: type: string enum: - prec title: Tracking Code description: >- The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. processed_at_foreign: type: string title: Foreign Processed Time format: date-time description: The date and time the order was processed in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' cancelled_at_foreign: type: string title: Foreign Cancel Time format: date-time description: The date and time the order was cancelled in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' updated_at_foreign: type: string title: Foreign Update Time format: date-time description: The date and time the order was updated in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' shipping_address: type: object title: Shipping Address description: The shipping address for the order. properties: name: type: string title: Name description: The name associated with an order's shipping address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The shipping address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the shipping address. example: Suite 5000 city: type: string title: 'City ' description: The city in the order's shipping address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the order's shipping address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state the order's shipping address is located in. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the order's shipping address. example: '30308' country: type: string title: Country Code description: The country in the order's shipping address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the shipping address. example: US longitude: type: number title: Longitude description: The longitude for the shipping address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the shipping address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the order's shipping address example: '8675309' company: type: string title: Company description: The company associated with an order's shipping address. billing_address: type: object title: Billing Address description: The billing address for the order. properties: name: type: string title: Name description: The name associated with an order's billing address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The billing address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the billing address. example: Suite 5000 city: type: string title: 'City ' description: The city in the billing address. example: Atlanta province: type: string title: Province description: The state or normalized province in the billing address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state in the billing address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the billing address. example: '30308' country: type: string title: Country Code description: The country in the billing address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the billing address. example: US longitude: type: number title: Longitude description: The longitude for the billing address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the billing address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the billing address. example: '8675309' company: type: string title: Company description: The company associated with the billing address. promos: type: array title: Promos description: The promo codes applied on the order items: type: object properties: code: type: string title: Code description: The Promo Code amount_discounted: type: number title: Amount Discounted description: >- The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 type: type: string title: Type description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage lines: type: array title: Order Line Items description: An array of the order's line items. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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 outreach: type: object title: Outreach description: >- The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: type: string title: Outreach ID description: >- A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b name: type: string title: Outreach name description: The name for the outreach. example: Freddie's Jokes readOnly: true type: type: string title: Outreach type description: The type of the outreach. example: regular readOnly: true published_time: type: string format: date-time title: Outreach published time description: >- The date and time the Outreach was published in ISO 8601 format. example: '2017-06-06T13:56:12+00:00' readOnly: true tracking_number: type: string title: Tracking number description: The tracking number associated with the order. tracking_carrier: type: string title: Tracking carrier description: The tracking carrier associated with the order. tracking_url: type: string title: Tracking URL description: The tracking URL associated with the order. _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: - Orders - Stores x-custom-config: methodNameSnake: add_store_order methodNameCamel: addStoreOrder x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/orders/{order_id}: get: summary: Mailchimp Get Order Info description: Get information about a specific order. operationId: getEcommerceStoresIdOrdersId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Order description: Information about a specific order. properties: id: type: string title: Order Foreign ID description: A unique identifier for the order. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 store_id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with an order. example: 839488a60b landing_site: type: string title: Landing Site description: >- The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc financial_status: type: string title: Financial Status description: >- The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). fulfillment_status: type: string title: Fulfillment Status description: >- The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the store accepts. order_total: type: number title: Order Total description: The order total associated with an order. order_url: type: string title: Order URL description: The URL for the order. discount_total: type: number title: Discount Total description: >- The total amount of the discounts to be applied to the price of the order. tax_total: type: number title: Tax Total description: The tax total associated with an order. shipping_total: type: number title: Shipping Total description: The shipping total for the order. tracking_code: type: string enum: - prec title: Tracking Code description: >- The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. processed_at_foreign: type: string title: Foreign Processed Time format: date-time description: The date and time the order was processed in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' cancelled_at_foreign: type: string title: Foreign Cancel Time format: date-time description: The date and time the order was cancelled in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' updated_at_foreign: type: string title: Foreign Update Time format: date-time description: The date and time the order was updated in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' shipping_address: type: object title: Shipping Address description: The shipping address for the order. properties: name: type: string title: Name description: The name associated with an order's shipping address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The shipping address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the shipping address. example: Suite 5000 city: type: string title: 'City ' description: The city in the order's shipping address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the order's shipping address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state the order's shipping address is located in. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the order's shipping address. example: '30308' country: type: string title: Country Code description: The country in the order's shipping address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the shipping address. example: US longitude: type: number title: Longitude description: The longitude for the shipping address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the shipping address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the order's shipping address example: '8675309' company: type: string title: Company description: The company associated with an order's shipping address. billing_address: type: object title: Billing Address description: The billing address for the order. properties: name: type: string title: Name description: The name associated with an order's billing address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The billing address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the billing address. example: Suite 5000 city: type: string title: 'City ' description: The city in the billing address. example: Atlanta province: type: string title: Province description: The state or normalized province in the billing address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state in the billing address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the billing address. example: '30308' country: type: string title: Country Code description: The country in the billing address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the billing address. example: US longitude: type: number title: Longitude description: The longitude for the billing address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the billing address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the billing address. example: '8675309' company: type: string title: Company description: The company associated with the billing address. promos: type: array title: Promos description: The promo codes applied on the order items: type: object properties: code: type: string title: Code description: The Promo Code amount_discounted: type: number title: Amount Discounted description: >- The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 type: type: string title: Type description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage lines: type: array title: Order Line Items description: An array of the order's line items. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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 outreach: type: object title: Outreach description: >- The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: type: string title: Outreach ID description: >- A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b name: type: string title: Outreach name description: The name for the outreach. example: Freddie's Jokes readOnly: true type: type: string title: Outreach type description: The type of the outreach. example: regular readOnly: true published_time: type: string format: date-time title: Outreach published time description: >- The date and time the Outreach was published in ISO 8601 format. example: '2017-06-06T13:56:12+00:00' readOnly: true tracking_number: type: string title: Tracking number description: The tracking number associated with the order. tracking_carrier: type: string title: Tracking carrier description: The tracking carrier associated with the order. tracking_url: type: string title: Tracking URL description: The tracking URL associated with the order. _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: - Orders - Stores x-custom-config: methodNameSnake: get_order methodNameCamel: getOrder x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Order description: Update a specific order. operationId: patchEcommerceStoresIdOrdersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Order description: Information about a specific order. properties: customer: type: object title: E-commerce Customer description: >- Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with an order. example: 839488a60b landing_site: type: string title: Landing Site description: >- The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc financial_status: type: string title: Financial Status description: >- The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). fulfillment_status: type: string title: Fulfillment Status description: >- The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the store accepts. order_total: type: number title: Order Total description: The order total associated with an order. order_url: type: string title: Order URL description: The URL for the order. discount_total: type: number title: Discount Total description: >- The total amount of the discounts to be applied to the price of the order. tax_total: type: number title: Tax Total description: The tax total associated with an order. shipping_total: type: number title: Shipping Total description: The shipping total for the order. tracking_code: type: string enum: - prec title: Tracking Code description: >- The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. processed_at_foreign: type: string title: Foreign Processed Time format: date-time description: The date and time the order was processed in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' cancelled_at_foreign: type: string title: Foreign Cancel Time format: date-time description: >- The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being edited. example: '2015-07-15T19:28:00+00:00' updated_at_foreign: type: string title: Foreign Update Time format: date-time description: The date and time the order was updated in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' shipping_address: type: object title: Shipping Address description: The shipping address for the order. properties: name: type: string title: Name description: The name associated with an order's shipping address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The shipping address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the shipping address. example: Suite 5000 city: type: string title: 'City ' description: The city in the order's shipping address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the order's shipping address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state the order's shipping address is located in. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the order's shipping address. example: '30308' country: type: string title: Country Code description: The country in the order's shipping address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the shipping address. example: US longitude: type: number title: Longitude description: The longitude for the shipping address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the shipping address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the order's shipping address example: '8675309' company: type: string title: Company description: The company associated with an order's shipping address. billing_address: type: object title: Billing Address description: The billing address for the order. properties: name: type: string title: Name description: The name associated with an order's billing address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The billing address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the billing address. example: Suite 5000 city: type: string title: 'City ' description: The city in the billing address. example: Atlanta province: type: string title: Province description: The state or normalized province in the billing address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state in the billing address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the billing address. example: '30308' country: type: string title: Country Code description: The country in the billing address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the billing address. example: US longitude: type: number title: Longitude description: The longitude for the billing address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the billing address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the billing address. example: '8675309' company: type: string title: Company description: The company associated with the billing address. promos: type: array title: Promos description: >- The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided. items: type: object required: - code - type - amount_discounted properties: code: type: string title: Code description: The Promo Code amount_discounted: type: number title: Amount Discounted description: >- The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 type: type: string title: Type description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage lines: type: array title: Order Line Items description: An array of the order's line items. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with the order line item. product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the order line item. quantity: type: integer title: Quantity description: The quantity of an order line item. price: type: number title: Price description: The price of an order line item. discount: type: number title: Discount description: The total discount amount applied to this line item. outreach: type: object title: Outreach description: >- The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: type: string title: Outreach ID description: >- A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b tracking_number: type: string title: Tracking number description: The tracking number associated with the order. tracking_carrier: type: string title: Tracking carrier description: The tracking carrier associated with the order. tracking_url: type: string title: Tracking URL description: The tracking URL associated with the order. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Order description: Information about a specific order. properties: id: type: string title: Order Foreign ID description: A unique identifier for the order. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: >- The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: >- An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: >- The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 store_id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true campaign_id: type: string title: Campaign ID description: >- A string that uniquely identifies the campaign associated with an order. example: 839488a60b landing_site: type: string title: Landing Site description: >- The URL for the page where the buyer landed when entering the shop. example: http://www.example.com?source=abc financial_status: type: string title: Financial Status description: >- The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). fulfillment_status: type: string title: Fulfillment Status description: >- The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications). currency_code: type: string title: Currency Code description: >- The three-letter ISO 4217 code for the currency that the store accepts. order_total: type: number title: Order Total description: The order total associated with an order. order_url: type: string title: Order URL description: The URL for the order. discount_total: type: number title: Discount Total description: >- The total amount of the discounts to be applied to the price of the order. tax_total: type: number title: Tax Total description: The tax total associated with an order. shipping_total: type: number title: Shipping Total description: The shipping total for the order. tracking_code: type: string enum: - prec title: Tracking Code description: >- The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs. processed_at_foreign: type: string title: Foreign Processed Time format: date-time description: The date and time the order was processed in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' cancelled_at_foreign: type: string title: Foreign Cancel Time format: date-time description: The date and time the order was cancelled in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' updated_at_foreign: type: string title: Foreign Update Time format: date-time description: The date and time the order was updated in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' shipping_address: type: object title: Shipping Address description: The shipping address for the order. properties: name: type: string title: Name description: The name associated with an order's shipping address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The shipping address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the shipping address. example: Suite 5000 city: type: string title: 'City ' description: The city in the order's shipping address. example: Atlanta province: type: string title: Province description: >- The state or normalized province in the order's shipping address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state the order's shipping address is located in. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the order's shipping address. example: '30308' country: type: string title: Country Code description: The country in the order's shipping address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the shipping address. example: US longitude: type: number title: Longitude description: The longitude for the shipping address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the shipping address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the order's shipping address example: '8675309' company: type: string title: Company description: The company associated with an order's shipping address. billing_address: type: object title: Billing Address description: The billing address for the order. properties: name: type: string title: Name description: The name associated with an order's billing address. example: Freddie Chimpenheimer address1: type: string title: Address Field 1 description: The billing address for the order. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the billing address. example: Suite 5000 city: type: string title: 'City ' description: The city in the billing address. example: Atlanta province: type: string title: Province description: The state or normalized province in the billing address. example: Georgia province_code: type: string title: Province Code description: >- The two-letter code for the province or state in the billing address. example: GA postal_code: type: string title: Postal Code description: The postal or zip code in the billing address. example: '30308' country: type: string title: Country Code description: The country in the billing address. example: United States country_code: type: string title: Country Code description: >- The two-letter code for the country in the billing address. example: US longitude: type: number title: Longitude description: The longitude for the billing address location. example: -75.68903 latitude: type: number title: Latitude description: The latitude for the billing address location. example: 45.427408 phone: type: string title: Phone Number description: The phone number for the billing address. example: '8675309' company: type: string title: Company description: The company associated with the billing address. promos: type: array title: Promos description: The promo codes applied on the order items: type: object properties: code: type: string title: Code description: The Promo Code amount_discounted: type: number title: Amount Discounted description: >- The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0 type: type: string title: Type description: Type of discount. For free shipping set type to fixed enum: - fixed - percentage lines: type: array title: Order Line Items description: An array of the order's line items. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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 outreach: type: object title: Outreach description: >- The outreach associated with this order. For example, an email campaign or Facebook ad. properties: id: type: string title: Outreach ID description: >- A unique identifier for the outreach. Can be an email campaign ID. example: 839488a60b name: type: string title: Outreach name description: The name for the outreach. example: Freddie's Jokes readOnly: true type: type: string title: Outreach type description: The type of the outreach. example: regular readOnly: true published_time: type: string format: date-time title: Outreach published time description: >- The date and time the Outreach was published in ISO 8601 format. example: '2017-06-06T13:56:12+00:00' readOnly: true tracking_number: type: string title: Tracking number description: The tracking number associated with the order. tracking_carrier: type: string title: Tracking carrier description: The tracking carrier associated with the order. tracking_url: type: string title: Tracking URL description: The tracking URL associated with the order. _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: - Orders - Stores x-custom-config: methodNameSnake: update_order methodNameCamel: updateOrder x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Order description: Delete an order. operationId: deleteEcommerceStoresIdOrdersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' 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: - Orders - Stores x-custom-config: methodNameSnake: delete_order methodNameCamel: deleteOrder x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/orders/{order_id}/lines: get: summary: Mailchimp List Order Line Items description: Get information about an order's line items. operationId: getEcommerceStoresIdOrdersIdLines 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Order Lines description: A collection of an order's line items. properties: store_id: type: string title: Store ID description: The store id. order_id: type: string title: Order ID description: The order id. lines: type: array title: Ecommerce Order Lines description: An array of objects, each representing an order's line item. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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: - Lines - Orders - Stores x-custom-config: methodNameSnake: get_all_order_line_items methodNameCamel: getAllOrderLineItems x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Order Line Item description: Add a new line item to an existing order. operationId: postEcommerceStoresIdOrdersIdLines parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. required: - id - product_id - product_variant_id - quantity - price properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for the order line item. product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with the order line item. product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the order line item. quantity: type: integer title: Quantity description: The quantity of an order line item. price: type: number title: Price description: The price of an order line item. discount: type: number title: Discount description: The total discount amount applied to this line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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: - Lines - Orders - Stores x-custom-config: methodNameSnake: add_order_line_item methodNameCamel: addOrderLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}: get: summary: Mailchimp Get Order Line Item description: Get information about a specific order line item. operationId: getEcommerceStoresIdOrdersIdLinesId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: line_id x-title: Order Line ID description: The id for the line item of an order. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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: - Ecommerce - Lines - Orders - Stores x-custom-config: methodNameSnake: get_order_line_item methodNameCamel: getOrderLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Order Line Item description: Update a specific order line item. operationId: patchEcommerceStoresIdOrdersIdLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: line_id x-title: Order Line ID description: The id for the line item of an order. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with the order line item. product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with the order line item. quantity: type: integer title: Quantity description: The quantity of an order line item. price: type: number title: Price description: The price of an order line item. discount: type: number title: Discount description: The total discount amount applied to this line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: >- A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: >- A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _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: - Ecommerce - Lines - Orders - Stores x-custom-config: methodNameSnake: update_order_line_item methodNameCamel: updateOrderLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Order Line Item description: Delete a specific order line item. operationId: deleteEcommerceStoresIdOrdersIdLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: line_id x-title: Order Line ID description: The id for the line item of an order. in: path required: true type: string example: '500123' 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: - Ecommerce - Lines - Orders - Stores x-custom-config: methodNameSnake: delete_order_line_item methodNameCamel: deleteOrderLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products: get: summary: Mailchimp List Product description: Get information about a store's products. operationId: getEcommerceStoresIdProducts 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Products description: A collection of a store's products. properties: store_id: type: string title: Store ID description: The store id. products: type: array title: Products description: An array of objects, each representing a store product. items: type: object title: E-commerce Product description: Information about a specific product. properties: id: type: string title: Product Foreign ID description: A unique identifier for the product. readOnly: true currency_code: type: string title: Currency Code description: The currency code readOnly: true title: type: string title: Title description: The title of a product. example: Cat Hat handle: type: string title: Handle description: The handle of a product. example: cat-hat url: type: string title: Product URL description: The URL for a product. description: type: string title: Description description: The description of a product. example: This is a cat hat. type: type: string title: Type description: The type of product. example: Accessories vendor: type: string title: Vendor description: The vendor for a product. image_url: type: string title: Product Image URL description: The image URL for a product. variants: type: array title: Product Variants description: >- Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: >- The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 images: type: array title: Product Images description: An array of the product's images. items: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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 published_at_foreign: type: string title: Foreign Publish Time format: date-time description: >- The date and time the product was published in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' _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: - Products - Stores x-custom-config: methodNameSnake: get_all_store_products methodNameCamel: getAllStoreProducts x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Product description: Add a new product to a store. operationId: postEcommerceStoresIdProducts parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product description: Information about a specific product. required: - id - title - variants properties: id: type: string title: Product Foreign ID description: A unique identifier for the product. title: type: string title: Title description: The title of a product. example: Cat Hat handle: type: string title: Handle description: The handle of a product. example: cat-hat url: type: string title: Product URL description: The URL for a product. description: type: string title: Description description: The description of a product. example: This is a cat hat. type: type: string title: Type description: The type of product. example: Accessories vendor: type: string title: Vendor description: The vendor for a product. image_url: type: string title: Product Image URL description: The image URL for a product. variants: type: array title: Product Variants description: >- An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product. items: type: object title: E-commerce Product Variant description: Information about a specific product variant. required: - id - title properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. images: type: array title: Product Images description: An array of the product's images. items: type: object title: E-commerce Product Image description: Information about a specific product image. required: - id - url properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. items: type: string published_at_foreign: type: string title: Foreign Publish Time format: date-time description: The date and time the product was published. example: '2015-07-15T19:28:00+00:00' example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product description: Information about a specific product. properties: id: type: string title: Product Foreign ID description: A unique identifier for the product. readOnly: true currency_code: type: string title: Currency Code description: The currency code readOnly: true title: type: string title: Title description: The title of a product. example: Cat Hat handle: type: string title: Handle description: The handle of a product. example: cat-hat url: type: string title: Product URL description: The URL for a product. description: type: string title: Description description: The description of a product. example: This is a cat hat. type: type: string title: Type description: The type of product. example: Accessories vendor: type: string title: Vendor description: The vendor for a product. image_url: type: string title: Product Image URL description: The image URL for a product. variants: type: array title: Product Variants description: >- Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: >- The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 images: type: array title: Product Images description: An array of the product's images. items: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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 published_at_foreign: type: string title: Foreign Publish Time format: date-time description: >- The date and time the product was published in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' _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: - Products - Stores x-custom-config: methodNameSnake: add_store_product methodNameCamel: addStoreProduct x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products/{product_id}: get: summary: Mailchimp Get Product Info description: Get information about a specific product. operationId: getEcommerceStoresIdProductsId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Product description: Information about a specific product. properties: id: type: string title: Product Foreign ID description: A unique identifier for the product. readOnly: true currency_code: type: string title: Currency Code description: The currency code readOnly: true title: type: string title: Title description: The title of a product. example: Cat Hat handle: type: string title: Handle description: The handle of a product. example: cat-hat url: type: string title: Product URL description: The URL for a product. description: type: string title: Description description: The description of a product. example: This is a cat hat. type: type: string title: Type description: The type of product. example: Accessories vendor: type: string title: Vendor description: The vendor for a product. image_url: type: string title: Product Image URL description: The image URL for a product. variants: type: array title: Product Variants description: >- Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: >- The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 images: type: array title: Product Images description: An array of the product's images. items: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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 published_at_foreign: type: string title: Foreign Publish Time format: date-time description: >- The date and time the product was published in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' _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: - Products - Stores x-custom-config: methodNameSnake: get_store_product methodNameCamel: getStoreProduct x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Product description: Update a specific product. operationId: patchEcommerceStoresIdProductsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product description: Information about a specific product. properties: title: type: string title: Title description: The title of a product. example: Cat Hat handle: type: string title: Handle description: The handle of a product. example: cat-hat url: type: string title: Product URL description: The URL for a product. description: type: string title: Description description: The description of a product. example: This is a cat hat. type: type: string title: Type description: The type of product. example: Accessories vendor: type: string title: Vendor description: The vendor for a product. image_url: type: string title: Product Image URL description: The image URL for a product. variants: type: array title: Product Variants description: >- An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product. items: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. images: type: array title: Product Images description: An array of the product's images. items: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. items: type: string published_at_foreign: type: string title: Foreign Publish Time format: date-time description: >- The date and time the product was published in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product description: Information about a specific product. properties: id: type: string title: Product Foreign ID description: A unique identifier for the product. readOnly: true currency_code: type: string title: Currency Code description: The currency code readOnly: true title: type: string title: Title description: The title of a product. example: Cat Hat handle: type: string title: Handle description: The handle of a product. example: cat-hat url: type: string title: Product URL description: The URL for a product. description: type: string title: Description description: The description of a product. example: This is a cat hat. type: type: string title: Type description: The type of product. example: Accessories vendor: type: string title: Vendor description: The vendor for a product. image_url: type: string title: Product Image URL description: The image URL for a product. variants: type: array title: Product Variants description: >- Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/). items: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: >- The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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 images: type: array title: Product Images description: An array of the product's images. items: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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 published_at_foreign: type: string title: Foreign Publish Time format: date-time description: >- The date and time the product was published in ISO 8601 format. example: '2015-07-15T19:28:00+00:00' _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: - Products - Stores x-custom-config: methodNameSnake: update_store_product methodNameCamel: updateStoreProduct x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Product description: Delete a product. operationId: deleteEcommerceStoresIdProductsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' 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: - Products - Stores x-custom-config: methodNameSnake: delete_store_product methodNameCamel: deleteStoreProduct x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products/{product_id}/variants: get: summary: Mailchimp List Product Variants description: Get information about a product's variants. operationId: getEcommerceStoresIdProductsIdVariants 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Ecommerce Product Variants description: A collection of a product's variants. properties: store_id: type: string title: Store ID description: The store id. product_id: type: string title: Product ID description: The product id. variants: type: array title: Ecommerce Product Variants description: An array of objects, each representing a product's variants. items: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: >- The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Products - Stores - Variants x-custom-config: methodNameSnake: get_product_variants methodNameCamel: getProductVariants x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Product Variant description: Add a new variant to the product. operationId: postEcommerceStoresIdProductsIdVariants parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. required: - id - title properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Products - Stores - Variants x-custom-config: methodNameSnake: add_product_variants methodNameCamel: addProductVariants x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}: get: summary: Mailchimp Get Product Variant Info description: Get information about a specific product variant. operationId: getEcommerceStoresIdProductsIdVariantsId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Ecommerce - Products - Stores - Variants x-custom-config: methodNameSnake: get_product_variant methodNameCamel: getProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Add or Update Product Variant description: Add or update a product variant. operationId: putEcommerceStoresIdProductsIdVariantsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. required: - id - title properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Ecommerce - Products - Stores - Variants x-custom-config: methodNameSnake: add_product_variant methodNameCamel: addProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Product Variant description: Update a product variant. operationId: patchEcommerceStoresIdProductsIdVariantsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: >- The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _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: - Ecommerce - Products - Stores - Variants x-custom-config: methodNameSnake: update_product_variant methodNameCamel: updateProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Product Variant description: Delete a product variant. operationId: deleteEcommerceStoresIdProductsIdVariantsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' 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: - Ecommerce - Products - Stores - Variants x-custom-config: methodNameSnake: delete_product_variant methodNameCamel: deleteProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products/{product_id}/images: get: summary: Mailchimp List Product Images description: Get information about a product's images. operationId: getEcommerceStoresIdProductsIdImages 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Ecommerce Product Images description: A collection of a product's images. properties: store_id: type: string title: Store ID description: The store id. product_id: type: string title: Product ID description: The product id. images: type: array title: Ecommerce Product Images description: >- An array of objects, each representing a product image resource. items: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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: - Images - Products - Stores x-custom-config: methodNameSnake: get_product_images methodNameCamel: getProductImages x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Product Image description: Add a new image to the product. operationId: postEcommerceStoresIdProductsIdImages parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Image description: Information about a specific product image. required: - id - url properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. items: type: string example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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: - Images - Products - Stores x-custom-config: methodNameSnake: add_product_image methodNameCamel: addProductImage x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}: get: summary: Mailchimp Get Product Image Info description: Get information about a specific product image. operationId: getEcommerceStoresIdProductsIdImagesId 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 example: example_value - 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 example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: image_id x-title: Product Image ID description: The id for the product image. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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: - Ecommerce - Images - Products - Stores x-custom-config: methodNameSnake: get_product_image methodNameCamel: getProductImage x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Product Image description: Update a product image. operationId: patchEcommerceStoresIdProductsIdImagesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: image_id x-title: Product Image ID description: The id for the product image. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. items: type: string example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. 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: - Ecommerce - Images - Products - Stores x-custom-config: methodNameSnake: update_product_image methodNameCamel: updateProductImage x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Product Image description: Delete a product image. operationId: deleteEcommerceStoresIdProductsIdImagesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: image_id x-title: Product Image ID description: The id for the product image. in: path required: true type: string example: '500123' 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: - Ecommerce - Images - Products - Stores x-custom-config: methodNameSnake: delete_product_image methodNameCamel: deleteProductImage x-microcks-operation: delay: 0 dispatcher: FALLBACK /search-campaigns: get: summary: Mailchimp Search Campaigns description: Search all campaigns for the specified query terms. operationId: getSearchCampaigns 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 example: example_value - 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 example: example_value - name: query x-title: Query in: query description: The search query used to filter results. required: true type: string example: example_value responses: '200': description: '' schema: type: object title: Campaigns description: Campaigns and Snippets found for given search term. properties: results: type: array title: Results description: An array of matching campaigns and snippets. items: type: object properties: campaign: type: object title: Campaign description: >- A summary of an individual campaign's settings and content. properties: id: type: string title: Campaign ID description: A string that uniquely identifies this campaign. readOnly: true web_id: type: integer title: Campaign Web ID description: >- The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. readOnly: true parent_campaign_id: type: string title: Parent Campaign ID description: >- If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children. readOnly: true type: type: string title: Campaign Type description: >- There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. enum: - regular - plaintext - absplit - rss - variate create_time: type: string format: date-time title: Create Time description: >- The date and time the campaign was created 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 long_archive_url: type: string title: Long Archive URL description: The original link to the campaign's archive version. readOnly: true status: type: string title: Campaign Status description: The current status of the campaign. enum: - save - paused - schedule - sending - sent - canceled - canceling - archived 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 format: date-time title: Send Time description: The date and time a campaign was sent. readOnly: true content_type: type: string title: Content Type description: How the campaign's content is put together. enum: - template - html - url - multichannel needs_block_refresh: type: boolean title: Needs Block Refresh description: >- Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false. readOnly: true resendable: type: boolean title: Resendable description: >- Determines if the campaign qualifies to be resent to non-openers. readOnly: 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/create-and-send-to-a-segment/) 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: >- Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: >- Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: >- Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: >- Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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: >- The settings for your campaign, including subject, from name, reply-to address, and more. 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. use_conversation: type: boolean title: Conversation description: >- Use Mailchimp Conversation feature to manage out-of-office replies. to_name: type: string title: To Name description: >- The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/). folder_id: type: string title: Folder ID description: >- If the campaign is listed in a folder, the id for that folder. 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`. timewarp: type: boolean title: Timewarp Send description: >- Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/). readOnly: true template_id: type: integer title: Template ID description: The id for the template used in this campaign. readOnly: false drag_and_drop: type: boolean title: Drag And Drop Campaign description: >- Whether the campaign uses the drag-and-drop editor. readOnly: true variate_settings: type: object title: A/B Test Options description: The settings specific to A/B test campaigns. properties: winning_combination_id: type: string title: Winning Combination ID description: ID for the winning combination. readOnly: true winning_campaign_id: type: string title: Winning Campaign ID description: >- ID of the campaign that was sent to the remaining recipients based on the winning combination. readOnly: true winner_criteria: type: string title: Winning Criteria description: >- The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application. enum: - opens - clicks - manual - total_revenue wait_time: type: integer title: Wait Time description: >- The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes. test_size: type: integer title: Test Size description: >- The percentage of recipients to send the test combinations to, must be a value between 10 and 100. subject_lines: type: array title: Subject Lines description: >- The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used. items: type: string send_times: type: array title: Send Times description: >- The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored. items: type: string format: date-time from_names: type: array title: From Names description: >- The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used. items: type: string reply_to_addresses: type: array title: Reply To Addresses description: >- The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used. items: type: string contents: type: array title: Content Descriptions description: >- Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'. items: type: string readOnly: true combinations: type: array title: Combinations description: >- Combinations of possible variables used to build emails. readOnly: true items: type: object properties: id: type: string title: ID description: Unique ID for the combination. subject_line: type: integer title: Subject Line description: >- The index of `variate_settings.subject_lines` used. send_time: type: integer title: Send Time description: >- The index of `variate_settings.send_times` used. from_name: type: integer title: From Name description: >- The index of `variate_settings.from_names` used. reply_to: type: integer title: Reply To description: >- The index of `variate_settings.reply_to_addresses` used. content_description: type: integer title: Content Description description: >- The index of `variate_settings.contents` used. recipients: type: integer title: Recipients description: >- The number of recipients for this combination. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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`. Cannot be set to false for variate campaigns. 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 subscriber email addresses. 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 subscriber email addresses. rss_opts: type: object title: RSS Options description: >- [RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign. properties: feed_url: type: string title: Feed URL format: uri description: The URL for the RSS feed. frequency: type: string title: Frequency description: The frequency of the RSS Campaign. enum: - daily - weekly - monthly schedule: type: object title: Sending Schedule description: The schedule for sending the RSS Campaign. properties: hour: type: integer minimum: 0 maximum: 23 title: Sending Hour description: >- The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/). daily_send: type: object title: Daily Sending Days description: >- The days of the week to send a daily RSS Campaign. properties: sunday: type: boolean title: Sunday description: Sends the daily RSS Campaign on Sundays. monday: type: boolean title: Monday description: Sends the daily RSS Campaign on Mondays. tuesday: type: boolean title: tuesday description: >- Sends the daily RSS Campaign on Tuesdays. wednesday: type: boolean title: Monday description: >- Sends the daily RSS Campaign on Wednesdays. thursday: type: boolean title: Thursday description: >- Sends the daily RSS Campaign on Thursdays. friday: type: boolean title: Friday description: Sends the daily RSS Campaign on Fridays. saturday: type: boolean title: Saturday description: >- Sends the daily RSS Campaign on Saturdays. weekly_send_day: type: string enum: - sunday - monday - tuesday - wednesday - thursday - friday - saturday title: Weekly Sending Day description: >- The day of the week to send a weekly RSS Campaign. monthly_send_date: type: number minimum: 0 maximum: 31 title: Monthly Sending Day description: >- The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February. last_sent: type: string format: date-time title: Last Sent description: The date the campaign was last sent. readOnly: true constrain_rss_img: type: boolean title: Constrain RSS Images description: >- Whether to add CSS to images in the RSS feed to constrain their width in campaigns. ab_split_opts: type: object title: A/B Testing Options description: >- [A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign. readOnly: true properties: split_test: type: string title: Split Test description: The type of AB split to run. enum: - subject - from_name - schedule pick_winner: type: string title: Pick Winner description: >- How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'. enum: - opens - clicks - manual wait_units: type: string title: Wait Time description: >- How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent. enum: - hours - days wait_time: type: integer title: Wait Time description: >- The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent. split_size: type: integer minimum: 1 maximum: 50 title: Split Size description: >- The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50. from_name_a: type: string title: From Name Group A description: >- For campaigns split on 'From Name', the name for Group A. from_name_b: type: string title: From Name Group B description: >- For campaigns split on 'From Name', the name for Group B. reply_email_a: type: string title: Reply Email Group A description: >- For campaigns split on 'From Name', the reply-to address for Group A. reply_email_b: type: string title: Reply Email Group B description: >- For campaigns split on 'From Name', the reply-to address for Group B. subject_a: type: string title: Subject Line Group A description: >- For campaigns split on 'Subject Line', the subject line for Group A. subject_b: type: string title: Subject Line Group B description: >- For campaigns split on 'Subject Line', the subject line for Group B. send_time_a: type: string format: date-time title: Send Time Group A description: The send time for Group A. send_time_b: type: string format: date-time title: Send Time Group B description: The send time for Group B. send_time_winner: type: string title: Send Time Winner description: The send time for the winning version. 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. report_summary: type: object title: Campaign Report Summary description: >- For sent campaigns, a summary of opens, clicks, and e-commerce data. 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 ecommerce: type: object title: E-Commerce Report description: E-Commerce stats for a campaign. properties: total_orders: type: integer title: Total Orders description: The total orders for a campaign. readOnly: true total_spent: type: number title: Total Spent description: >- The total spent for a campaign. Calculated as the sum of all order totals with no deductions. readOnly: true total_revenue: type: number title: Total Revenue description: >- The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals. readOnly: true delivery_status: type: object title: Campaign Delivery Status description: Updates on campaigns in the process of sending. properties: enabled: type: boolean title: Delivery Status Enabled description: >- Whether Campaign Delivery Status is enabled for this account and campaign. readOnly: true can_cancel: type: boolean title: Campaign Cancelable description: Whether a campaign send can be canceled. readOnly: true status: type: string title: Campaign Delivery Status description: The current state of a campaign delivery. enum: - delivering - delivered - canceling - canceled readOnly: true emails_sent: type: integer title: Emails Sent description: >- The total number of emails confirmed sent for this campaign so far. readOnly: true emails_canceled: type: integer title: Emails Canceled description: >- The total number of emails canceled for this campaign. readOnly: true resend_shortcut_eligibility: type: object title: Resend Shortcut Eligibility description: >- Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`. properties: to_non_openers: type: object title: To Non-Openers description: >- Determines if the campaign qualifies to be resent to non-openers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_new_subscribers: type: object title: To New Subscribers description: >- Determines if the campaign qualifies to be resent to new subscribers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. readOnly: true to_non_clickers: type: object title: To Non-Clickers description: >- Determines if the campaign qualifies to be resent to non-clickers. properties: is_eligible: type: boolean title: Is Eligible description: >- Determines if the campaign qualifies to be resent to this segment. readOnly: true reason: type: string title: Reason description: >- The reason the campaign is not eligible to be resent to this segment. 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 snippet: type: string title: Matching snippet 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: - Campaigns - Search x-custom-config: methodNameSnake: search methodNameCamel: search x-microcks-operation: delay: 0 dispatcher: FALLBACK /search-members: get: summary: Mailchimp Search Members description: >- Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. operationId: getSearchMembers 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 example: example_value - 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 example: example_value - name: query x-title: Query in: query description: >- The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. required: true type: string example: example_value - name: list_id x-title: List ID in: query description: The unique id for the list. required: false type: string example: '500123' responses: '200': description: '' schema: type: object title: Members description: Members found for given search term properties: exact_matches: type: object description: Exact matches of the provided search query. title: Exact Matches properties: members: type: array items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: >- An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: >- The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: >- Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: >- The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: >- Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: >- The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: >- The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: >- The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: >- The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: >- Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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: Members description: >- An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: >- The total number of items matching the query regardless of pagination. readOnly: true full_search: type: object description: Partial matches of the provided search query. title: Partial Matches properties: members: type: array items: type: object title: List Members description: >- Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: >- An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: >- As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: >- The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: >- Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: >- Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: >- The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: >- A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: >- This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: >- The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: >- Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: >- Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: >- The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: >- The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: >- The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: >- The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: >- The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: >- The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: >- The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: >- If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: >- [VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber. email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: >- The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: >- A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: >- The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: >- If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: >- The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: >- The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: >- Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. 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: Members description: >- An array of objects, each representing a specific list member. 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: - Members - Search x-custom-config: methodNameSnake: search methodNameCamel: search x-microcks-operation: delay: 0 dispatcher: FALLBACK /ping: get: summary: Mailchimp Ping description: >- A health check for the API that won't return any account-specific information. operationId: getPing responses: '200': description: '' schema: type: object title: API health status description: API health status. properties: health_status: type: string title: API health status description: >- This will return a constant string value if the request is successful. Ex. "Everything's Chimpy!" readOnly: true example: '"Everything''s Chimpy!"' 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: - Pings x-custom-config: methodNameSnake: get methodNameCamel: get x-microcks-operation: delay: 0 dispatcher: FALLBACK /facebook-ads: get: description: Get list of Facebook ads. 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - created_at - updated_at - end_time example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: List of Facebook Ad Instances schema: type: object description: Contains an array of facebook ads. properties: facebook_ads: type: array items: allOf: - type: object properties: id: type: string title: ID description: Unique ID of an Outreach. web_id: type: integer title: Web ID description: >- The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. name: type: string title: Name description: Title or name of an Outreach. type: type: string title: Outreach Type description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey - sms status: type: string title: Outreach Status description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished show_report: type: boolean title: Show Report description: >- Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context. create_time: type: string title: Create Time format: date-time description: >- The date and time the outreach was created in ISO 8601 format. start_time: type: string title: Start Time format: date-time description: >- The date and time the outreach was started in ISO 8601 format. updated_at: type: string title: Updated At format: date-time description: >- The date and time the outreach was last updated in ISO 8601 format. canceled_at: type: string title: Canceled At format: date-time description: >- The date and time the outreach was canceled in ISO 8601 format. published_time: type: string title: Publish Time format: date-time description: >- The date and time the outreach was (or will be) published in ISO 8601 format. has_segment: type: boolean title: Has Segment description: If this outreach targets a segment of your audience. report_summary: type: object title: Report Summary description: High level reporting stats for an outreach. properties: opens: type: integer unique_opens: type: integer open_rate: type: number clicks: type: integer subscriber_clicks: type: integer click_rate: type: number visits: type: integer unique_visits: type: integer conversion_rate: type: number subscribes: type: integer ecommerce: type: object properties: total_revenue: type: number currency_code: type: string average_order_revenue: type: number impressions: type: number reach: type: integer engagements: type: integer total_sent: type: integer recipients: type: object title: Recipients description: >- High level audience information for who the outreach targets. 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/save-and-manage-segments/) 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: >- Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: >- Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: >- Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: >- Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. thumbnail: type: string title: Thumbnail description: The URL of the thumbnail for this outreach. - type: object properties: email_source_name: type: string title: 'Ad: Email Source Name' paused_at: type: string title: 'Ad: Paused At' format: date-time description: >- The date and time the ad was paused in ISO 8601 format. end_time: type: string title: 'Ad: End Time' format: date-time description: >- The date and time the ad was ended in ISO 8601 format. needs_attention: type: boolean title: 'Ad: Needs Attention' description: If the ad has a problem and needs attention. was_canceled_by_facebook: type: boolean title: 'Ad: Was Canceled By Facebook' - type: object description: A facebook ad. properties: is_connected: type: boolean description: Check if this ad is connected to a facebook page has_audience: type: boolean description: Check if this ad has audience setup has_content: type: boolean description: Check if this ad has content channel: type: object description: Channel settings properties: fb_placement_feed: type: boolean description: Is this for facebook feed example: true fb_placement_audience: type: boolean description: Is this for facebook audience example: false ig_placement_feed: type: boolean description: Is this for instagram feed example: false feedback: type: object description: Check if this ad is connected to a facebook page properties: content: type: string description: Feedback regarding the content of this Ad. audience: type: string description: Feedback regarding the audience of this Ad. budget: type: string description: Feedback regarding the budget of this Ad. compliance: type: string description: Feedback regarding the compliance of this Ad. site: type: object description: Connected Site properties: id: type: integer description: The ID of this connected site. example: 43 name: type: string description: The name of the connected site example: My Connected Site url: type: string description: The URL for this connected site. example: www.example.com audience: type: object description: Audience settings properties: type: type: string description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience source_type: type: string description: List or Facebook based audience enum: - facebook - list email_source: type: object properties: name: type: string description: Email source name type: type: string description: Type of the email source is_segment: type: boolean description: Is the source reference a segment segment_type: type: string description: >- Segment type if this source is tied to a segment list_name: type: string description: Associated list name to the source include_source_in_target: type: boolean description: To include list contacts as part of audience lookalike_country_code: type: string description: To find similar audience in given country targeting_specs: type: object properties: gender: type: integer enum: - 0 - 1 - 2 min_age: type: integer max_age: type: integer locations: type: object properties: countries: type: array items: type: string regions: type: array items: type: string cities: type: array items: type: string zips: type: array items: type: string interests: type: array items: type: object properties: name: type: string budget: type: object properties: duration: type: integer description: Duration of the ad in seconds example: 86400 total_amount: type: number description: Total budget of the ad example: 500 currency_code: type: string description: Currency code example: USD content: type: object properties: title: type: string link_url: type: string message: type: string description: type: string image_url: type: string call_to_action: type: string attachments: type: array items: type: object properties: name: type: string link_url: type: string description: type: string image_url: type: string call_to_action: type: string - type: object properties: _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 tags: - Facebook - Facebook Ads x-custom-config: methodNameSnake: list methodNameCamel: list summary: Mailchimp List Facebook Ads operationId: getAllFacebookAds x-microcks-operation: delay: 0 dispatcher: FALLBACK /facebook-ads/{outreach_id}: get: description: Get details of a Facebook ad. 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 example: example_value - in: path name: outreach_id x-title: Outreach ID type: string required: true description: The outreach id. example: '500123' - 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 example: example_value responses: '200': description: Facebook Ad Instance schema: allOf: - type: object properties: id: type: string title: ID description: Unique ID of an Outreach. web_id: type: integer title: Web ID description: >- The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. name: type: string title: Name description: Title or name of an Outreach. type: type: string title: Outreach Type description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey - sms status: type: string title: Outreach Status description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished show_report: type: boolean title: Show Report description: >- Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context. create_time: type: string title: Create Time format: date-time description: >- The date and time the outreach was created in ISO 8601 format. start_time: type: string title: Start Time format: date-time description: >- The date and time the outreach was started in ISO 8601 format. updated_at: type: string title: Updated At format: date-time description: >- The date and time the outreach was last updated in ISO 8601 format. canceled_at: type: string title: Canceled At format: date-time description: >- The date and time the outreach was canceled in ISO 8601 format. published_time: type: string title: Publish Time format: date-time description: >- The date and time the outreach was (or will be) published in ISO 8601 format. has_segment: type: boolean title: Has Segment description: If this outreach targets a segment of your audience. report_summary: type: object title: Report Summary description: High level reporting stats for an outreach. properties: opens: type: integer unique_opens: type: integer open_rate: type: number clicks: type: integer subscriber_clicks: type: integer click_rate: type: number visits: type: integer unique_visits: type: integer conversion_rate: type: number subscribes: type: integer ecommerce: type: object properties: total_revenue: type: number currency_code: type: string average_order_revenue: type: number impressions: type: number reach: type: integer engagements: type: integer total_sent: type: integer recipients: type: object title: Recipients description: >- High level audience information for who the outreach targets. 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/save-and-manage-segments/) 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. thumbnail: type: string title: Thumbnail description: The URL of the thumbnail for this outreach. - type: object properties: email_source_name: type: string title: 'Ad: Email Source Name' paused_at: type: string title: 'Ad: Paused At' format: date-time description: The date and time the ad was paused in ISO 8601 format. end_time: type: string title: 'Ad: End Time' format: date-time description: The date and time the ad was ended in ISO 8601 format. needs_attention: type: boolean title: 'Ad: Needs Attention' description: If the ad has a problem and needs attention. was_canceled_by_facebook: type: boolean title: 'Ad: Was Canceled By Facebook' - type: object description: A facebook ad. properties: is_connected: type: boolean description: Check if this ad is connected to a facebook page has_audience: type: boolean description: Check if this ad has audience setup has_content: type: boolean description: Check if this ad has content channel: type: object description: Channel settings properties: fb_placement_feed: type: boolean description: Is this for facebook feed example: true fb_placement_audience: type: boolean description: Is this for facebook audience example: false ig_placement_feed: type: boolean description: Is this for instagram feed example: false feedback: type: object description: Check if this ad is connected to a facebook page properties: content: type: string description: Feedback regarding the content of this Ad. audience: type: string description: Feedback regarding the audience of this Ad. budget: type: string description: Feedback regarding the budget of this Ad. compliance: type: string description: Feedback regarding the compliance of this Ad. site: type: object description: Connected Site properties: id: type: integer description: The ID of this connected site. example: 43 name: type: string description: The name of the connected site example: My Connected Site url: type: string description: The URL for this connected site. example: www.example.com audience: type: object description: Audience settings properties: type: type: string description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience source_type: type: string description: List or Facebook based audience enum: - facebook - list email_source: type: object properties: name: type: string description: Email source name type: type: string description: Type of the email source is_segment: type: boolean description: Is the source reference a segment segment_type: type: string description: Segment type if this source is tied to a segment list_name: type: string description: Associated list name to the source include_source_in_target: type: boolean description: To include list contacts as part of audience lookalike_country_code: type: string description: To find similar audience in given country targeting_specs: type: object properties: gender: type: integer enum: - 0 - 1 - 2 min_age: type: integer max_age: type: integer locations: type: object properties: countries: type: array items: type: string regions: type: array items: type: string cities: type: array items: type: string zips: type: array items: type: string interests: type: array items: type: object properties: name: type: string budget: type: object properties: duration: type: integer description: Duration of the ad in seconds example: 86400 total_amount: type: number description: Total budget of the ad example: 500 currency_code: type: string description: Currency code example: USD content: type: object properties: title: type: string link_url: type: string message: type: string description: type: string image_url: type: string call_to_action: type: string attachments: type: array items: type: object properties: name: type: string link_url: type: string description: type: string image_url: type: string call_to_action: type: string - type: object properties: _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: - Facebook - Outreach_id x-custom-config: methodNameSnake: get_ad methodNameCamel: getAd summary: Mailchimp Get Facebook Ad Info operationId: getFacebookAdsId x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/facebook-ads: get: description: Get reports of Facebook ads. 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - created_at - updated_at - end_time example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: List of Facebook Ad Report Instances schema: type: object description: A collection of Facebook ads. properties: facebook_ads: type: array items: allOf: - type: object properties: id: type: string title: ID description: Unique ID of an Outreach. web_id: type: integer title: Web ID description: >- The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. name: type: string title: Name description: Title or name of an Outreach. type: type: string title: Outreach Type description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey - sms status: type: string title: Outreach Status description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished show_report: type: boolean title: Show Report description: >- Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context. create_time: type: string title: Create Time format: date-time description: >- The date and time the outreach was created in ISO 8601 format. start_time: type: string title: Start Time format: date-time description: >- The date and time the outreach was started in ISO 8601 format. updated_at: type: string title: Updated At format: date-time description: >- The date and time the outreach was last updated in ISO 8601 format. canceled_at: type: string title: Canceled At format: date-time description: >- The date and time the outreach was canceled in ISO 8601 format. published_time: type: string title: Publish Time format: date-time description: >- The date and time the outreach was (or will be) published in ISO 8601 format. has_segment: type: boolean title: Has Segment description: If this outreach targets a segment of your audience. report_summary: type: object title: Report Summary description: High level reporting stats for an outreach. properties: opens: type: integer unique_opens: type: integer open_rate: type: number clicks: type: integer subscriber_clicks: type: integer click_rate: type: number visits: type: integer unique_visits: type: integer conversion_rate: type: number subscribes: type: integer ecommerce: type: object properties: total_revenue: type: number currency_code: type: string average_order_revenue: type: number impressions: type: number reach: type: integer engagements: type: integer total_sent: type: integer recipients: type: object title: Recipients description: >- High level audience information for who the outreach targets. 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/save-and-manage-segments/) 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: >- Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: >- Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: >- Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: >- Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. thumbnail: type: string title: Thumbnail description: The URL of the thumbnail for this outreach. - type: object properties: email_source_name: type: string title: 'Ad: Email Source Name' paused_at: type: string title: 'Ad: Paused At' format: date-time description: >- The date and time the ad was paused in ISO 8601 format. end_time: type: string title: 'Ad: End Time' format: date-time description: >- The date and time the ad was ended in ISO 8601 format. needs_attention: type: boolean title: 'Ad: Needs Attention' description: If the ad has a problem and needs attention. was_canceled_by_facebook: type: boolean title: 'Ad: Was Canceled By Facebook' - type: object properties: channel: type: object description: Channel settings properties: fb_placement_feed: type: boolean description: Is this for facebook feed example: true fb_placement_audience: type: boolean description: Is this for facebook audience example: false ig_placement_feed: type: boolean description: Is this for instagram feed example: false audience: type: object description: Audience settings properties: type: type: string description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience source_type: type: string description: List or Facebook based audience enum: - facebook - list email_source: type: object properties: name: type: string description: Email source name type: type: string description: Type of the email source is_segment: type: boolean description: Is the source reference a segment segment_type: type: string description: >- Segment type if this source is tied to a segment list_name: type: string description: Associated list name to the source include_source_in_target: type: boolean description: To include list contacts as part of audience lookalike_country_code: type: string description: To find similar audience in given country targeting_specs: type: object properties: gender: type: integer enum: - 0 - 1 - 2 min_age: type: integer max_age: type: integer locations: type: object properties: countries: type: array items: type: string regions: type: array items: type: string cities: type: array items: type: string zips: type: array items: type: string interests: type: array items: type: object properties: name: type: string budget: type: object properties: duration: type: integer description: Duration of the ad in seconds example: 86400 total_amount: type: number description: Total budget of the ad example: 500 currency_code: type: string description: Currency code example: USD report_summary: type: object description: Report summary of facebook ad properties: reach: type: integer impressions: type: integer clicks: type: integer click_rate: type: number unique_clicks: type: integer first_time_buyers: type: integer ecommerce: type: object properties: total_revenue: type: number currency_code: type: string total_products_sold: type: integer total_orders: type: integer average_order_amount: type: object properties: amount: type: number currency_code: type: string cost_per_click: type: object properties: amount: type: number currency_code: type: string average_daily_budget: type: object properties: amount: type: number currency_code: type: string likes: type: integer comments: type: integer shares: type: integer has_extended_ad_duration: type: boolean extended_at: type: object properties: datetime: type: string timezone: type: string return_on_investment: type: number audience_activity: type: object properties: clicks: type: array items: type: object properties: date: type: string clicks: type: integer impressions: type: array items: type: object properties: date: type: string impressions: type: integer revenue: type: array items: type: object properties: date: type: string revenue: type: number - type: object properties: _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 tags: - Facebook - Reporting x-custom-config: methodNameSnake: get_facebook_ads_report_all methodNameCamel: getFacebookAdsReportAll summary: Mailchimp List Facebook Ads Reports operationId: getReportingFacebookAds x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/facebook-ads/{outreach_id}: get: description: Get report of a Facebook ad. 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 example: example_value - in: path name: outreach_id x-title: Outreach ID type: string required: true description: The outreach id. example: '500123' - 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 example: example_value responses: '200': description: Facebook Ad report Instance schema: allOf: - type: object properties: id: type: string title: ID description: Unique ID of an Outreach. web_id: type: integer title: Web ID description: >- The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`. name: type: string title: Name description: Title or name of an Outreach. type: type: string title: Outreach Type description: The type of outreach this object is. enum: - regular - email-touchpoint - plaintext - rss - reconfirm - variate - absplit - automation - facebook - google - autoresponder - transactional - page - website - social_post - survey - customer_journey - sms status: type: string title: Outreach Status description: The status of this outreach. enum: - save - paused - schedule - scheduled - sending - sent - canceled - canceling - active - disconnected - somepaused - draft - completed - partialRejected - pending - rejected - published - unpublished show_report: type: boolean title: Show Report description: >- Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context. create_time: type: string title: Create Time format: date-time description: >- The date and time the outreach was created in ISO 8601 format. start_time: type: string title: Start Time format: date-time description: >- The date and time the outreach was started in ISO 8601 format. updated_at: type: string title: Updated At format: date-time description: >- The date and time the outreach was last updated in ISO 8601 format. canceled_at: type: string title: Canceled At format: date-time description: >- The date and time the outreach was canceled in ISO 8601 format. published_time: type: string title: Publish Time format: date-time description: >- The date and time the outreach was (or will be) published in ISO 8601 format. has_segment: type: boolean title: Has Segment description: If this outreach targets a segment of your audience. report_summary: type: object title: Report Summary description: High level reporting stats for an outreach. properties: opens: type: integer unique_opens: type: integer open_rate: type: number clicks: type: integer subscriber_clicks: type: integer click_rate: type: number visits: type: integer unique_visits: type: integer conversion_rate: type: number subscribes: type: integer ecommerce: type: object properties: total_revenue: type: number currency_code: type: string average_order_revenue: type: number impressions: type: number reach: type: integer engagements: type: integer total_sent: type: integer recipients: type: object title: Recipients description: >- High level audience information for who the outreach targets. 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/save-and-manage-segments/) 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: >- Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: >- Segment by interaction with a specific campaign. 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: >- Segment by interaction 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: >- Segment by interaction 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: Segment 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: Segment 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: >- Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: >- Segment by interaction with a campaign via Conversations. 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: Segment 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: Segment by use of 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: >- Segment by use of 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: Segment by 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: Segment 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: Segment 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: Segment by 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: >- Segment by interaction with a SurveyMonkey 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: >- Segment by interaction with a SurveyMonkey 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: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by 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: Segment by an 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: >- Segment by purchases in 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: >- Segment by purchases in 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: >- Segment by average spent 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: >- Segment by average spent 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: >- Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: >- Segment by whether someone has 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: >- Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: >- Segment by amount spent on a single order or across all orders. 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: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: >- Segment by purchases 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: Segment by 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: Segment by 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: >- Segment by most recent 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: >- Segment by most recent 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: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. 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: Segment 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: Segment 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: Segment by 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: Segment by 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: Segment by 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: >- Segment members whose location information is unknown. 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: Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: >- Segment by 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: Segment 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: >- Segment 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: Segment 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: Segment 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: >- Segment 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by 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: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. 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. thumbnail: type: string title: Thumbnail description: The URL of the thumbnail for this outreach. - type: object properties: email_source_name: type: string title: 'Ad: Email Source Name' paused_at: type: string title: 'Ad: Paused At' format: date-time description: The date and time the ad was paused in ISO 8601 format. end_time: type: string title: 'Ad: End Time' format: date-time description: The date and time the ad was ended in ISO 8601 format. needs_attention: type: boolean title: 'Ad: Needs Attention' description: If the ad has a problem and needs attention. was_canceled_by_facebook: type: boolean title: 'Ad: Was Canceled By Facebook' - type: object properties: channel: type: object description: Channel settings properties: fb_placement_feed: type: boolean description: Is this for facebook feed example: true fb_placement_audience: type: boolean description: Is this for facebook audience example: false ig_placement_feed: type: boolean description: Is this for instagram feed example: false audience: type: object description: Audience settings properties: type: type: string description: Type of the audience enum: - Custom Audience - Lookalike Audience - Interest-based Audience source_type: type: string description: List or Facebook based audience enum: - facebook - list email_source: type: object properties: name: type: string description: Email source name type: type: string description: Type of the email source is_segment: type: boolean description: Is the source reference a segment segment_type: type: string description: Segment type if this source is tied to a segment list_name: type: string description: Associated list name to the source include_source_in_target: type: boolean description: To include list contacts as part of audience lookalike_country_code: type: string description: To find similar audience in given country targeting_specs: type: object properties: gender: type: integer enum: - 0 - 1 - 2 min_age: type: integer max_age: type: integer locations: type: object properties: countries: type: array items: type: string regions: type: array items: type: string cities: type: array items: type: string zips: type: array items: type: string interests: type: array items: type: object properties: name: type: string budget: type: object properties: duration: type: integer description: Duration of the ad in seconds example: 86400 total_amount: type: number description: Total budget of the ad example: 500 currency_code: type: string description: Currency code example: USD report_summary: type: object description: Report summary of facebook ad properties: reach: type: integer impressions: type: integer clicks: type: integer click_rate: type: number unique_clicks: type: integer first_time_buyers: type: integer ecommerce: type: object properties: total_revenue: type: number currency_code: type: string total_products_sold: type: integer total_orders: type: integer average_order_amount: type: object properties: amount: type: number currency_code: type: string cost_per_click: type: object properties: amount: type: number currency_code: type: string average_daily_budget: type: object properties: amount: type: number currency_code: type: string likes: type: integer comments: type: integer shares: type: integer has_extended_ad_duration: type: boolean extended_at: type: object properties: datetime: type: string timezone: type: string return_on_investment: type: number audience_activity: type: object properties: clicks: type: array items: type: object properties: date: type: string clicks: type: integer impressions: type: array items: type: object properties: date: type: string impressions: type: integer revenue: type: array items: type: object properties: date: type: string revenue: type: number - type: object properties: _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: - Facebook - Outreach_id - Reporting x-custom-config: methodNameSnake: get_facebook_ad_report methodNameCamel: getFacebookAdReport summary: Mailchimp Get Facebook Ad Report operationId: getReportingFacebookAdsId x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity: get: description: Get breakdown of product activity for an outreach. 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value - in: path name: outreach_id x-title: Outreach ID type: string required: true description: The outreach id. example: '500123' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - title - total_revenue - total_purchased example: example_value responses: '200': description: Ecommerce Product Activity Instance schema: type: object description: A collection of ecommerce products. properties: products: type: array items: type: object properties: title: type: string sku: type: string image_url: type: string total_revenue: type: number total_purchased: type: number currency_code: type: string recommendation_total: type: integer recommendation_purchased: type: integer 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: - Activity - Facebook - Outreach_id - Product - Reporting x-custom-config: methodNameSnake: get_facebook_ad_product_activity_report methodNameCamel: getFacebookAdProductActivityReport summary: Mailchimp List Facebook Ecommerce Report operationId: getReportingFacebookAdsIdEcommerceProductActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/landing-pages/{outreach_id}: get: description: Get report of a landing page. 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 example: example_value - in: path name: outreach_id x-title: Outreach ID type: string required: true description: The outreach id. example: '500123' - 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 example: example_value responses: '200': description: Landing Page Report Instance schema: type: object title: Landing Page Report description: A summary of an individual landing page's settings and content. properties: id: type: string title: Landing Page ID description: A string that uniquely identifies this landing page. readOnly: true example: 00dfc2e1f0 name: type: string title: Name description: The name of this landing page the user will see. readOnly: true title: type: string title: Title description: The name of the landing page the user's customers will see. readOnly: true url: type: string title: Url description: The landing page url. readOnly: true published_at: type: string title: Published At description: The time this landing page was published. format: date-time readOnly: true unpublished_at: type: string title: Unpublished At description: The time this landing page was unpublished. format: date-time readOnly: true status: type: string title: Status description: The status of the landing page. readOnly: true list_id: type: string title: List Id description: The list id connected to this landing page. readOnly: true visits: type: integer title: Visits description: The number of visits to this landing pages. readOnly: true unique_visits: type: integer title: Unique Visits description: The number of unique visits to this landing pages. readOnly: true subscribes: type: integer title: Subscribes description: The number of subscribes to this landing pages. readOnly: true clicks: type: integer title: Clicks description: The number of clicks to this landing pages. readOnly: true conversion_rate: type: number title: Conversion rate description: >- The percentage of people who visited your landing page and were added to your list. readOnly: true timeseries: type: object properties: daily_stats: type: object title: Daily clicks and visits data description: The clicks and visits data from the last seven days. readOnly: true properties: clicks: type: array title: Clicks items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 13 visits: type: array title: Visits items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 11 unique_visits: type: array title: Unique Visits items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 1 weekly_stats: type: object title: Weekly clicks and visits data description: The clicks and visits data from the last five weeks. readOnly: true properties: clicks: type: array title: Clicks description: The total number of clicks in a week. items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 23 visits: type: array title: Visits description: The total number of visits in a week. items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 49 unique_visits: type: array title: Unique Visits items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 1 ecommerce: type: object properties: total_revenue: type: number title: Total Revenue description: The total revenue of this landing page. readOnly: true currency_code: type: string title: Currency code description: The user's currency code. readOnly: true total_orders: type: integer title: Total Orders description: >- The total number of orders associated with this landing page. readOnly: true average_order_revenue: type: number title: Average Order Revenue description: The average order revenue of this landing page. readOnly: true web_id: type: integer title: Landing Page Web ID description: The ID used in the Mailchimp web application. readOnly: true example: 33345484 list_name: type: string title: List Name description: List Name readOnly: true example: Test List signup_tags: type: array title: Signup Tags description: A list of tags associated to the landing page. readOnly: true items: type: object title: Tag properties: tag_id: type: integer title: Tag ID description: The unique id for the tag. readOnly: true tag_name: type: string title: Tag Name description: The name of the tag. 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: - Landing - Pages - Reporting x-custom-config: methodNameSnake: get_landing_page_report methodNameCamel: getLandingPageReport summary: Mailchimp Get Landing Page Report operationId: getReportingLandingPagesId x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/landing-pages: get: description: Get reports of landing pages. 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: List of Landing Page Report Instances schema: type: object description: A collection of landing pages. properties: landing_pages: type: array items: type: object title: Landing Page Report description: >- A summary of an individual landing page's settings and content. properties: id: type: string title: Landing Page ID description: A string that uniquely identifies this landing page. readOnly: true example: 00dfc2e1f0 name: type: string title: Name description: The name of this landing page the user will see. readOnly: true title: type: string title: Title description: >- The name of the landing page the user's customers will see. readOnly: true url: type: string title: Url description: The landing page url. readOnly: true published_at: type: string title: Published At description: The time this landing page was published. format: date-time readOnly: true unpublished_at: type: string title: Unpublished At description: The time this landing page was unpublished. format: date-time readOnly: true status: type: string title: Status description: The status of the landing page. readOnly: true list_id: type: string title: List Id description: The list id connected to this landing page. readOnly: true visits: type: integer title: Visits description: The number of visits to this landing pages. readOnly: true unique_visits: type: integer title: Unique Visits description: The number of unique visits to this landing pages. readOnly: true subscribes: type: integer title: Subscribes description: The number of subscribes to this landing pages. readOnly: true clicks: type: integer title: Clicks description: The number of clicks to this landing pages. readOnly: true conversion_rate: type: number title: Conversion rate description: >- The percentage of people who visited your landing page and were added to your list. readOnly: true timeseries: type: object properties: daily_stats: type: object title: Daily clicks and visits data description: The clicks and visits data from the last seven days. readOnly: true properties: clicks: type: array title: Clicks items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 13 visits: type: array title: Visits items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 11 unique_visits: type: array title: Unique Visits items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 1 weekly_stats: type: object title: Weekly clicks and visits data description: The clicks and visits data from the last five weeks. readOnly: true properties: clicks: type: array title: Clicks description: The total number of clicks in a week. items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 23 visits: type: array title: Visits description: The total number of visits in a week. items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 49 unique_visits: type: array title: Unique Visits items: type: object properties: date: type: string title: Date readOnly: true example: '2018-04-25' val: type: integer title: Value readOnly: true example: 1 ecommerce: type: object properties: total_revenue: type: number title: Total Revenue description: The total revenue of this landing page. readOnly: true currency_code: type: string title: Currency code description: The user's currency code. readOnly: true total_orders: type: integer title: Total Orders description: >- The total number of orders associated with this landing page. readOnly: true average_order_revenue: type: number title: Average Order Revenue description: The average order revenue of this landing page. readOnly: true web_id: type: integer title: Landing Page Web ID description: The ID used in the Mailchimp web application. readOnly: true example: 33345484 list_name: type: string title: List Name description: List Name readOnly: true example: Test List signup_tags: type: array title: Signup Tags description: A list of tags associated to the landing page. readOnly: true items: type: object title: Tag properties: tag_id: type: integer title: Tag ID description: The unique id for the tag. readOnly: true tag_name: type: string title: Tag Name description: The name of the tag. 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 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: - Landing - Pages - Reporting x-custom-config: methodNameSnake: get_landing_page_reports_all methodNameCamel: getLandingPageReportsAll summary: Mailchimp List Landing Pages Reports operationId: getReportingLandingPages x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/surveys: get: summary: Mailchimp List Survey Reports description: Get reports for surveys. operationId: getReportingSurveys 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 example: example_value - 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 example: example_value - 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 example: example_value - 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 example: example_value responses: '200': description: List of Survey Report Instances schema: type: object properties: surveys: type: array title: Surveys description: The surveys that have reports available. items: type: object title: Survey Report description: The report for a survey. properties: id: type: string title: Survey ID description: A string that uniquely identifies this survey. readOnly: true example: 040d2c2e1f0 web_id: type: integer title: Survey Web ID description: >- The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`. readOnly: true example: 165 list_id: type: string title: List ID description: The ID of the list connected to this survey. readOnly: true list_name: type: string title: List Name description: The name of the list connected to this survey. readOnly: true title: type: string title: Title description: The title of the survey. readOnly: true example: New product ideas url: type: string title: URL description: The URL for the survey. readOnly: true status: type: string title: Status description: The survey's status. readOnly: true example: published enum: - published - unpublished published_at: type: string format: date-time title: Published At description: >- The date and time the survey was published in ISO 8601 format. readOnly: true example: '2017-08-04T11:09:01+00:00' created_at: type: string format: date-time title: Created At description: >- The date and time the survey was created in ISO 8601 format. readOnly: true example: '2017-08-04T11:09:01+00:00' updated_at: type: string format: date-time title: Updated At description: >- The date and time the survey was last updated in ISO 8601 format. readOnly: true example: '2017-08-04T11:09:01+00:00' total_responses: type: integer title: Total Responses description: The total number of responses to this survey. readOnly: true example: 810 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: - Reporting - Surveys x-custom-config: methodNameSnake: get_survey_reports_all methodNameCamel: getSurveyReportsAll x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/surveys/{survey_id}: get: summary: Mailchimp Get Survey Report description: Get report for a survey. operationId: getReportingSurveysId 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 example: example_value - 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 example: example_value - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' responses: '200': description: Survey Report Instance schema: type: object title: Survey Report description: The report for a survey. properties: id: type: string title: Survey ID description: A string that uniquely identifies this survey. readOnly: true example: 040d2c2e1f0 web_id: type: integer title: Survey Web ID description: >- The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`. readOnly: true example: 165 list_id: type: string title: List ID description: The ID of the list connected to this survey. readOnly: true list_name: type: string title: List Name description: The name of the list connected to this survey. readOnly: true title: type: string title: Title description: The title of the survey. readOnly: true example: New product ideas url: type: string title: URL description: The URL for the survey. readOnly: true status: type: string title: Status description: The survey's status. readOnly: true example: published enum: - published - unpublished published_at: type: string format: date-time title: Published At description: The date and time the survey was published in ISO 8601 format. readOnly: true example: '2017-08-04T11:09:01+00:00' created_at: type: string format: date-time title: Created At description: The date and time the survey was created in ISO 8601 format. readOnly: true example: '2017-08-04T11:09:01+00:00' updated_at: type: string format: date-time title: Updated At description: >- The date and time the survey was last updated in ISO 8601 format. readOnly: true example: '2017-08-04T11:09:01+00:00' total_responses: type: integer title: Total Responses description: The total number of responses to this survey. readOnly: true example: 810 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: - Reporting - Surveys x-custom-config: methodNameSnake: get_survey_report methodNameCamel: getSurveyReport x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/surveys/{survey_id}/questions: get: summary: Mailchimp List Survey Question Reports description: Get reports for survey questions. operationId: getReportingSurveysIdQuestions 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 example: example_value - 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 example: example_value - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' responses: '200': description: List of Survey Question Report Instances schema: type: object properties: questions: type: array title: Question Reports description: An array of reports for each question on the survey. items: type: object title: Survey Question Report description: The details of a survey question's report. properties: id: type: string title: Survey Question ID description: The ID of the survey question. readOnly: true survey_id: type: string title: Survey ID description: The unique ID of the survey. readOnly: true query: type: string title: Query Text description: The query of the survey question. readOnly: true type: type: string title: Response Type description: The response type of the survey question. enum: - pickOne - pickMany - range - text - email readOnly: true total_responses: type: integer title: Total Responses description: The total number of responses to this question. readOnly: true example: 810 is_required: type: boolean title: Is Required description: Whether this survey question is required to answer. readOnly: true has_other: type: boolean title: Has Other Option description: Whether this survey question has an 'other' option. readOnly: true other_label: type: string title: Other Option Label description: >- Label used for the 'other' option of this survey question. readOnly: true average_rating: type: number format: float title: Average Rating for a Range Question description: The average rating for this range question. readOnly: true example: 2.5 range_low_label: type: string title: Range Low Label description: Label for the low end of the range. readOnly: true range_high_label: type: string title: Range High Label description: Label for the high end of the range. readOnly: true placeholder_label: type: string title: Placeholder Label description: Placeholder text for this survey question's answer box. readOnly: true subscribe_checkbox_enabled: type: boolean title: Is Subscribe Checkbox Enabled description: >- Whether the subscribe checkbox is shown for this email question. readOnly: true subscribe_checkbox_label: type: string title: Subscribe Checkbox Label description: >- Label used for the subscribe checkbox for this email question. readOnly: true merge_field: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true label: type: string title: Merge Field Label description: >- The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. readOnly: true type: type: string title: Merge Field Type description: >- The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true readOnly: true options: type: array title: Options description: The answer choices for this question. items: type: object properties: label: type: string title: Option Label description: The label for this survey question option. id: type: string title: Option ID description: The ID for this survey question option. count: type: integer title: Response Count description: >- The count of responses that selected this survey question option. readOnly: true contact_counts: type: object title: Contact Counts description: >- For email question types, how many are new, known, or unknown contacts. properties: known: type: integer title: Known Contacts Count description: >- The number of known contacts that responded to this survey. unknown: type: integer title: Unknown Contacts Count description: >- The number of unknown contacts that responded to this survey. new: type: integer title: New Contacts Count description: >- The number of new contacts that responded to this survey. 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: - Questions - Reporting - Surveys x-custom-config: methodNameSnake: get_survey_question_reports_all methodNameCamel: getSurveyQuestionReportsAll x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/surveys/{survey_id}/questions/{question_id}: get: summary: Mailchimp Get Survey Question Report description: Get report for a survey question. operationId: getReportingSurveysIdQuestionsId 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 example: example_value - 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 example: example_value - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' - in: path name: question_id x-title: Question ID type: string required: true description: The ID of the survey question. example: '500123' responses: '200': description: Survey Question Report Instance schema: type: object title: Survey Question Report description: The details of a survey question's report. properties: id: type: string title: Survey Question ID description: The ID of the survey question. readOnly: true survey_id: type: string title: Survey ID description: The unique ID of the survey. readOnly: true query: type: string title: Query Text description: The query of the survey question. readOnly: true type: type: string title: Response Type description: The response type of the survey question. enum: - pickOne - pickMany - range - text - email readOnly: true total_responses: type: integer title: Total Responses description: The total number of responses to this question. readOnly: true example: 810 is_required: type: boolean title: Is Required description: Whether this survey question is required to answer. readOnly: true has_other: type: boolean title: Has Other Option description: Whether this survey question has an 'other' option. readOnly: true other_label: type: string title: Other Option Label description: Label used for the 'other' option of this survey question. readOnly: true average_rating: type: number format: float title: Average Rating for a Range Question description: The average rating for this range question. readOnly: true example: 2.5 range_low_label: type: string title: Range Low Label description: Label for the low end of the range. readOnly: true range_high_label: type: string title: Range High Label description: Label for the high end of the range. readOnly: true placeholder_label: type: string title: Placeholder Label description: Placeholder text for this survey question's answer box. readOnly: true subscribe_checkbox_enabled: type: boolean title: Is Subscribe Checkbox Enabled description: >- Whether the subscribe checkbox is shown for this email question. readOnly: true subscribe_checkbox_label: type: string title: Subscribe Checkbox Label description: Label used for the subscribe checkbox for this email question. readOnly: true merge_field: type: object title: Merge Field description: >- A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true label: type: string title: Merge Field Label description: >- The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. readOnly: true type: type: string title: Merge Field Type description: >- The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true readOnly: true options: type: array title: Options description: The answer choices for this question. items: type: object properties: label: type: string title: Option Label description: The label for this survey question option. id: type: string title: Option ID description: The ID for this survey question option. count: type: integer title: Response Count description: >- The count of responses that selected this survey question option. readOnly: true contact_counts: type: object title: Contact Counts description: >- For email question types, how many are new, known, or unknown contacts. properties: known: type: integer title: Known Contacts Count description: >- The number of known contacts that responded to this survey. unknown: type: integer title: Unknown Contacts Count description: >- The number of unknown contacts that responded to this survey. new: type: integer title: New Contacts Count description: The number of new contacts that responded to this survey. 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: - Questions - Reporting - Surveys x-custom-config: methodNameSnake: get_survey_question_report methodNameCamel: getSurveyQuestionReport x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/surveys/{survey_id}/questions/{question_id}/answers: get: summary: Mailchimp List Answers for Question description: Get answers for a survey question. operationId: getReportingSurveysIdQuestionsIdAnswers 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 example: example_value - 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 example: example_value - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' - in: path name: question_id x-title: Question ID type: string required: true description: The ID of the survey question. example: '500123' - name: respondent_familiarity_is x-title: Respondent Familiarity Is in: query description: Filter survey responses by familiarity of the respondents. required: false type: string enum: - new - known - unknown example: example_value responses: '200': description: List of Survey Question Answers schema: type: object properties: answers: type: array title: Answers description: An array of answers for a question on the survey. items: type: object title: Survey Question Answer description: The details of a survey question's answer. properties: id: type: string title: Answer ID description: The ID of the answer. readOnly: true value: type: string title: Value description: The raw text answer. readOnly: true response_id: type: string title: Response ID description: The ID of the survey response. readOnly: true submitted_at: type: string format: date-time title: Submitted At description: >- The date and time when the survey response was submitted in ISO 8601 format. readOnly: true contact: type: object title: Contact description: Information about the contact. readOnly: true properties: email_id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: The ID of this contact. readOnly: true status: type: string title: Contact Status description: The contact's current status. readOnly: true enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived email: type: string title: Contact Email description: The contact's email address. readOnly: true phone: type: string title: Contact SMS Phone description: The contact's sms phone number. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: >- Indicates whether a contact consents to 1:1 messaging. readOnly: true avatar_url: type: string title: Avatar URL description: URL for the contact's avatar or profile image. readOnly: true is_new_contact: type: boolean title: Is New Contact description: >- If this contact was added to the Mailchimp audience via this survey. readOnly: false 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: - Answers - Questions - Reporting - Surveys x-custom-config: methodNameSnake: get_survey_question_answers methodNameCamel: getSurveyQuestionAnswers x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/surveys/{survey_id}/responses: get: summary: Mailchimp List Survey Responses description: Get responses to a survey. operationId: getReportingSurveysIdResponses 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 example: example_value - 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 example: example_value - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' - name: answered_question x-title: Answered Question in: query description: The ID of the question that was answered. required: false type: integer example: example_value - name: chose_answer x-title: Chose Answer in: query description: The ID of the option chosen to filter responses on. required: false type: string example: example_value - name: respondent_familiarity_is x-title: Respondent Familiarity Is in: query description: Filter survey responses by familiarity of the respondents. required: false type: string enum: - new - known - unknown example: example_value responses: '200': description: List of survey responses schema: type: object properties: responses: type: array title: Responses description: An array of responses to a survey. items: type: object title: Survey Respondents description: Survey respondent details. properties: response_id: type: string title: Response ID description: The ID for the survey response. readOnly: true submitted_at: type: string format: date-time title: Submitted At description: >- The date and time when the survey response was submitted in ISO 8601 format. readOnly: true contact: type: object title: Contact description: Information about the contact. readOnly: true properties: email_id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: The ID of this contact. readOnly: true status: type: string title: Contact Status description: The contact's current status. readOnly: true enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived email: type: string title: Contact Email description: The contact's email address. readOnly: true phone: type: string title: Contact SMS Phone description: The contact's sms phone number. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: >- Indicates whether a contact consents to 1:1 messaging. readOnly: true avatar_url: type: string title: Avatar URL description: URL for the contact's avatar or profile image. readOnly: true is_new_contact: type: boolean title: Is New Contact description: >- If this contact was added to the Mailchimp audience via this survey. readOnly: false 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: - Reporting - Surveys x-custom-config: methodNameSnake: get_survey_responses_all methodNameCamel: getSurveyResponsesAll x-microcks-operation: delay: 0 dispatcher: FALLBACK /reporting/surveys/{survey_id}/responses/{response_id}: get: summary: Mailchimp Get Survey Response description: Get a single survey response. operationId: getReportingSurveysIdResponsesId parameters: - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' - in: path name: response_id x-title: Response ID type: string required: true description: The ID of the survey response. example: '500123' responses: '200': description: Get a single survey response. schema: type: object title: Survey Response description: A single survey response. properties: response_id: type: string title: Response ID description: The ID for the survey response. readOnly: true submitted_at: type: string format: date-time title: Submitted At description: >- The date and time when the survey response was submitted in ISO 8601 format. readOnly: true contact: type: object title: Contact description: Information about the contact. readOnly: true properties: email_id: type: string title: Email ID description: >- The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: The ID of this contact. readOnly: true status: type: string title: Contact Status description: The contact's current status. readOnly: true enum: - Subscribed - Unsubscribed - Non-Subscribed - Cleaned - Archived email: type: string title: Contact Email description: The contact's email address. readOnly: true phone: type: string title: Contact SMS Phone description: The contact's sms phone number. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true avatar_url: type: string title: Avatar URL description: URL for the contact's avatar or profile image. readOnly: true is_new_contact: type: boolean title: Is New Contact description: >- If this contact was added to the Mailchimp audience via this survey. readOnly: false results: type: array title: Results description: The survey questions and the answers to those questions. items: type: object title: Response description: A single question and the response to that question. properties: question_id: type: string title: Question ID description: The unique ID for this question. question_type: type: string title: Question Type description: The type of question this is. enum: - pickOne - pickMany - range - text - email query: type: string title: Question Query description: The survey question. answer: type: string title: Answer description: The answer to this survey question. 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: - Reporting - Response_id - Surveys x-custom-config: methodNameSnake: get_survey_response methodNameCamel: getSurveyResponse x-microcks-operation: delay: 0 dispatcher: FALLBACK /verified-domains/{domain_name}: get: summary: Mailchimp Get Domain Info description: Get the details for a single domain on the account. operationId: getVerifiedDomain parameters: - in: path name: domain_name x-title: Domain Name type: string required: true description: The domain name. example: example_value responses: '200': description: '' schema: type: object title: Verified Domains description: The verified domains currently on the account. properties: domain: type: string title: Domain Name description: The name of this domain. readOnly: true verified: type: boolean title: Verified description: Whether the domain has been verified for sending. readOnly: true authenticated: type: boolean title: Authenticated description: Whether domain authentication is enabled for this domain. readOnly: true verification_email: type: string title: Verification Email description: >- The e-mail address receiving the two-factor challenge for this domain. readOnly: true verification_sent: type: string format: date-time title: Verification Challenge Sent description: >- The date/time that the two-factor challenge was sent to the verification email. 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: - Domains - Verified - Verified Domains x-custom-config: methodNameSnake: get_domain methodNameCamel: getDomain x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Domain description: Delete a verified domain from the account. operationId: deleteVerifiedDomain parameters: - in: path name: domain_name x-title: Domain Name type: string required: true description: The domain name. example: example_value 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: - Domains - Verified - Verified Domains x-custom-config: methodNameSnake: delete_domain methodNameCamel: deleteDomain x-microcks-operation: delay: 0 dispatcher: FALLBACK /verified-domains/{domain_name}/actions/verify: post: summary: Mailchimp Verify Domain description: Verify a domain for sending. operationId: verifyDomain parameters: - in: path name: domain_name x-title: Domain Name type: string required: true description: The domain name. example: example_value - in: body name: body description: '' required: true schema: type: object title: Verify a domain for sending. description: >- Submit a response to the verification challenge and verify a domain for sending. required: - code properties: code: type: string title: Verification Code description: >- The code that was sent to the email address provided when adding a new domain to verify. example: example_value responses: '200': description: The domain being verified for sending. schema: type: object title: Verified Domains description: The verified domains currently on the account. properties: domain: type: string title: Domain Name description: The name of this domain. readOnly: true verified: type: boolean title: Verified description: Whether the domain has been verified for sending. readOnly: true authenticated: type: boolean title: Authenticated description: Whether domain authentication is enabled for this domain. readOnly: true verification_email: type: string title: Verification Email description: >- The e-mail address receiving the two-factor challenge for this domain. readOnly: true verification_sent: type: string format: date-time title: Verification Challenge Sent description: >- The date/time that the two-factor challenge was sent to the verification email. 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: - Actions - Domains - Verified - Verify x-custom-config: methodNameSnake: submit_domain_verification methodNameCamel: submitDomainVerification x-microcks-operation: delay: 0 dispatcher: FALLBACK /verified-domains: get: summary: Mailchimp List Sending Domains description: Get all of the sending domains on the account. operationId: getVerifiedDomains responses: '200': description: The domains on the account. schema: type: object title: Verified Domains description: The verified domains currently on the account. properties: domains: type: array title: Domains description: The domains on the account readOnly: true items: type: object title: Verified Domains description: The verified domains currently on the account. properties: domain: type: string title: Domain Name description: The name of this domain. readOnly: true verified: type: boolean title: Verified description: Whether the domain has been verified for sending. readOnly: true authenticated: type: boolean title: Authenticated description: >- Whether domain authentication is enabled for this domain. readOnly: true verification_email: type: string title: Verification Email description: >- The e-mail address receiving the two-factor challenge for this domain. readOnly: true verification_sent: type: string format: date-time title: Verification Challenge Sent description: >- The date/time that the two-factor challenge was sent to the verification email. readOnly: true total_items: type: integer title: Item Count description: >- The total number of items matching the query regardless of pagination. 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: - Domains - Verified x-custom-config: methodNameSnake: get_verified_domains_all methodNameCamel: getVerifiedDomainsAll x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Domain to Account description: Add a domain to the account. operationId: createVerifiedDomain parameters: - in: body name: body description: '' required: true schema: type: object title: Verified Domains description: The verified domains currently on the account. required: - verification_email properties: verification_email: type: string title: Verification Email description: >- The e-mail address at the domain you want to verify. This will receive a two-factor challenge to be used in the verify action. example: example_value responses: '200': description: The newly-created domain. schema: type: object title: Verified Domains description: The verified domains currently on the account. properties: domain: type: string title: Domain Name description: The name of this domain. readOnly: true verified: type: boolean title: Verified description: Whether the domain has been verified for sending. readOnly: true authenticated: type: boolean title: Authenticated description: Whether domain authentication is enabled for this domain. readOnly: true verification_email: type: string title: Verification Email description: >- The e-mail address receiving the two-factor challenge for this domain. readOnly: true verification_sent: type: string format: date-time title: Verification Challenge Sent description: >- The date/time that the two-factor challenge was sent to the verification email. 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: - Domains - Verified x-custom-config: methodNameSnake: create_verified_domain methodNameCamel: createVerifiedDomain x-microcks-operation: delay: 0 dispatcher: FALLBACK definitions: {} externalDocs: description: Learn more with the full Mailchimp API documentation. url: https://mailchimp.com/developer/marketing/ tags: - name: Abuse - name: Account Export - name: Accounts - name: Actions - name: Activity - name: Advice - name: Answers - name: Applications - name: Archive - name: Authorized - name: Authorized Apps - name: Automations - name: Batch - name: Batch Webhooks - name: Batches - name: Campaign Folders - name: Campaigns - name: Cancels - name: Carts - name: Categories - name: Chatter - name: Checklist - name: Click - name: Clients - name: Connected - name: Connected Sites - name: Connected_site_id - name: Content - name: Conversations - name: Customers - name: Domains - name: Ecommerce - name: Eepurl - name: Email - name: Emails - name: Events - name: Exports - name: Facebook - name: Facebook Ads - name: Feed - name: Feedback - name: Fields - name: File Manager - name: Files - name: Folders - name: Forms - name: Goals - name: Growth - name: History - name: Images - name: Installation - name: Interest - name: Interests - name: Journeys - name: Landing - name: Landing Pages - name: Lines - name: List_id - name: Lists - name: Locations - name: Managers - name: Members - name: Merge - name: Messages - name: Month - name: Notes - name: Open - name: Orders - name: Outreach_id - name: Pages - name: Pause - name: Performance - name: Pings - name: Product - name: Products - name: Promo - name: Promo_code_id - name: Publish - name: Questions - name: Queues - name: Removed - name: Replicate - name: Reporting - name: Reports - name: Resend - name: Response_id - name: Resume - name: Root - name: Rules - name: Schedules - name: Scripts - name: Search - name: Segments - name: Send - name: Sent - name: Signup - name: Steps - name: Stores - name: Subscribers - name: Surveys - name: Template - name: Template Folders - name: Templates - name: Tests - name: Trigger - name: Unsubscribed - name: Variants - name: Verified - name: Verified Domains - name: Verify - name: Webhooks