swagger: '2.0' info: version: 3.0.55 title: Mailchimp Marketing Abuse Surveys 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: ' 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 schemes: - https consumes: - application/json produces: - application/json - application/problem+json security: - basicAuth: [] tags: - name: Surveys paths: /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: - 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: - 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: - 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: - 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: - Surveys x-custom-config: methodNameSnake: create_email methodNameCamel: createEmail operationId: postListsIdSurveysIdActionsCreateEmail 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: - 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: - 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: - 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: - 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: - 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: - 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: - Surveys x-custom-config: methodNameSnake: get_survey_response methodNameCamel: getSurveyResponse x-microcks-operation: delay: 0 dispatcher: FALLBACK securityDefinitions: basicAuth: type: basic externalDocs: description: Learn more with the full Mailchimp API documentation. url: https://mailchimp.com/developer/marketing/ 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: []