swagger: '2.0' info: version: 3.0.55 title: Mailchimp Marketing Abuse List_id 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: List_id paths: /lists/{list_id}: get: summary: Mailchimp Get List Info description: Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned. operationId: getListsId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: include_total_contacts x-title: Include Total Contacts in: query description: Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. required: false type: boolean example: example_value responses: '200': description: '' schema: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: '[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.' properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: '[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.' properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: 'Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.' default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list methodNameCamel: getList x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Lists description: Update the settings for a specific list. operationId: patchListsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Subscriber List description: Information about a specific list. required: - name - permission_reminder - email_type_option - contact - campaign_defaults properties: name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: '[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.' required: - company - address1 - city - state - zip - country properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: '[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.' required: - from_name - from_email - subject - language properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false email_type_option: type: boolean title: Email Type Option description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. double_optin: type: boolean title: Double Opt In description: Whether or not to require the subscriber to confirm subscription via email. default: false marketing_permissions: type: boolean title: Marketing Permissions description: Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false example: example_value responses: '200': description: '' schema: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: '[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.' properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: '[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.' properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: 'Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.' default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_list methodNameCamel: updateList x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete List description: Delete a list from your Mailchimp account. If you delete a list, you'll lose the list historyincluding subscriber activity, unsubscribes, complaints, and bounces. Youll also lose subscribers email addresses, unless you exported and backed up your list. operationId: deleteListsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_list methodNameCamel: deleteList x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Batch Subscribe or Unsubscribe description: Batch subscribe or unsubscribe list members. operationId: postListsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: skip_merge_validation x-title: Skip Merge Validation in: query description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: skip_duplicate_check x-title: Skip Duplicate Check in: query description: If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Members to Subscribe/Unsubscribe to/from a List in batch description: Members to subscribe to or unsubscribe from a list. required: - members properties: members: type: array title: List Members description: An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call. items: type: object title: Add List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time sync_tags: type: boolean title: Sync Tags description: Whether this batch operation will replace all existing tags with tags in request. update_existing: type: boolean title: Update Existing Members description: Whether this batch operation will change existing members' subscription status. example: example_value responses: '200': description: '' schema: type: object title: Batch update List members description: Batch update list members. properties: new_members: type: array title: New members description: An array of objects, each representing a new member that was added to the list. items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true updated_members: type: array title: Updated Members description: An array of objects, each representing an existing list member whose subscription status was updated. items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true errors: type: array title: Errors description: An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details. items: type: object properties: email_address: type: string title: Member Email address description: The email address that could not be added or updated. error: type: string title: Error message description: The error message indicating why the email address could not be added or updated. error_code: type: string title: Error code description: A unique code that identifies this specifc error. enum: - ERROR_CONTACT_EXISTS - ERROR_GENERIC field: type: string title: Field description: If the error is field-related, information about which field is at issue. field_message: type: string title: Field message description: Message indicating how to resolve a field-related error. total_created: type: integer title: Item Count description: The total number of items matching the query, irrespective of pagination. example: 42 total_updated: type: integer title: Item Count description: The total number of items matching the query, irrespective of pagination. example: 42 error_count: type: integer title: Item Count description: The total number of items matching the query, irrespective of pagination. example: 42 _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: batch_list_members methodNameCamel: batchListMembers x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/abuse-reports: get: summary: Mailchimp List Abuse Reports description: Get all abuse reports for a specific list. operationId: getListsIdAbuseReports parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaints description: A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: abuse_reports: type: array items: type: object title: Abuse Complaint description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The list id for the abuse report. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' readOnly: true date: type: string title: Date description: Date for the abuse report readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Abuse Reports description: An array of objects, each representing an abuse report resource. list_id: type: string title: List ID description: The list id for the abuse report. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_abuse_reports methodNameCamel: getListAbuseReports x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/abuse-reports/{report_id}: get: summary: Mailchimp Get Abuse Report description: Get details about a specific abuse report. operationId: getListsIdAbuseReportsId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: report_id in: path required: true type: string description: The id for the abuse report. example: '500123' responses: '200': description: '' schema: type: object title: Abuse Complaint description: Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program. properties: id: type: integer title: Abuse Report ID description: The id for the abuse report readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id for the abuse report readOnly: true list_id: type: string title: List ID description: The list id for the abuse report. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' readOnly: true date: type: string title: Date description: Date for the abuse report readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_abuse_report_details methodNameCamel: getListAbuseReportDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/activity: get: summary: Mailchimp List Recent Activity description: Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity. operationId: getListsIdActivity parameters: - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Activity description: Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity. properties: activity: type: array title: List Activity description: Recent list activity. items: type: object title: Daily List Activity description: One day's worth of list activity. Doesn't include Automation activity. properties: day: type: string title: Day description: The date for the activity summary. readOnly: true emails_sent: type: integer title: Emails Sent description: The total number of emails sent on the date for the activity summary. readOnly: true unique_opens: type: integer title: Unique Opens description: The number of unique opens. readOnly: true recipient_clicks: type: integer title: Recipient Clicks description: The number of clicks. readOnly: true hard_bounce: type: integer title: Hard Bounces description: The number of hard bounces. readOnly: true soft_bounce: type: integer title: Soft Bounces description: The number of soft bounces readOnly: true subs: type: integer title: Subscribes description: The number of subscribes. readOnly: true unsubs: type: integer title: Unsubscribes description: The number of unsubscribes. readOnly: true other_adds: type: integer title: Other Adds description: The number of subscribers who may have been added outside of the [double opt-in process](https://mailchimp.com/help/about-double-opt-in/), such as imports or API activity. readOnly: true other_removes: type: integer title: Other Removes description: The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers). readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true list_id: type: string title: List ID description: The unique id for the list. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_recent_activity methodNameCamel: getListRecentActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/clients: get: summary: Mailchimp List Top Email Clients description: Get a list of the top email clients based on user-agent strings. operationId: getListsIdClients parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Email Clients description: The top email clients based on user-agent strings. properties: clients: type: array title: Email Clients description: An array of top email clients. items: type: object title: Email Client description: The email client. properties: client: type: string title: Client description: The name of the email client. readOnly: true members: type: integer title: Members description: The number of subscribed members who used this email client. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_clients methodNameCamel: getListClients x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/growth-history: get: summary: Mailchimp List Growth History Data description: Get a month-by-month summary of a specific list's growth activity. operationId: getListsIdGrowthHistory parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - month example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value responses: '200': description: '' schema: type: object title: Growth History description: A month-by-month summary of a specific list's growth activity. properties: history: type: array items: type: object title: Growth History description: A summary of a specific list's growth activity for a specific month and year. properties: list_id: type: string title: List ID description: The list id for the growth activity report. readOnly: true month: type: string title: Month description: The month that the growth history is describing. readOnly: true existing: type: integer title: Existing description: (deprecated) readOnly: true imports: type: integer title: Imports description: (deprecated) readOnly: true optins: type: integer title: Opt-in description: (deprecated) readOnly: true subscribed: type: integer title: Subscribed description: Total subscribed members on the list at the end of the month. readOnly: true unsubscribed: type: integer title: Unsubscribed description: Newly unsubscribed members on the list for a specific month. readOnly: true reconfirm: type: integer title: Reconfirm description: Newly reconfirmed members on the list for a specific month. readOnly: true cleaned: type: integer title: Cleaned description: Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true pending: type: integer title: Pending description: Pending members on the list for a specific month. readOnly: true deleted: type: integer title: Deleted description: Newly deleted members on the list for a specific month. readOnly: true transactional: type: integer title: Transactional description: Subscribers that have been sent transactional emails via Mandrill. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a monthly growth report for a list. list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_growth_history methodNameCamel: getListGrowthHistory x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/growth-history/{month}: get: summary: Mailchimp Get Growth History by Month description: Get a summary of a specific list's growth activity for a specific month and year. operationId: getListsIdGrowthHistoryId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: month in: path required: true type: string description: A specific month of list growth history. example: example_value responses: '200': description: '' schema: type: object title: Growth History description: A summary of a specific list's growth activity for a specific month and year. properties: list_id: type: string title: List ID description: The list id for the growth activity report. readOnly: true month: type: string title: Month description: The month that the growth history is describing. readOnly: true existing: type: integer title: Existing description: (deprecated) readOnly: true imports: type: integer title: Imports description: (deprecated) readOnly: true optins: type: integer title: Opt-in description: (deprecated) readOnly: true subscribed: type: integer title: Subscribed description: Total subscribed members on the list at the end of the month. readOnly: true unsubscribed: type: integer title: Unsubscribed description: Newly unsubscribed members on the list for a specific month. readOnly: true reconfirm: type: integer title: Reconfirm description: Newly reconfirmed members on the list for a specific month. readOnly: true cleaned: type: integer title: Cleaned description: Newly cleaned (hard-bounced) members on the list for a specific month. readOnly: true pending: type: integer title: Pending description: Pending members on the list for a specific month. readOnly: true deleted: type: integer title: Deleted description: Newly deleted members on the list for a specific month. readOnly: true transactional: type: integer title: Transactional description: Subscribers that have been sent transactional emails via Mandrill. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_growth_history_by_month methodNameCamel: getListGrowthHistoryByMonth x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories: get: summary: Mailchimp List Interest Categories description: Get information about a list's interest categories. operationId: getListsIdInterestCategories parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: type x-title: Interest Group Type in: query required: false description: Restrict results a type of interest group type: string example: example_value responses: '200': description: '' schema: type: object title: Interest Groupings description: Information about this list's interest categories. properties: list_id: type: string title: List ID description: The ID for the list that this category belongs to. readOnly: true categories: type: array title: Interest Categories description: This array contains individual interest categories. items: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_interest_categories methodNameCamel: getListInterestCategories x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Interest Category description: Create a new interest category. operationId: postListsIdInterestCategories parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. required: - title - type properties: title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden example: example_value responses: '200': description: '' schema: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: create_list_interest_category methodNameCamel: createListInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories/{interest_category_id}: get: summary: Mailchimp Get Interest Category Info description: Get information about a specific interest category. operationId: getListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_interest_category methodNameCamel: getInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Interest Category description: Update a specific interest category. operationId: patchListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. required: - title - type properties: title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden example: example_value responses: '200': description: '' schema: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_interest_category methodNameCamel: updateInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Interest Category description: Delete a specific interest category. operationId: deleteListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_interest_category methodNameCamel: deleteInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories/{interest_category_id}/interests: get: summary: Mailchimp List Interests in Category description: Get a list of this category's interests. operationId: getListsIdInterestCategoriesIdInterests parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value responses: '200': description: '' schema: type: object title: Interests description: A list of this category's interests properties: interests: type: array items: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Interests description: An array of this category's interests list_id: type: string title: List ID description: The unique list id that the interests belong to. category_id: type: string title: Interest Category ID description: The id for the interest category. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: list_interest_category_interests methodNameCamel: listInterestCategoryInterests x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Interest in Category description: Create a new interest or 'group name' for a specific category. operationId: postListsIdInterestCategoriesIdInterests parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. required: - name properties: name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. display_order: type: integer title: Display Order description: The display order for interests. example: example_value responses: '200': description: '' schema: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: create_interest_category_interest methodNameCamel: createInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}: get: summary: Mailchimp Get Interest in Category description: Get interests or 'group names' for a specific category. operationId: getListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_interest_category_interest methodNameCamel: getInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Interest in Category description: Update interests or 'group names' for a specific category. operationId: patchListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' - name: body in: body required: true description: '' schema: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. required: - name properties: name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. display_order: type: integer title: Display Order description: The display order for interests. example: example_value responses: '200': description: '' schema: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_interest_category_interest methodNameCamel: updateInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Interest in Category description: Delete interests or group names in a specific category. operationId: deleteListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_interest_category_interest methodNameCamel: deleteInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments: get: summary: Mailchimp List Segments description: Get information about all available segments for a specific list. operationId: previewASegment parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: type x-title: Segment Type in: query required: false description: Limit results based on segment type. type: string example: example_value - name: since_created_at x-title: Since Created At in: query description: 'Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: '2026-01-15T10:30:00Z' - name: before_created_at x-title: Before Created At in: query description: 'Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: '2026-01-15T10:30:00Z' - name: include_cleaned in: query x-title: Include Cleaned description: Include cleaned members in response required: false type: boolean x-example: false example: example_value - name: include_transactional in: query x-title: Include Transactional description: Include transactional members in response required: false type: boolean x-example: false example: example_value - name: include_unsubscribed in: query x-title: Include Unsubscribed description: Include unsubscribed members in response required: false type: boolean x-example: false example: example_value - name: since_updated_at x-title: Since Updated At in: query description: 'Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: '2026-01-15T10:30:00Z' - name: before_updated_at x-title: Before Updated At in: query description: 'Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: '2026-01-15T10:30:00Z' responses: '200': description: '' schema: type: object title: Collection of Segments description: A list of available segments. properties: segments: type: array items: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: Match type. enum: - any - all conditions: type: array title: Segment Type description: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas). items: x-discriminator: type: string propertyName: condition_type x-oneOf: - type: object title: Aim Segment description: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. example: aim op: type: string enum: - open - click - sent - noopen - noclick - nosent title: Segment Operator description: 'The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn''t open, didn''t click, or was not sent.' example: open value: type: string title: Segment Data description: Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Automation Segment description: Segment by interaction with an Automation workflow. required: - field - op - value properties: condition_type: type: string x-value: Automation enum: - Automation field: type: string enum: - automation title: Segment Field description: Segment by interaction with an Automation workflow. example: automation op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.' example: started value: type: string title: Segment Data description: The web id for the automation workflow to segment against. example: '2135217' - type: object title: Poll Activity Segment description: Segment by poll activity. required: - field - op - value properties: condition_type: type: string x-value: CampaignPoll enum: - CampaignPoll field: type: string enum: - poll title: Segment Field description: Segment by poll activity. example: poll op: type: string enum: - member - notmember title: Segment Operator description: Members have/have not interacted with a specific poll in a Mailchimp email. example: member value: type: number title: Segment Operator description: The id for the poll. example: 409 - type: object title: Conversation Segment description: Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: Segment by interaction with a campaign via Conversations. example: conversation op: type: string enum: - member - notmember title: Segment Operator description: 'The status of a member''s interaction with a conversation. One of the following: has replied or has not replied.' example: member value: type: string title: Segment Data description: The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Date Segment description: Segment by a specific date field. required: - field - op - value properties: condition_type: type: string x-value: Date enum: - Date field: type: string enum: - timestamp_opt - info_changed - ecomm_date title: Segment Field description: 'The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.' example: timestamp_opt op: type: string enum: - greater - less - is - not - blank - blank_not - within - notwithin title: Segment Operator description: 'When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.' example: greater value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: date extra: type: string title: Segment Extra Value description: When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign. example: '2015-01-30' - type: object title: Email Client Segment description: Segment by use of a particular email client. required: - field - op - value properties: condition_type: type: string x-value: EmailClient enum: - EmailClient field: type: string enum: - email_client title: Segment Field description: Segment by use of a particular email client. example: email_client op: type: string enum: - client_is - client_not title: Segment Operator description: The operation to determine whether we select clients that match the value, or clients that do not match the value. example: client_is value: type: string title: Segment Data description: The name of the email client. example: Gmail - type: object title: Language Segment description: Segment by language. required: - field - op - value properties: condition_type: type: string x-value: Language enum: - Language field: type: string enum: - language title: Segment Field description: Segmenting based off of a subscriber's language. example: language op: type: string enum: - is - not title: Segment Operator description: Whether the member's language is or is not set to a specific language. example: is value: type: string title: Segment Data description: A two-letter language identifier. example: en - type: object title: Member Rating Segment description: Segment by member rating. required: - field - op - value properties: condition_type: type: string x-value: MemberRating enum: - MemberRating field: type: string enum: - rating title: Segment Field description: Segment by member rating. example: rating op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number. example: greater value: type: number title: Segment Operator description: The star rating number to segment against. example: 4 - type: object title: Signup Source Segment description: Segment by signup source. required: - field - condition_type - op properties: condition_type: type: string enum: - SignupSource x-value: SignupSource title: Type field: type: string enum: - source title: Segment Field example: source op: type: string enum: - source_is - source_not title: Segment Operator description: Whether the member's signup source was/was not a particular value. example: source_is value: type: string title: Segment Data description: The signup source. example: List Import - type: object title: Survey Monkey Segment description: Segment by interaction with a SurveyMonkey survey. required: - field - op - value properties: condition_type: type: string x-value: SurveyMonkey enum: - SurveyMonkey field: type: string enum: - survey_monkey title: Segment Field description: Segment by interaction with a SurveyMonkey survey. example: survey_monkey op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.' example: started value: type: string title: Survey ID description: The unique ID of the survey monkey survey. example: '32179586' - type: object title: VIP Segment description: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by VIP status. example: gmonkey op: type: string enum: - member - notmember title: Segment Operator description: Whether the member is or is not marked as VIP. example: member - type: object title: Interests Segment description: Segment by an interest group merge field. properties: condition_type: type: string x-value: Interests enum: - Interests field: type: string title: Segment Field description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 op: type: string enum: - interestcontains - interestcontainsall - interestnotcontains title: Segment Operator description: Whether the member is a part of one, all, or none of the groups. example: interestcontains value: type: array title: Segment Value description: An array containing strings, each representing a group id. items: type: string example: - '44401' - '44405' - '44409' - type: object title: Ecommerce Category Segment description: Segment by purchases in specific items or categories. properties: condition_type: type: string x-value: EcommCategory enum: - EcommCategory field: type: string enum: - ecomm_cat - ecomm_prod title: Segment Field description: Segment by purchases in specific items or categories. example: ecomm_cat op: type: string enum: - is - not - contains - notcontain - starts - ends title: Segment Operator description: A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string. example: is value: type: string title: Segment Data description: The ecommerce category/item information. example: Product - type: object title: Ecommerce Number Segment description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. required: - field - op - value properties: condition_type: type: string x-value: EcommNumber enum: - EcommNumber field: type: string enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord title: Segment Field description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. example: ecomm_orders op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. example: greater value: type: number title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 - type: object title: Ecommerce Purchased Segment description: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: Segment by whether someone has purchased anything. example: ecomm_purchased op: type: string enum: - member - notmember title: Segment Operator description: Members who have have ('member') or have not ('notmember') purchased. example: member - type: object title: Ecommerce Spent Segment description: Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: Segment by amount spent on a single order or across all orders. example: ecomm_spent_one op: type: string enum: - greater - less title: Segment Operator description: Members who have spent 'more' or 'less' than then specified value. example: greater value: type: integer title: Segment Data description: The total amount a member spent. example: 42 - type: object title: Ecommerce Purchased Store Segment description: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases from a specific store. example: ecomm_store op: type: string enum: - is - not title: Segment Operator description: Members who have or have not purchased from a specific store. example: is value: type: string title: Segment Operator description: The store id to segment against. example: '289' - type: object title: Goal Activity Segment description: Segment by Goal activity. required: - field - op - value properties: condition_type: type: string x-value: GoalActivity enum: - GoalActivity field: type: string enum: - goal title: Segment Field description: Segment by Goal activity. example: goal op: type: string enum: - is - goal_not - contains - goal_notcontain - starts - ends title: Segment Operator description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. example: is value: type: string title: Segment Value description: The URL to check Goal activity against. - type: object title: Goal Timestamp Segment description: Segment by most recent interaction with a website. required: - field - op - value properties: condition_type: type: string x-value: GoalTimestamp enum: - GoalTimestamp field: type: string enum: - goal_last_visited title: Segment Field description: Segment by most recent interaction with a website. example: goal_last_visited op: type: string enum: - greater - less - is title: Segment Operator description: Whether the website activity happened after, before, or at a given timestamp. example: greater value: type: string title: Segment Value description: The date to check Goal activity against. example: '2015-07-20 19:45:21' - type: object title: Similar Subscribers Segment Member Segment description: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. example: fuzzy_segment op: type: string enum: - fuzzy_is - fuzzy_not title: Segment Operator description: Members who are/are not apart of a 'similar subscribers' segment. example: fuzzy_is value: type: number title: Segment Operator description: The id for the 'similar subscribers' segment. example: 48433 - type: object title: Static Segment Member Segment description: Segment by a given static segment. required: - field - op - value properties: condition_type: type: string x-value: StaticSegment enum: - StaticSegment field: type: string enum: - static_segment title: Segment Field description: Segment by a given static segment. example: static_segment op: type: string enum: - static_is - static_not title: Segment Operator description: Members who are/are not apart of a static segment. example: static_is value: type: number title: Segment Operator description: The id for the static segment. example: 48433 - type: object title: Location-Based Segment description: Segment by a specific country or US state. required: - field - op - value properties: condition_type: type: string x-value: IPGeoCountryState enum: - IPGeoCountryState field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate title: Segment Operator description: Segment members who are within a specific country or US state. example: ipgeocountry value: type: string title: Segment Data description: The two-letter country code or US state abbreviation. example: US - type: object title: Geolocation Segment description: Segment by a specific geographic region. required: - field - op - value - addr - lat - lng properties: condition_type: type: string x-value: IPGeoIn enum: - IPGeoIn field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoin - ipgeonotin title: Segment Operator description: Segment members who are within a specific geographic region. example: ipgeoin value: type: integer title: Segment Data description: The radius of the target location. example: 42 addr: type: string title: Segment Location Address description: The address of the target location. example: Atlanta, GA, USA lat: type: string title: Segment Location Latitude description: The latitude of the target location. example: '33.7489954' lng: type: string title: Segment Location Longitude description: The longitude of the target location. example: '-84.3879824' - type: object title: US Zip Code Segment description: Segment by a specific US ZIP code. required: - field - op - value - extra properties: condition_type: type: string x-value: IPGeoInZip enum: - IPGeoInZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoinzip title: Segment Operator description: Segment members who are within a specific US zip code. example: ipgeoinzip value: type: integer title: Segment Data description: The radius of the target location. example: 25 extra: type: integer title: Extra Data description: The zip code to segment against. example: 30318 - type: object title: Unknown Location-Based Segment description: Segment members whose location information is unknown. required: - field - op properties: condition_type: type: string x-value: IPGeoUnknown enum: - IPGeoUnknown field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeounknown title: Segment Operator description: Segment members for which location information is unknown. example: ipgeounknown - type: object title: Zip Code Location-Based Segment description: Segment by a specific US ZIP code. required: - field - op - value properties: condition_type: type: string x-value: IPGeoZip enum: - IPGeoZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoiszip - ipgeonotzip title: Segment Operator description: Segment members who are/are not within a specific US zip code. example: ipgeonotzip value: type: integer title: Segment Data description: The 5-digit zip code. example: 30318 - type: object title: Social Profiles Age Segment description: Segment by age ranges in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialAge enum: - SocialAge field: type: string enum: - social_age title: Segment Field description: Segment by age ranges in Social Profiles data. example: social_age op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-54 - 55+ title: Segment Operator description: The age range to segment. example: 35-54 - type: object title: Social Profiles Gender Segment description: Segment by listed gender in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialGender enum: - SocialGender field: type: string enum: - social_gender title: Segment Field description: Segment by listed gender in Social Profiles data. example: social_gender op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The Social Profiles gender to segment. example: female - type: object title: Social Profiles Influence Segment description: Segment by influence rating in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialInfluence enum: - SocialInfluence field: type: string enum: - social_influence title: Segment Field description: Segment by influence rating in Social Profiles data. example: social_influence op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have a rating that is/not or greater/less than the rating provided. example: greater value: type: number title: Segment Operator description: The Social Profiles influence rating to segment. example: 2 - type: object title: Social Profiles Social Network Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkMember enum: - SocialNetworkMember field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - member - notmember title: Segment Operator description: Members who are/not on a given social network. example: member value: type: string enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube title: Segment Operator description: The social network to segment against. example: twitter - type: object title: Social Profiles Social Network Follow Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkFollow enum: - SocialNetworkFollow field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - follow - notfollow title: Segment Operator description: Members who are/not following a linked account on a given social network. example: follow value: type: string enum: - twitter_follow title: Segment Operator description: The social network to segment against. example: twitter_follow - type: object title: Address Merge Field Segment description: Segment by an address-type merge field. required: - field - op properties: condition_type: type: string x-value: AddressMerge enum: - AddressMerge field: type: string title: Segment Field description: An address-type merge field to segment. example: MMERGE3 op: type: string enum: - contains - notcontain - blank - blank_not title: Segment Operator description: Whether the member's address merge field contains/does not contain a value or is/is not blank. example: contains value: type: string title: Segment Value description: The value to segment a text merge field with. example: Atlanta - type: object title: Address/Zip Merge Field Segment description: Segment by an address-type merge field within a given distance. required: - field - op - value - extra properties: condition_type: type: string x-value: ZipMerge enum: - ZipMerge field: type: string title: Segment Field description: An address or zip-type merge field to segment. example: MMERGE2 op: type: string enum: - geoin title: Segment Operator description: Whether the member's address merge field is within a given distance from a city or zip. example: geoin value: type: string title: Segment Value description: The distance from the city/zip. example: '25' extra: type: string title: Segment Extra description: The city or the zip being used to segment against. example: '30318' - type: object title: Birthday Merge Field Segment description: Segment by a contact's birthday. required: - field - op properties: condition_type: type: string x-value: BirthdayMerge enum: - BirthdayMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE4 op: type: string enum: - is - not - blank - blank_not title: Segment Operator description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against (mm/dd). example: 01/30 - type: object title: Date Merge Field Segment description: Segment by a given date merge field. required: - field - op properties: condition_type: type: string x-value: DateMerge enum: - DateMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE5 op: type: string enum: - is - not - less - blank - blank_not - greater title: Segment Operator description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against. example: 01/30/2015 - type: object title: Dropdown/Radio Merge Field Segment description: An individual segment condition required: - field - op properties: condition_type: type: string x-value: SelectMerge enum: - SelectMerge field: type: string title: Segment Field description: A merge field to segment. example: MMERGE6 op: type: string enum: - is - not - blank - blank_not - notcontain - contains title: Segment Operator description: Whether the member's merge information is/is not a value or is/is not blank. example: is value: type: string title: Segment Value description: The value to segment a text merge field with. example: Second Choice - type: object title: Text or Number Merge Field Segment description: Segment by a given text or number merge field. required: - field - op properties: condition_type: type: string x-value: TextMerge enum: - TextMerge field: type: string title: Segment Field description: A text or number merge field to segment. example: MMERGE7 op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not title: Segment Operator description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value example: contains value: type: string title: Segment Value description: The value to segment a text or number merge field with. example: Freddie's Jokes - type: object title: Email Segment description: Segment by email address. required: - field - op properties: condition_type: type: string x-value: EmailAddress enum: - EmailAddress field: type: string enum: - merge0 - EMAIL title: Segment Field description: Segmenting based off of a subscriber's email address. example: EMAIL op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. value: type: string title: Segment Value description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com - type: object title: Predicted Gender Segment description: Segment by predicted gender. required: - field - op - value properties: condition_type: type: string x-value: PredictedGender enum: - PredictedGender field: type: string enum: - predicted_gender title: Segment Field description: Segment by predicted gender. op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The predicted gender to segment. example: female - type: object title: Predicted Age Segment description: Segment by predicted age. required: - field - op - value properties: condition_type: type: string x-value: PredictedAge enum: - PredictedAge field: type: string enum: - predicted_age_range title: Segment Field description: Segment by predicted age. op: type: string enum: - is title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ title: Segment Operator description: The predicted age to segment. example: female - type: object title: New Subscribers Prebuilt Segment description: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. op: type: string enum: - date_within title: Segment Operator description: Whe the event took place, namely within a time frame. value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Lists description: An array of objects, each representing a list segment. list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: list_segments methodNameCamel: listSegments x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Segment description: Create a new segment in a specific list. operationId: postListsIdSegments parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: List description: Information about a specific list segment. required: - name properties: name: type: string title: Segment Name description: The name of the segment. static_segment: type: array title: Static Segment description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field. items: type: string options: type: object title: Conditions description: The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions. properties: match: type: string title: Match description: Match type. enum: - any - all conditions: type: array title: Segment Type description: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas). items: x-discriminator: type: string propertyName: condition_type x-oneOf: - type: object title: Aim Segment description: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. example: aim op: type: string enum: - open - click - sent - noopen - noclick - nosent title: Segment Operator description: 'The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn''t open, didn''t click, or was not sent.' example: open value: type: string title: Segment Data description: Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Automation Segment description: Segment by interaction with an Automation workflow. required: - field - op - value properties: condition_type: type: string x-value: Automation enum: - Automation field: type: string enum: - automation title: Segment Field description: Segment by interaction with an Automation workflow. example: automation op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.' example: started value: type: string title: Segment Data description: The web id for the automation workflow to segment against. example: '2135217' - type: object title: Poll Activity Segment description: Segment by poll activity. required: - field - op - value properties: condition_type: type: string x-value: CampaignPoll enum: - CampaignPoll field: type: string enum: - poll title: Segment Field description: Segment by poll activity. example: poll op: type: string enum: - member - notmember title: Segment Operator description: Members have/have not interacted with a specific poll in a Mailchimp email. example: member value: type: number title: Segment Operator description: The id for the poll. example: 409 - type: object title: Conversation Segment description: Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: Segment by interaction with a campaign via Conversations. example: conversation op: type: string enum: - member - notmember title: Segment Operator description: 'The status of a member''s interaction with a conversation. One of the following: has replied or has not replied.' example: member value: type: string title: Segment Data description: The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Date Segment description: Segment by a specific date field. required: - field - op - value properties: condition_type: type: string x-value: Date enum: - Date field: type: string enum: - timestamp_opt - info_changed - ecomm_date title: Segment Field description: 'The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.' example: timestamp_opt op: type: string enum: - greater - less - is - not - blank - blank_not - within - notwithin title: Segment Operator description: 'When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.' example: greater value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: date extra: type: string title: Segment Extra Value description: When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign. example: '2015-01-30' - type: object title: Email Client Segment description: Segment by use of a particular email client. required: - field - op - value properties: condition_type: type: string x-value: EmailClient enum: - EmailClient field: type: string enum: - email_client title: Segment Field description: Segment by use of a particular email client. example: email_client op: type: string enum: - client_is - client_not title: Segment Operator description: The operation to determine whether we select clients that match the value, or clients that do not match the value. example: client_is value: type: string title: Segment Data description: The name of the email client. example: Gmail - type: object title: Language Segment description: Segment by language. required: - field - op - value properties: condition_type: type: string x-value: Language enum: - Language field: type: string enum: - language title: Segment Field description: Segmenting based off of a subscriber's language. example: language op: type: string enum: - is - not title: Segment Operator description: Whether the member's language is or is not set to a specific language. example: is value: type: string title: Segment Data description: A two-letter language identifier. example: en - type: object title: Member Rating Segment description: Segment by member rating. required: - field - op - value properties: condition_type: type: string x-value: MemberRating enum: - MemberRating field: type: string enum: - rating title: Segment Field description: Segment by member rating. example: rating op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number. example: greater value: type: number title: Segment Operator description: The star rating number to segment against. example: 4 - type: object title: Signup Source Segment description: Segment by signup source. required: - field - condition_type - op properties: condition_type: type: string enum: - SignupSource x-value: SignupSource title: Type field: type: string enum: - source title: Segment Field example: source op: type: string enum: - source_is - source_not title: Segment Operator description: Whether the member's signup source was/was not a particular value. example: source_is value: type: string title: Segment Data description: The signup source. example: List Import - type: object title: Survey Monkey Segment description: Segment by interaction with a SurveyMonkey survey. required: - field - op - value properties: condition_type: type: string x-value: SurveyMonkey enum: - SurveyMonkey field: type: string enum: - survey_monkey title: Segment Field description: Segment by interaction with a SurveyMonkey survey. example: survey_monkey op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.' example: started value: type: string title: Survey ID description: The unique ID of the survey monkey survey. example: '32179586' - type: object title: VIP Segment description: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by VIP status. example: gmonkey op: type: string enum: - member - notmember title: Segment Operator description: Whether the member is or is not marked as VIP. example: member - type: object title: Interests Segment description: Segment by an interest group merge field. properties: condition_type: type: string x-value: Interests enum: - Interests field: type: string title: Segment Field description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 op: type: string enum: - interestcontains - interestcontainsall - interestnotcontains title: Segment Operator description: Whether the member is a part of one, all, or none of the groups. example: interestcontains value: type: array title: Segment Value description: An array containing strings, each representing a group id. items: type: string example: - '44401' - '44405' - '44409' - type: object title: Ecommerce Category Segment description: Segment by purchases in specific items or categories. properties: condition_type: type: string x-value: EcommCategory enum: - EcommCategory field: type: string enum: - ecomm_cat - ecomm_prod title: Segment Field description: Segment by purchases in specific items or categories. example: ecomm_cat op: type: string enum: - is - not - contains - notcontain - starts - ends title: Segment Operator description: A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string. example: is value: type: string title: Segment Data description: The ecommerce category/item information. example: Product - type: object title: Ecommerce Number Segment description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. required: - field - op - value properties: condition_type: type: string x-value: EcommNumber enum: - EcommNumber field: type: string enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord title: Segment Field description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. example: ecomm_orders op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. example: greater value: type: number title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 - type: object title: Ecommerce Purchased Segment description: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: Segment by whether someone has purchased anything. example: ecomm_purchased op: type: string enum: - member - notmember title: Segment Operator description: Members who have have ('member') or have not ('notmember') purchased. example: member - type: object title: Ecommerce Spent Segment description: Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: Segment by amount spent on a single order or across all orders. example: ecomm_spent_one op: type: string enum: - greater - less title: Segment Operator description: Members who have spent 'more' or 'less' than then specified value. example: greater value: type: integer title: Segment Data description: The total amount a member spent. example: 42 - type: object title: Ecommerce Purchased Store Segment description: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases from a specific store. example: ecomm_store op: type: string enum: - is - not title: Segment Operator description: Members who have or have not purchased from a specific store. example: is value: type: string title: Segment Operator description: The store id to segment against. example: '289' - type: object title: Goal Activity Segment description: Segment by Goal activity. required: - field - op - value properties: condition_type: type: string x-value: GoalActivity enum: - GoalActivity field: type: string enum: - goal title: Segment Field description: Segment by Goal activity. example: goal op: type: string enum: - is - goal_not - contains - goal_notcontain - starts - ends title: Segment Operator description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. example: is value: type: string title: Segment Value description: The URL to check Goal activity against. - type: object title: Goal Timestamp Segment description: Segment by most recent interaction with a website. required: - field - op - value properties: condition_type: type: string x-value: GoalTimestamp enum: - GoalTimestamp field: type: string enum: - goal_last_visited title: Segment Field description: Segment by most recent interaction with a website. example: goal_last_visited op: type: string enum: - greater - less - is title: Segment Operator description: Whether the website activity happened after, before, or at a given timestamp. example: greater value: type: string title: Segment Value description: The date to check Goal activity against. example: '2015-07-20 19:45:21' - type: object title: Similar Subscribers Segment Member Segment description: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. example: fuzzy_segment op: type: string enum: - fuzzy_is - fuzzy_not title: Segment Operator description: Members who are/are not apart of a 'similar subscribers' segment. example: fuzzy_is value: type: number title: Segment Operator description: The id for the 'similar subscribers' segment. example: 48433 - type: object title: Static Segment Member Segment description: Segment by a given static segment. required: - field - op - value properties: condition_type: type: string x-value: StaticSegment enum: - StaticSegment field: type: string enum: - static_segment title: Segment Field description: Segment by a given static segment. example: static_segment op: type: string enum: - static_is - static_not title: Segment Operator description: Members who are/are not apart of a static segment. example: static_is value: type: number title: Segment Operator description: The id for the static segment. example: 48433 - type: object title: Location-Based Segment description: Segment by a specific country or US state. required: - field - op - value properties: condition_type: type: string x-value: IPGeoCountryState enum: - IPGeoCountryState field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate title: Segment Operator description: Segment members who are within a specific country or US state. example: ipgeocountry value: type: string title: Segment Data description: The two-letter country code or US state abbreviation. example: US - type: object title: Geolocation Segment description: Segment by a specific geographic region. required: - field - op - value - addr - lat - lng properties: condition_type: type: string x-value: IPGeoIn enum: - IPGeoIn field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoin - ipgeonotin title: Segment Operator description: Segment members who are within a specific geographic region. example: ipgeoin value: type: integer title: Segment Data description: The radius of the target location. example: 42 addr: type: string title: Segment Location Address description: The address of the target location. example: Atlanta, GA, USA lat: type: string title: Segment Location Latitude description: The latitude of the target location. example: '33.7489954' lng: type: string title: Segment Location Longitude description: The longitude of the target location. example: '-84.3879824' - type: object title: US Zip Code Segment description: Segment by a specific US ZIP code. required: - field - op - value - extra properties: condition_type: type: string x-value: IPGeoInZip enum: - IPGeoInZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoinzip title: Segment Operator description: Segment members who are within a specific US zip code. example: ipgeoinzip value: type: integer title: Segment Data description: The radius of the target location. example: 25 extra: type: integer title: Extra Data description: The zip code to segment against. example: 30318 - type: object title: Unknown Location-Based Segment description: Segment members whose location information is unknown. required: - field - op properties: condition_type: type: string x-value: IPGeoUnknown enum: - IPGeoUnknown field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeounknown title: Segment Operator description: Segment members for which location information is unknown. example: ipgeounknown - type: object title: Zip Code Location-Based Segment description: Segment by a specific US ZIP code. required: - field - op - value properties: condition_type: type: string x-value: IPGeoZip enum: - IPGeoZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoiszip - ipgeonotzip title: Segment Operator description: Segment members who are/are not within a specific US zip code. example: ipgeonotzip value: type: integer title: Segment Data description: The 5-digit zip code. example: 30318 - type: object title: Social Profiles Age Segment description: Segment by age ranges in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialAge enum: - SocialAge field: type: string enum: - social_age title: Segment Field description: Segment by age ranges in Social Profiles data. example: social_age op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-54 - 55+ title: Segment Operator description: The age range to segment. example: 35-54 - type: object title: Social Profiles Gender Segment description: Segment by listed gender in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialGender enum: - SocialGender field: type: string enum: - social_gender title: Segment Field description: Segment by listed gender in Social Profiles data. example: social_gender op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The Social Profiles gender to segment. example: female - type: object title: Social Profiles Influence Segment description: Segment by influence rating in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialInfluence enum: - SocialInfluence field: type: string enum: - social_influence title: Segment Field description: Segment by influence rating in Social Profiles data. example: social_influence op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have a rating that is/not or greater/less than the rating provided. example: greater value: type: number title: Segment Operator description: The Social Profiles influence rating to segment. example: 2 - type: object title: Social Profiles Social Network Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkMember enum: - SocialNetworkMember field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - member - notmember title: Segment Operator description: Members who are/not on a given social network. example: member value: type: string enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube title: Segment Operator description: The social network to segment against. example: twitter - type: object title: Social Profiles Social Network Follow Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkFollow enum: - SocialNetworkFollow field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - follow - notfollow title: Segment Operator description: Members who are/not following a linked account on a given social network. example: follow value: type: string enum: - twitter_follow title: Segment Operator description: The social network to segment against. example: twitter_follow - type: object title: Address Merge Field Segment description: Segment by an address-type merge field. required: - field - op properties: condition_type: type: string x-value: AddressMerge enum: - AddressMerge field: type: string title: Segment Field description: An address-type merge field to segment. example: MMERGE3 op: type: string enum: - contains - notcontain - blank - blank_not title: Segment Operator description: Whether the member's address merge field contains/does not contain a value or is/is not blank. example: contains value: type: string title: Segment Value description: The value to segment a text merge field with. example: Atlanta - type: object title: Address/Zip Merge Field Segment description: Segment by an address-type merge field within a given distance. required: - field - op - value - extra properties: condition_type: type: string x-value: ZipMerge enum: - ZipMerge field: type: string title: Segment Field description: An address or zip-type merge field to segment. example: MMERGE2 op: type: string enum: - geoin title: Segment Operator description: Whether the member's address merge field is within a given distance from a city or zip. example: geoin value: type: string title: Segment Value description: The distance from the city/zip. example: '25' extra: type: string title: Segment Extra description: The city or the zip being used to segment against. example: '30318' - type: object title: Birthday Merge Field Segment description: Segment by a contact's birthday. required: - field - op properties: condition_type: type: string x-value: BirthdayMerge enum: - BirthdayMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE4 op: type: string enum: - is - not - blank - blank_not title: Segment Operator description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against (mm/dd). example: 01/30 - type: object title: Date Merge Field Segment description: Segment by a given date merge field. required: - field - op properties: condition_type: type: string x-value: DateMerge enum: - DateMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE5 op: type: string enum: - is - not - less - blank - blank_not - greater title: Segment Operator description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against. example: 01/30/2015 - type: object title: Dropdown/Radio Merge Field Segment description: An individual segment condition required: - field - op properties: condition_type: type: string x-value: SelectMerge enum: - SelectMerge field: type: string title: Segment Field description: A merge field to segment. example: MMERGE6 op: type: string enum: - is - not - blank - blank_not - notcontain - contains title: Segment Operator description: Whether the member's merge information is/is not a value or is/is not blank. example: is value: type: string title: Segment Value description: The value to segment a text merge field with. example: Second Choice - type: object title: Text or Number Merge Field Segment description: Segment by a given text or number merge field. required: - field - op properties: condition_type: type: string x-value: TextMerge enum: - TextMerge field: type: string title: Segment Field description: A text or number merge field to segment. example: MMERGE7 op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not title: Segment Operator description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value example: contains value: type: string title: Segment Value description: The value to segment a text or number merge field with. example: Freddie's Jokes - type: object title: Email Segment description: Segment by email address. required: - field - op properties: condition_type: type: string x-value: EmailAddress enum: - EmailAddress field: type: string enum: - merge0 - EMAIL title: Segment Field description: Segmenting based off of a subscriber's email address. example: EMAIL op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. value: type: string title: Segment Value description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com - type: object title: Predicted Gender Segment description: Segment by predicted gender. required: - field - op - value properties: condition_type: type: string x-value: PredictedGender enum: - PredictedGender field: type: string enum: - predicted_gender title: Segment Field description: Segment by predicted gender. op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The predicted gender to segment. example: female - type: object title: Predicted Age Segment description: Segment by predicted age. required: - field - op - value properties: condition_type: type: string x-value: PredictedAge enum: - PredictedAge field: type: string enum: - predicted_age_range title: Segment Field description: Segment by predicted age. op: type: string enum: - is title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ title: Segment Operator description: The predicted age to segment. example: female - type: object title: New Subscribers Prebuilt Segment description: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. op: type: string enum: - date_within title: Segment Operator description: Whe the event took place, namely within a time frame. value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: example_value responses: '200': description: '' schema: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: Match type. enum: - any - all conditions: type: array title: Segment Type description: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas). items: x-discriminator: type: string propertyName: condition_type x-oneOf: - type: object title: Aim Segment description: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. example: aim op: type: string enum: - open - click - sent - noopen - noclick - nosent title: Segment Operator description: 'The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn''t open, didn''t click, or was not sent.' example: open value: type: string title: Segment Data description: Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Automation Segment description: Segment by interaction with an Automation workflow. required: - field - op - value properties: condition_type: type: string x-value: Automation enum: - Automation field: type: string enum: - automation title: Segment Field description: Segment by interaction with an Automation workflow. example: automation op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.' example: started value: type: string title: Segment Data description: The web id for the automation workflow to segment against. example: '2135217' - type: object title: Poll Activity Segment description: Segment by poll activity. required: - field - op - value properties: condition_type: type: string x-value: CampaignPoll enum: - CampaignPoll field: type: string enum: - poll title: Segment Field description: Segment by poll activity. example: poll op: type: string enum: - member - notmember title: Segment Operator description: Members have/have not interacted with a specific poll in a Mailchimp email. example: member value: type: number title: Segment Operator description: The id for the poll. example: 409 - type: object title: Conversation Segment description: Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: Segment by interaction with a campaign via Conversations. example: conversation op: type: string enum: - member - notmember title: Segment Operator description: 'The status of a member''s interaction with a conversation. One of the following: has replied or has not replied.' example: member value: type: string title: Segment Data description: The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Date Segment description: Segment by a specific date field. required: - field - op - value properties: condition_type: type: string x-value: Date enum: - Date field: type: string enum: - timestamp_opt - info_changed - ecomm_date title: Segment Field description: 'The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.' example: timestamp_opt op: type: string enum: - greater - less - is - not - blank - blank_not - within - notwithin title: Segment Operator description: 'When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.' example: greater value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: date extra: type: string title: Segment Extra Value description: When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign. example: '2015-01-30' - type: object title: Email Client Segment description: Segment by use of a particular email client. required: - field - op - value properties: condition_type: type: string x-value: EmailClient enum: - EmailClient field: type: string enum: - email_client title: Segment Field description: Segment by use of a particular email client. example: email_client op: type: string enum: - client_is - client_not title: Segment Operator description: The operation to determine whether we select clients that match the value, or clients that do not match the value. example: client_is value: type: string title: Segment Data description: The name of the email client. example: Gmail - type: object title: Language Segment description: Segment by language. required: - field - op - value properties: condition_type: type: string x-value: Language enum: - Language field: type: string enum: - language title: Segment Field description: Segmenting based off of a subscriber's language. example: language op: type: string enum: - is - not title: Segment Operator description: Whether the member's language is or is not set to a specific language. example: is value: type: string title: Segment Data description: A two-letter language identifier. example: en - type: object title: Member Rating Segment description: Segment by member rating. required: - field - op - value properties: condition_type: type: string x-value: MemberRating enum: - MemberRating field: type: string enum: - rating title: Segment Field description: Segment by member rating. example: rating op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number. example: greater value: type: number title: Segment Operator description: The star rating number to segment against. example: 4 - type: object title: Signup Source Segment description: Segment by signup source. required: - field - condition_type - op properties: condition_type: type: string enum: - SignupSource x-value: SignupSource title: Type field: type: string enum: - source title: Segment Field example: source op: type: string enum: - source_is - source_not title: Segment Operator description: Whether the member's signup source was/was not a particular value. example: source_is value: type: string title: Segment Data description: The signup source. example: List Import - type: object title: Survey Monkey Segment description: Segment by interaction with a SurveyMonkey survey. required: - field - op - value properties: condition_type: type: string x-value: SurveyMonkey enum: - SurveyMonkey field: type: string enum: - survey_monkey title: Segment Field description: Segment by interaction with a SurveyMonkey survey. example: survey_monkey op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.' example: started value: type: string title: Survey ID description: The unique ID of the survey monkey survey. example: '32179586' - type: object title: VIP Segment description: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by VIP status. example: gmonkey op: type: string enum: - member - notmember title: Segment Operator description: Whether the member is or is not marked as VIP. example: member - type: object title: Interests Segment description: Segment by an interest group merge field. properties: condition_type: type: string x-value: Interests enum: - Interests field: type: string title: Segment Field description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 op: type: string enum: - interestcontains - interestcontainsall - interestnotcontains title: Segment Operator description: Whether the member is a part of one, all, or none of the groups. example: interestcontains value: type: array title: Segment Value description: An array containing strings, each representing a group id. items: type: string example: - '44401' - '44405' - '44409' - type: object title: Ecommerce Category Segment description: Segment by purchases in specific items or categories. properties: condition_type: type: string x-value: EcommCategory enum: - EcommCategory field: type: string enum: - ecomm_cat - ecomm_prod title: Segment Field description: Segment by purchases in specific items or categories. example: ecomm_cat op: type: string enum: - is - not - contains - notcontain - starts - ends title: Segment Operator description: A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string. example: is value: type: string title: Segment Data description: The ecommerce category/item information. example: Product - type: object title: Ecommerce Number Segment description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. required: - field - op - value properties: condition_type: type: string x-value: EcommNumber enum: - EcommNumber field: type: string enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord title: Segment Field description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. example: ecomm_orders op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. example: greater value: type: number title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 - type: object title: Ecommerce Purchased Segment description: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: Segment by whether someone has purchased anything. example: ecomm_purchased op: type: string enum: - member - notmember title: Segment Operator description: Members who have have ('member') or have not ('notmember') purchased. example: member - type: object title: Ecommerce Spent Segment description: Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: Segment by amount spent on a single order or across all orders. example: ecomm_spent_one op: type: string enum: - greater - less title: Segment Operator description: Members who have spent 'more' or 'less' than then specified value. example: greater value: type: integer title: Segment Data description: The total amount a member spent. example: 42 - type: object title: Ecommerce Purchased Store Segment description: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases from a specific store. example: ecomm_store op: type: string enum: - is - not title: Segment Operator description: Members who have or have not purchased from a specific store. example: is value: type: string title: Segment Operator description: The store id to segment against. example: '289' - type: object title: Goal Activity Segment description: Segment by Goal activity. required: - field - op - value properties: condition_type: type: string x-value: GoalActivity enum: - GoalActivity field: type: string enum: - goal title: Segment Field description: Segment by Goal activity. example: goal op: type: string enum: - is - goal_not - contains - goal_notcontain - starts - ends title: Segment Operator description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. example: is value: type: string title: Segment Value description: The URL to check Goal activity against. - type: object title: Goal Timestamp Segment description: Segment by most recent interaction with a website. required: - field - op - value properties: condition_type: type: string x-value: GoalTimestamp enum: - GoalTimestamp field: type: string enum: - goal_last_visited title: Segment Field description: Segment by most recent interaction with a website. example: goal_last_visited op: type: string enum: - greater - less - is title: Segment Operator description: Whether the website activity happened after, before, or at a given timestamp. example: greater value: type: string title: Segment Value description: The date to check Goal activity against. example: '2015-07-20 19:45:21' - type: object title: Similar Subscribers Segment Member Segment description: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. example: fuzzy_segment op: type: string enum: - fuzzy_is - fuzzy_not title: Segment Operator description: Members who are/are not apart of a 'similar subscribers' segment. example: fuzzy_is value: type: number title: Segment Operator description: The id for the 'similar subscribers' segment. example: 48433 - type: object title: Static Segment Member Segment description: Segment by a given static segment. required: - field - op - value properties: condition_type: type: string x-value: StaticSegment enum: - StaticSegment field: type: string enum: - static_segment title: Segment Field description: Segment by a given static segment. example: static_segment op: type: string enum: - static_is - static_not title: Segment Operator description: Members who are/are not apart of a static segment. example: static_is value: type: number title: Segment Operator description: The id for the static segment. example: 48433 - type: object title: Location-Based Segment description: Segment by a specific country or US state. required: - field - op - value properties: condition_type: type: string x-value: IPGeoCountryState enum: - IPGeoCountryState field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate title: Segment Operator description: Segment members who are within a specific country or US state. example: ipgeocountry value: type: string title: Segment Data description: The two-letter country code or US state abbreviation. example: US - type: object title: Geolocation Segment description: Segment by a specific geographic region. required: - field - op - value - addr - lat - lng properties: condition_type: type: string x-value: IPGeoIn enum: - IPGeoIn field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoin - ipgeonotin title: Segment Operator description: Segment members who are within a specific geographic region. example: ipgeoin value: type: integer title: Segment Data description: The radius of the target location. example: 42 addr: type: string title: Segment Location Address description: The address of the target location. example: Atlanta, GA, USA lat: type: string title: Segment Location Latitude description: The latitude of the target location. example: '33.7489954' lng: type: string title: Segment Location Longitude description: The longitude of the target location. example: '-84.3879824' - type: object title: US Zip Code Segment description: Segment by a specific US ZIP code. required: - field - op - value - extra properties: condition_type: type: string x-value: IPGeoInZip enum: - IPGeoInZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoinzip title: Segment Operator description: Segment members who are within a specific US zip code. example: ipgeoinzip value: type: integer title: Segment Data description: The radius of the target location. example: 25 extra: type: integer title: Extra Data description: The zip code to segment against. example: 30318 - type: object title: Unknown Location-Based Segment description: Segment members whose location information is unknown. required: - field - op properties: condition_type: type: string x-value: IPGeoUnknown enum: - IPGeoUnknown field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeounknown title: Segment Operator description: Segment members for which location information is unknown. example: ipgeounknown - type: object title: Zip Code Location-Based Segment description: Segment by a specific US ZIP code. required: - field - op - value properties: condition_type: type: string x-value: IPGeoZip enum: - IPGeoZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoiszip - ipgeonotzip title: Segment Operator description: Segment members who are/are not within a specific US zip code. example: ipgeonotzip value: type: integer title: Segment Data description: The 5-digit zip code. example: 30318 - type: object title: Social Profiles Age Segment description: Segment by age ranges in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialAge enum: - SocialAge field: type: string enum: - social_age title: Segment Field description: Segment by age ranges in Social Profiles data. example: social_age op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-54 - 55+ title: Segment Operator description: The age range to segment. example: 35-54 - type: object title: Social Profiles Gender Segment description: Segment by listed gender in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialGender enum: - SocialGender field: type: string enum: - social_gender title: Segment Field description: Segment by listed gender in Social Profiles data. example: social_gender op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The Social Profiles gender to segment. example: female - type: object title: Social Profiles Influence Segment description: Segment by influence rating in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialInfluence enum: - SocialInfluence field: type: string enum: - social_influence title: Segment Field description: Segment by influence rating in Social Profiles data. example: social_influence op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have a rating that is/not or greater/less than the rating provided. example: greater value: type: number title: Segment Operator description: The Social Profiles influence rating to segment. example: 2 - type: object title: Social Profiles Social Network Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkMember enum: - SocialNetworkMember field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - member - notmember title: Segment Operator description: Members who are/not on a given social network. example: member value: type: string enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube title: Segment Operator description: The social network to segment against. example: twitter - type: object title: Social Profiles Social Network Follow Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkFollow enum: - SocialNetworkFollow field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - follow - notfollow title: Segment Operator description: Members who are/not following a linked account on a given social network. example: follow value: type: string enum: - twitter_follow title: Segment Operator description: The social network to segment against. example: twitter_follow - type: object title: Address Merge Field Segment description: Segment by an address-type merge field. required: - field - op properties: condition_type: type: string x-value: AddressMerge enum: - AddressMerge field: type: string title: Segment Field description: An address-type merge field to segment. example: MMERGE3 op: type: string enum: - contains - notcontain - blank - blank_not title: Segment Operator description: Whether the member's address merge field contains/does not contain a value or is/is not blank. example: contains value: type: string title: Segment Value description: The value to segment a text merge field with. example: Atlanta - type: object title: Address/Zip Merge Field Segment description: Segment by an address-type merge field within a given distance. required: - field - op - value - extra properties: condition_type: type: string x-value: ZipMerge enum: - ZipMerge field: type: string title: Segment Field description: An address or zip-type merge field to segment. example: MMERGE2 op: type: string enum: - geoin title: Segment Operator description: Whether the member's address merge field is within a given distance from a city or zip. example: geoin value: type: string title: Segment Value description: The distance from the city/zip. example: '25' extra: type: string title: Segment Extra description: The city or the zip being used to segment against. example: '30318' - type: object title: Birthday Merge Field Segment description: Segment by a contact's birthday. required: - field - op properties: condition_type: type: string x-value: BirthdayMerge enum: - BirthdayMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE4 op: type: string enum: - is - not - blank - blank_not title: Segment Operator description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against (mm/dd). example: 01/30 - type: object title: Date Merge Field Segment description: Segment by a given date merge field. required: - field - op properties: condition_type: type: string x-value: DateMerge enum: - DateMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE5 op: type: string enum: - is - not - less - blank - blank_not - greater title: Segment Operator description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against. example: 01/30/2015 - type: object title: Dropdown/Radio Merge Field Segment description: An individual segment condition required: - field - op properties: condition_type: type: string x-value: SelectMerge enum: - SelectMerge field: type: string title: Segment Field description: A merge field to segment. example: MMERGE6 op: type: string enum: - is - not - blank - blank_not - notcontain - contains title: Segment Operator description: Whether the member's merge information is/is not a value or is/is not blank. example: is value: type: string title: Segment Value description: The value to segment a text merge field with. example: Second Choice - type: object title: Text or Number Merge Field Segment description: Segment by a given text or number merge field. required: - field - op properties: condition_type: type: string x-value: TextMerge enum: - TextMerge field: type: string title: Segment Field description: A text or number merge field to segment. example: MMERGE7 op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not title: Segment Operator description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value example: contains value: type: string title: Segment Value description: The value to segment a text or number merge field with. example: Freddie's Jokes - type: object title: Email Segment description: Segment by email address. required: - field - op properties: condition_type: type: string x-value: EmailAddress enum: - EmailAddress field: type: string enum: - merge0 - EMAIL title: Segment Field description: Segmenting based off of a subscriber's email address. example: EMAIL op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. value: type: string title: Segment Value description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com - type: object title: Predicted Gender Segment description: Segment by predicted gender. required: - field - op - value properties: condition_type: type: string x-value: PredictedGender enum: - PredictedGender field: type: string enum: - predicted_gender title: Segment Field description: Segment by predicted gender. op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The predicted gender to segment. example: female - type: object title: Predicted Age Segment description: Segment by predicted age. required: - field - op - value properties: condition_type: type: string x-value: PredictedAge enum: - PredictedAge field: type: string enum: - predicted_age_range title: Segment Field description: Segment by predicted age. op: type: string enum: - is title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ title: Segment Operator description: The predicted age to segment. example: female - type: object title: New Subscribers Prebuilt Segment description: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. op: type: string enum: - date_within title: Segment Operator description: Whe the event took place, namely within a time frame. value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: create_segment methodNameCamel: createSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments/{segment_id}: get: summary: Mailchimp Get Segment Info description: Get information about a specific segment. operationId: getListsIdSegmentsId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: include_cleaned in: query x-title: Include Cleaned description: Include cleaned members in response required: false type: boolean x-example: false example: example_value - name: include_transactional in: query x-title: Include Transactional description: Include transactional members in response required: false type: boolean x-example: false example: example_value - name: include_unsubscribed in: query x-title: Include Unsubscribed description: Include unsubscribed members in response required: false type: boolean x-example: false example: example_value responses: '200': description: '' schema: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: Match type. enum: - any - all conditions: type: array title: Segment Type description: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas). items: x-discriminator: type: string propertyName: condition_type x-oneOf: - type: object title: Aim Segment description: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. example: aim op: type: string enum: - open - click - sent - noopen - noclick - nosent title: Segment Operator description: 'The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn''t open, didn''t click, or was not sent.' example: open value: type: string title: Segment Data description: Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Automation Segment description: Segment by interaction with an Automation workflow. required: - field - op - value properties: condition_type: type: string x-value: Automation enum: - Automation field: type: string enum: - automation title: Segment Field description: Segment by interaction with an Automation workflow. example: automation op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.' example: started value: type: string title: Segment Data description: The web id for the automation workflow to segment against. example: '2135217' - type: object title: Poll Activity Segment description: Segment by poll activity. required: - field - op - value properties: condition_type: type: string x-value: CampaignPoll enum: - CampaignPoll field: type: string enum: - poll title: Segment Field description: Segment by poll activity. example: poll op: type: string enum: - member - notmember title: Segment Operator description: Members have/have not interacted with a specific poll in a Mailchimp email. example: member value: type: number title: Segment Operator description: The id for the poll. example: 409 - type: object title: Conversation Segment description: Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: Segment by interaction with a campaign via Conversations. example: conversation op: type: string enum: - member - notmember title: Segment Operator description: 'The status of a member''s interaction with a conversation. One of the following: has replied or has not replied.' example: member value: type: string title: Segment Data description: The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Date Segment description: Segment by a specific date field. required: - field - op - value properties: condition_type: type: string x-value: Date enum: - Date field: type: string enum: - timestamp_opt - info_changed - ecomm_date title: Segment Field description: 'The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.' example: timestamp_opt op: type: string enum: - greater - less - is - not - blank - blank_not - within - notwithin title: Segment Operator description: 'When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.' example: greater value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: date extra: type: string title: Segment Extra Value description: When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign. example: '2015-01-30' - type: object title: Email Client Segment description: Segment by use of a particular email client. required: - field - op - value properties: condition_type: type: string x-value: EmailClient enum: - EmailClient field: type: string enum: - email_client title: Segment Field description: Segment by use of a particular email client. example: email_client op: type: string enum: - client_is - client_not title: Segment Operator description: The operation to determine whether we select clients that match the value, or clients that do not match the value. example: client_is value: type: string title: Segment Data description: The name of the email client. example: Gmail - type: object title: Language Segment description: Segment by language. required: - field - op - value properties: condition_type: type: string x-value: Language enum: - Language field: type: string enum: - language title: Segment Field description: Segmenting based off of a subscriber's language. example: language op: type: string enum: - is - not title: Segment Operator description: Whether the member's language is or is not set to a specific language. example: is value: type: string title: Segment Data description: A two-letter language identifier. example: en - type: object title: Member Rating Segment description: Segment by member rating. required: - field - op - value properties: condition_type: type: string x-value: MemberRating enum: - MemberRating field: type: string enum: - rating title: Segment Field description: Segment by member rating. example: rating op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number. example: greater value: type: number title: Segment Operator description: The star rating number to segment against. example: 4 - type: object title: Signup Source Segment description: Segment by signup source. required: - field - condition_type - op properties: condition_type: type: string enum: - SignupSource x-value: SignupSource title: Type field: type: string enum: - source title: Segment Field example: source op: type: string enum: - source_is - source_not title: Segment Operator description: Whether the member's signup source was/was not a particular value. example: source_is value: type: string title: Segment Data description: The signup source. example: List Import - type: object title: Survey Monkey Segment description: Segment by interaction with a SurveyMonkey survey. required: - field - op - value properties: condition_type: type: string x-value: SurveyMonkey enum: - SurveyMonkey field: type: string enum: - survey_monkey title: Segment Field description: Segment by interaction with a SurveyMonkey survey. example: survey_monkey op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.' example: started value: type: string title: Survey ID description: The unique ID of the survey monkey survey. example: '32179586' - type: object title: VIP Segment description: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by VIP status. example: gmonkey op: type: string enum: - member - notmember title: Segment Operator description: Whether the member is or is not marked as VIP. example: member - type: object title: Interests Segment description: Segment by an interest group merge field. properties: condition_type: type: string x-value: Interests enum: - Interests field: type: string title: Segment Field description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 op: type: string enum: - interestcontains - interestcontainsall - interestnotcontains title: Segment Operator description: Whether the member is a part of one, all, or none of the groups. example: interestcontains value: type: array title: Segment Value description: An array containing strings, each representing a group id. items: type: string example: - '44401' - '44405' - '44409' - type: object title: Ecommerce Category Segment description: Segment by purchases in specific items or categories. properties: condition_type: type: string x-value: EcommCategory enum: - EcommCategory field: type: string enum: - ecomm_cat - ecomm_prod title: Segment Field description: Segment by purchases in specific items or categories. example: ecomm_cat op: type: string enum: - is - not - contains - notcontain - starts - ends title: Segment Operator description: A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string. example: is value: type: string title: Segment Data description: The ecommerce category/item information. example: Product - type: object title: Ecommerce Number Segment description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. required: - field - op - value properties: condition_type: type: string x-value: EcommNumber enum: - EcommNumber field: type: string enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord title: Segment Field description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. example: ecomm_orders op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. example: greater value: type: number title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 - type: object title: Ecommerce Purchased Segment description: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: Segment by whether someone has purchased anything. example: ecomm_purchased op: type: string enum: - member - notmember title: Segment Operator description: Members who have have ('member') or have not ('notmember') purchased. example: member - type: object title: Ecommerce Spent Segment description: Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: Segment by amount spent on a single order or across all orders. example: ecomm_spent_one op: type: string enum: - greater - less title: Segment Operator description: Members who have spent 'more' or 'less' than then specified value. example: greater value: type: integer title: Segment Data description: The total amount a member spent. example: 42 - type: object title: Ecommerce Purchased Store Segment description: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases from a specific store. example: ecomm_store op: type: string enum: - is - not title: Segment Operator description: Members who have or have not purchased from a specific store. example: is value: type: string title: Segment Operator description: The store id to segment against. example: '289' - type: object title: Goal Activity Segment description: Segment by Goal activity. required: - field - op - value properties: condition_type: type: string x-value: GoalActivity enum: - GoalActivity field: type: string enum: - goal title: Segment Field description: Segment by Goal activity. example: goal op: type: string enum: - is - goal_not - contains - goal_notcontain - starts - ends title: Segment Operator description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. example: is value: type: string title: Segment Value description: The URL to check Goal activity against. - type: object title: Goal Timestamp Segment description: Segment by most recent interaction with a website. required: - field - op - value properties: condition_type: type: string x-value: GoalTimestamp enum: - GoalTimestamp field: type: string enum: - goal_last_visited title: Segment Field description: Segment by most recent interaction with a website. example: goal_last_visited op: type: string enum: - greater - less - is title: Segment Operator description: Whether the website activity happened after, before, or at a given timestamp. example: greater value: type: string title: Segment Value description: The date to check Goal activity against. example: '2015-07-20 19:45:21' - type: object title: Similar Subscribers Segment Member Segment description: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. example: fuzzy_segment op: type: string enum: - fuzzy_is - fuzzy_not title: Segment Operator description: Members who are/are not apart of a 'similar subscribers' segment. example: fuzzy_is value: type: number title: Segment Operator description: The id for the 'similar subscribers' segment. example: 48433 - type: object title: Static Segment Member Segment description: Segment by a given static segment. required: - field - op - value properties: condition_type: type: string x-value: StaticSegment enum: - StaticSegment field: type: string enum: - static_segment title: Segment Field description: Segment by a given static segment. example: static_segment op: type: string enum: - static_is - static_not title: Segment Operator description: Members who are/are not apart of a static segment. example: static_is value: type: number title: Segment Operator description: The id for the static segment. example: 48433 - type: object title: Location-Based Segment description: Segment by a specific country or US state. required: - field - op - value properties: condition_type: type: string x-value: IPGeoCountryState enum: - IPGeoCountryState field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate title: Segment Operator description: Segment members who are within a specific country or US state. example: ipgeocountry value: type: string title: Segment Data description: The two-letter country code or US state abbreviation. example: US - type: object title: Geolocation Segment description: Segment by a specific geographic region. required: - field - op - value - addr - lat - lng properties: condition_type: type: string x-value: IPGeoIn enum: - IPGeoIn field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoin - ipgeonotin title: Segment Operator description: Segment members who are within a specific geographic region. example: ipgeoin value: type: integer title: Segment Data description: The radius of the target location. example: 42 addr: type: string title: Segment Location Address description: The address of the target location. example: Atlanta, GA, USA lat: type: string title: Segment Location Latitude description: The latitude of the target location. example: '33.7489954' lng: type: string title: Segment Location Longitude description: The longitude of the target location. example: '-84.3879824' - type: object title: US Zip Code Segment description: Segment by a specific US ZIP code. required: - field - op - value - extra properties: condition_type: type: string x-value: IPGeoInZip enum: - IPGeoInZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoinzip title: Segment Operator description: Segment members who are within a specific US zip code. example: ipgeoinzip value: type: integer title: Segment Data description: The radius of the target location. example: 25 extra: type: integer title: Extra Data description: The zip code to segment against. example: 30318 - type: object title: Unknown Location-Based Segment description: Segment members whose location information is unknown. required: - field - op properties: condition_type: type: string x-value: IPGeoUnknown enum: - IPGeoUnknown field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeounknown title: Segment Operator description: Segment members for which location information is unknown. example: ipgeounknown - type: object title: Zip Code Location-Based Segment description: Segment by a specific US ZIP code. required: - field - op - value properties: condition_type: type: string x-value: IPGeoZip enum: - IPGeoZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoiszip - ipgeonotzip title: Segment Operator description: Segment members who are/are not within a specific US zip code. example: ipgeonotzip value: type: integer title: Segment Data description: The 5-digit zip code. example: 30318 - type: object title: Social Profiles Age Segment description: Segment by age ranges in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialAge enum: - SocialAge field: type: string enum: - social_age title: Segment Field description: Segment by age ranges in Social Profiles data. example: social_age op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-54 - 55+ title: Segment Operator description: The age range to segment. example: 35-54 - type: object title: Social Profiles Gender Segment description: Segment by listed gender in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialGender enum: - SocialGender field: type: string enum: - social_gender title: Segment Field description: Segment by listed gender in Social Profiles data. example: social_gender op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The Social Profiles gender to segment. example: female - type: object title: Social Profiles Influence Segment description: Segment by influence rating in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialInfluence enum: - SocialInfluence field: type: string enum: - social_influence title: Segment Field description: Segment by influence rating in Social Profiles data. example: social_influence op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have a rating that is/not or greater/less than the rating provided. example: greater value: type: number title: Segment Operator description: The Social Profiles influence rating to segment. example: 2 - type: object title: Social Profiles Social Network Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkMember enum: - SocialNetworkMember field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - member - notmember title: Segment Operator description: Members who are/not on a given social network. example: member value: type: string enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube title: Segment Operator description: The social network to segment against. example: twitter - type: object title: Social Profiles Social Network Follow Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkFollow enum: - SocialNetworkFollow field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - follow - notfollow title: Segment Operator description: Members who are/not following a linked account on a given social network. example: follow value: type: string enum: - twitter_follow title: Segment Operator description: The social network to segment against. example: twitter_follow - type: object title: Address Merge Field Segment description: Segment by an address-type merge field. required: - field - op properties: condition_type: type: string x-value: AddressMerge enum: - AddressMerge field: type: string title: Segment Field description: An address-type merge field to segment. example: MMERGE3 op: type: string enum: - contains - notcontain - blank - blank_not title: Segment Operator description: Whether the member's address merge field contains/does not contain a value or is/is not blank. example: contains value: type: string title: Segment Value description: The value to segment a text merge field with. example: Atlanta - type: object title: Address/Zip Merge Field Segment description: Segment by an address-type merge field within a given distance. required: - field - op - value - extra properties: condition_type: type: string x-value: ZipMerge enum: - ZipMerge field: type: string title: Segment Field description: An address or zip-type merge field to segment. example: MMERGE2 op: type: string enum: - geoin title: Segment Operator description: Whether the member's address merge field is within a given distance from a city or zip. example: geoin value: type: string title: Segment Value description: The distance from the city/zip. example: '25' extra: type: string title: Segment Extra description: The city or the zip being used to segment against. example: '30318' - type: object title: Birthday Merge Field Segment description: Segment by a contact's birthday. required: - field - op properties: condition_type: type: string x-value: BirthdayMerge enum: - BirthdayMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE4 op: type: string enum: - is - not - blank - blank_not title: Segment Operator description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against (mm/dd). example: 01/30 - type: object title: Date Merge Field Segment description: Segment by a given date merge field. required: - field - op properties: condition_type: type: string x-value: DateMerge enum: - DateMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE5 op: type: string enum: - is - not - less - blank - blank_not - greater title: Segment Operator description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against. example: 01/30/2015 - type: object title: Dropdown/Radio Merge Field Segment description: An individual segment condition required: - field - op properties: condition_type: type: string x-value: SelectMerge enum: - SelectMerge field: type: string title: Segment Field description: A merge field to segment. example: MMERGE6 op: type: string enum: - is - not - blank - blank_not - notcontain - contains title: Segment Operator description: Whether the member's merge information is/is not a value or is/is not blank. example: is value: type: string title: Segment Value description: The value to segment a text merge field with. example: Second Choice - type: object title: Text or Number Merge Field Segment description: Segment by a given text or number merge field. required: - field - op properties: condition_type: type: string x-value: TextMerge enum: - TextMerge field: type: string title: Segment Field description: A text or number merge field to segment. example: MMERGE7 op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not title: Segment Operator description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value example: contains value: type: string title: Segment Value description: The value to segment a text or number merge field with. example: Freddie's Jokes - type: object title: Email Segment description: Segment by email address. required: - field - op properties: condition_type: type: string x-value: EmailAddress enum: - EmailAddress field: type: string enum: - merge0 - EMAIL title: Segment Field description: Segmenting based off of a subscriber's email address. example: EMAIL op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. value: type: string title: Segment Value description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com - type: object title: Predicted Gender Segment description: Segment by predicted gender. required: - field - op - value properties: condition_type: type: string x-value: PredictedGender enum: - PredictedGender field: type: string enum: - predicted_gender title: Segment Field description: Segment by predicted gender. op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The predicted gender to segment. example: female - type: object title: Predicted Age Segment description: Segment by predicted age. required: - field - op - value properties: condition_type: type: string x-value: PredictedAge enum: - PredictedAge field: type: string enum: - predicted_age_range title: Segment Field description: Segment by predicted age. op: type: string enum: - is title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ title: Segment Operator description: The predicted age to segment. example: female - type: object title: New Subscribers Prebuilt Segment description: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. op: type: string enum: - date_within title: Segment Operator description: Whe the event took place, namely within a time frame. value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_segment methodNameCamel: getSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Segment description: Delete a specific segment in a list. operationId: deleteListsIdSegmentsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_segment methodNameCamel: deleteSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Segment description: Update a specific segment in a list. operationId: patchListsIdSegmentsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: List description: Information about a specific list segment. required: - name properties: name: type: string title: Segment Name description: The name of the segment. static_segment: type: array title: Static Segment description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the `options` field. items: type: string options: type: object title: Conditions description: The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions. properties: match: type: string title: Match description: Match type. enum: - any - all conditions: type: array title: Segment Conditions description: An array of segment conditions. items: type: array title: Segment Type description: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas). items: x-discriminator: type: string propertyName: condition_type x-oneOf: - type: object title: Aim Segment description: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. example: aim op: type: string enum: - open - click - sent - noopen - noclick - nosent title: Segment Operator description: 'The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn''t open, didn''t click, or was not sent.' example: open value: type: string title: Segment Data description: Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Automation Segment description: Segment by interaction with an Automation workflow. required: - field - op - value properties: condition_type: type: string x-value: Automation enum: - Automation field: type: string enum: - automation title: Segment Field description: Segment by interaction with an Automation workflow. example: automation op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.' example: started value: type: string title: Segment Data description: The web id for the automation workflow to segment against. example: '2135217' - type: object title: Poll Activity Segment description: Segment by poll activity. required: - field - op - value properties: condition_type: type: string x-value: CampaignPoll enum: - CampaignPoll field: type: string enum: - poll title: Segment Field description: Segment by poll activity. example: poll op: type: string enum: - member - notmember title: Segment Operator description: Members have/have not interacted with a specific poll in a Mailchimp email. example: member value: type: number title: Segment Operator description: The id for the poll. example: 409 - type: object title: Conversation Segment description: Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: Segment by interaction with a campaign via Conversations. example: conversation op: type: string enum: - member - notmember title: Segment Operator description: 'The status of a member''s interaction with a conversation. One of the following: has replied or has not replied.' example: member value: type: string title: Segment Data description: The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Date Segment description: Segment by a specific date field. required: - field - op - value properties: condition_type: type: string x-value: Date enum: - Date field: type: string enum: - timestamp_opt - info_changed - ecomm_date title: Segment Field description: 'The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.' example: timestamp_opt op: type: string enum: - greater - less - is - not - blank - blank_not - within - notwithin title: Segment Operator description: 'When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.' example: greater value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: date extra: type: string title: Segment Extra Value description: When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign. example: '2015-01-30' - type: object title: Email Client Segment description: Segment by use of a particular email client. required: - field - op - value properties: condition_type: type: string x-value: EmailClient enum: - EmailClient field: type: string enum: - email_client title: Segment Field description: Segment by use of a particular email client. example: email_client op: type: string enum: - client_is - client_not title: Segment Operator description: The operation to determine whether we select clients that match the value, or clients that do not match the value. example: client_is value: type: string title: Segment Data description: The name of the email client. example: Gmail - type: object title: Language Segment description: Segment by language. required: - field - op - value properties: condition_type: type: string x-value: Language enum: - Language field: type: string enum: - language title: Segment Field description: Segmenting based off of a subscriber's language. example: language op: type: string enum: - is - not title: Segment Operator description: Whether the member's language is or is not set to a specific language. example: is value: type: string title: Segment Data description: A two-letter language identifier. example: en - type: object title: Member Rating Segment description: Segment by member rating. required: - field - op - value properties: condition_type: type: string x-value: MemberRating enum: - MemberRating field: type: string enum: - rating title: Segment Field description: Segment by member rating. example: rating op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number. example: greater value: type: number title: Segment Operator description: The star rating number to segment against. example: 4 - type: object title: Signup Source Segment description: Segment by signup source. required: - field - condition_type - op properties: condition_type: type: string enum: - SignupSource x-value: SignupSource title: Type field: type: string enum: - source title: Segment Field example: source op: type: string enum: - source_is - source_not title: Segment Operator description: Whether the member's signup source was/was not a particular value. example: source_is value: type: string title: Segment Data description: The signup source. example: List Import - type: object title: Survey Monkey Segment description: Segment by interaction with a SurveyMonkey survey. required: - field - op - value properties: condition_type: type: string x-value: SurveyMonkey enum: - SurveyMonkey field: type: string enum: - survey_monkey title: Segment Field description: Segment by interaction with a SurveyMonkey survey. example: survey_monkey op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.' example: started value: type: string title: Survey ID description: The unique ID of the survey monkey survey. example: '32179586' - type: object title: VIP Segment description: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by VIP status. example: gmonkey op: type: string enum: - member - notmember title: Segment Operator description: Whether the member is or is not marked as VIP. example: member - type: object title: Interests Segment description: Segment by an interest group merge field. properties: condition_type: type: string x-value: Interests enum: - Interests field: type: string title: Segment Field description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 op: type: string enum: - interestcontains - interestcontainsall - interestnotcontains title: Segment Operator description: Whether the member is a part of one, all, or none of the groups. example: interestcontains value: type: array title: Segment Value description: An array containing strings, each representing a group id. items: type: string example: - '44401' - '44405' - '44409' - type: object title: Ecommerce Category Segment description: Segment by purchases in specific items or categories. properties: condition_type: type: string x-value: EcommCategory enum: - EcommCategory field: type: string enum: - ecomm_cat - ecomm_prod title: Segment Field description: Segment by purchases in specific items or categories. example: ecomm_cat op: type: string enum: - is - not - contains - notcontain - starts - ends title: Segment Operator description: A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string. example: is value: type: string title: Segment Data description: The ecommerce category/item information. example: Product - type: object title: Ecommerce Number Segment description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. required: - field - op - value properties: condition_type: type: string x-value: EcommNumber enum: - EcommNumber field: type: string enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord title: Segment Field description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. example: ecomm_orders op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. example: greater value: type: number title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 - type: object title: Ecommerce Purchased Segment description: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: Segment by whether someone has purchased anything. example: ecomm_purchased op: type: string enum: - member - notmember title: Segment Operator description: Members who have have ('member') or have not ('notmember') purchased. example: member - type: object title: Ecommerce Spent Segment description: Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: Segment by amount spent on a single order or across all orders. example: ecomm_spent_one op: type: string enum: - greater - less title: Segment Operator description: Members who have spent 'more' or 'less' than then specified value. example: greater value: type: integer title: Segment Data description: The total amount a member spent. example: 42 - type: object title: Ecommerce Purchased Store Segment description: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases from a specific store. example: ecomm_store op: type: string enum: - is - not title: Segment Operator description: Members who have or have not purchased from a specific store. example: is value: type: string title: Segment Operator description: The store id to segment against. example: '289' - type: object title: Goal Activity Segment description: Segment by Goal activity. required: - field - op - value properties: condition_type: type: string x-value: GoalActivity enum: - GoalActivity field: type: string enum: - goal title: Segment Field description: Segment by Goal activity. example: goal op: type: string enum: - is - goal_not - contains - goal_notcontain - starts - ends title: Segment Operator description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. example: is value: type: string title: Segment Value description: The URL to check Goal activity against. - type: object title: Goal Timestamp Segment description: Segment by most recent interaction with a website. required: - field - op - value properties: condition_type: type: string x-value: GoalTimestamp enum: - GoalTimestamp field: type: string enum: - goal_last_visited title: Segment Field description: Segment by most recent interaction with a website. example: goal_last_visited op: type: string enum: - greater - less - is title: Segment Operator description: Whether the website activity happened after, before, or at a given timestamp. example: greater value: type: string title: Segment Value description: The date to check Goal activity against. example: '2015-07-20 19:45:21' - type: object title: Similar Subscribers Segment Member Segment description: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. example: fuzzy_segment op: type: string enum: - fuzzy_is - fuzzy_not title: Segment Operator description: Members who are/are not apart of a 'similar subscribers' segment. example: fuzzy_is value: type: number title: Segment Operator description: The id for the 'similar subscribers' segment. example: 48433 - type: object title: Static Segment Member Segment description: Segment by a given static segment. required: - field - op - value properties: condition_type: type: string x-value: StaticSegment enum: - StaticSegment field: type: string enum: - static_segment title: Segment Field description: Segment by a given static segment. example: static_segment op: type: string enum: - static_is - static_not title: Segment Operator description: Members who are/are not apart of a static segment. example: static_is value: type: number title: Segment Operator description: The id for the static segment. example: 48433 - type: object title: Location-Based Segment description: Segment by a specific country or US state. required: - field - op - value properties: condition_type: type: string x-value: IPGeoCountryState enum: - IPGeoCountryState field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate title: Segment Operator description: Segment members who are within a specific country or US state. example: ipgeocountry value: type: string title: Segment Data description: The two-letter country code or US state abbreviation. example: US - type: object title: Geolocation Segment description: Segment by a specific geographic region. required: - field - op - value - addr - lat - lng properties: condition_type: type: string x-value: IPGeoIn enum: - IPGeoIn field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoin - ipgeonotin title: Segment Operator description: Segment members who are within a specific geographic region. example: ipgeoin value: type: integer title: Segment Data description: The radius of the target location. example: 42 addr: type: string title: Segment Location Address description: The address of the target location. example: Atlanta, GA, USA lat: type: string title: Segment Location Latitude description: The latitude of the target location. example: '33.7489954' lng: type: string title: Segment Location Longitude description: The longitude of the target location. example: '-84.3879824' - type: object title: US Zip Code Segment description: Segment by a specific US ZIP code. required: - field - op - value - extra properties: condition_type: type: string x-value: IPGeoInZip enum: - IPGeoInZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoinzip title: Segment Operator description: Segment members who are within a specific US zip code. example: ipgeoinzip value: type: integer title: Segment Data description: The radius of the target location. example: 25 extra: type: integer title: Extra Data description: The zip code to segment against. example: 30318 - type: object title: Unknown Location-Based Segment description: Segment members whose location information is unknown. required: - field - op properties: condition_type: type: string x-value: IPGeoUnknown enum: - IPGeoUnknown field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeounknown title: Segment Operator description: Segment members for which location information is unknown. example: ipgeounknown - type: object title: Zip Code Location-Based Segment description: Segment by a specific US ZIP code. required: - field - op - value properties: condition_type: type: string x-value: IPGeoZip enum: - IPGeoZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoiszip - ipgeonotzip title: Segment Operator description: Segment members who are/are not within a specific US zip code. example: ipgeonotzip value: type: integer title: Segment Data description: The 5-digit zip code. example: 30318 - type: object title: Social Profiles Age Segment description: Segment by age ranges in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialAge enum: - SocialAge field: type: string enum: - social_age title: Segment Field description: Segment by age ranges in Social Profiles data. example: social_age op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-54 - 55+ title: Segment Operator description: The age range to segment. example: 35-54 - type: object title: Social Profiles Gender Segment description: Segment by listed gender in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialGender enum: - SocialGender field: type: string enum: - social_gender title: Segment Field description: Segment by listed gender in Social Profiles data. example: social_gender op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The Social Profiles gender to segment. example: female - type: object title: Social Profiles Influence Segment description: Segment by influence rating in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialInfluence enum: - SocialInfluence field: type: string enum: - social_influence title: Segment Field description: Segment by influence rating in Social Profiles data. example: social_influence op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have a rating that is/not or greater/less than the rating provided. example: greater value: type: number title: Segment Operator description: The Social Profiles influence rating to segment. example: 2 - type: object title: Social Profiles Social Network Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkMember enum: - SocialNetworkMember field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - member - notmember title: Segment Operator description: Members who are/not on a given social network. example: member value: type: string enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube title: Segment Operator description: The social network to segment against. example: twitter - type: object title: Social Profiles Social Network Follow Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkFollow enum: - SocialNetworkFollow field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - follow - notfollow title: Segment Operator description: Members who are/not following a linked account on a given social network. example: follow value: type: string enum: - twitter_follow title: Segment Operator description: The social network to segment against. example: twitter_follow - type: object title: Address Merge Field Segment description: Segment by an address-type merge field. required: - field - op properties: condition_type: type: string x-value: AddressMerge enum: - AddressMerge field: type: string title: Segment Field description: An address-type merge field to segment. example: MMERGE3 op: type: string enum: - contains - notcontain - blank - blank_not title: Segment Operator description: Whether the member's address merge field contains/does not contain a value or is/is not blank. example: contains value: type: string title: Segment Value description: The value to segment a text merge field with. example: Atlanta - type: object title: Address/Zip Merge Field Segment description: Segment by an address-type merge field within a given distance. required: - field - op - value - extra properties: condition_type: type: string x-value: ZipMerge enum: - ZipMerge field: type: string title: Segment Field description: An address or zip-type merge field to segment. example: MMERGE2 op: type: string enum: - geoin title: Segment Operator description: Whether the member's address merge field is within a given distance from a city or zip. example: geoin value: type: string title: Segment Value description: The distance from the city/zip. example: '25' extra: type: string title: Segment Extra description: The city or the zip being used to segment against. example: '30318' - type: object title: Birthday Merge Field Segment description: Segment by a contact's birthday. required: - field - op properties: condition_type: type: string x-value: BirthdayMerge enum: - BirthdayMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE4 op: type: string enum: - is - not - blank - blank_not title: Segment Operator description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against (mm/dd). example: 01/30 - type: object title: Date Merge Field Segment description: Segment by a given date merge field. required: - field - op properties: condition_type: type: string x-value: DateMerge enum: - DateMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE5 op: type: string enum: - is - not - less - blank - blank_not - greater title: Segment Operator description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against. example: 01/30/2015 - type: object title: Dropdown/Radio Merge Field Segment description: An individual segment condition required: - field - op properties: condition_type: type: string x-value: SelectMerge enum: - SelectMerge field: type: string title: Segment Field description: A merge field to segment. example: MMERGE6 op: type: string enum: - is - not - blank - blank_not - notcontain - contains title: Segment Operator description: Whether the member's merge information is/is not a value or is/is not blank. example: is value: type: string title: Segment Value description: The value to segment a text merge field with. example: Second Choice - type: object title: Text or Number Merge Field Segment description: Segment by a given text or number merge field. required: - field - op properties: condition_type: type: string x-value: TextMerge enum: - TextMerge field: type: string title: Segment Field description: A text or number merge field to segment. example: MMERGE7 op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not title: Segment Operator description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value example: contains value: type: string title: Segment Value description: The value to segment a text or number merge field with. example: Freddie's Jokes - type: object title: Email Segment description: Segment by email address. required: - field - op properties: condition_type: type: string x-value: EmailAddress enum: - EmailAddress field: type: string enum: - merge0 - EMAIL title: Segment Field description: Segmenting based off of a subscriber's email address. example: EMAIL op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. value: type: string title: Segment Value description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com - type: object title: Predicted Gender Segment description: Segment by predicted gender. required: - field - op - value properties: condition_type: type: string x-value: PredictedGender enum: - PredictedGender field: type: string enum: - predicted_gender title: Segment Field description: Segment by predicted gender. op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The predicted gender to segment. example: female - type: object title: Predicted Age Segment description: Segment by predicted age. required: - field - op - value properties: condition_type: type: string x-value: PredictedAge enum: - PredictedAge field: type: string enum: - predicted_age_range title: Segment Field description: Segment by predicted age. op: type: string enum: - is title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ title: Segment Operator description: The predicted age to segment. example: female - type: object title: New Subscribers Prebuilt Segment description: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. op: type: string enum: - date_within title: Segment Operator description: Whe the event took place, namely within a time frame. value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: example_value responses: '200': description: '' schema: type: object title: List description: Information about a specific segment. properties: id: type: integer title: Segment ID description: The unique id for the segment. readOnly: true name: type: string title: Segment Name description: The name of the segment. member_count: type: integer title: Member Count description: The number of active subscribers currently included in the segment. readOnly: true type: type: string title: Type description: The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs). readOnly: true enum: - saved - static - fuzzy created_at: type: string title: Date Created description: The date and time the segment was created in ISO 8601 format. readOnly: true format: date-time updated_at: type: string title: Date Updated description: The date and time the segment was last updated in ISO 8601 format. format: date-time readOnly: true options: type: object title: Conditions description: The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions. properties: match: type: string title: Match description: Match type. enum: - any - all conditions: type: array title: Segment Type description: Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas). items: x-discriminator: type: string propertyName: condition_type x-oneOf: - type: object title: Aim Segment description: Segment by interaction with a specific campaign. properties: condition_type: type: string x-value: Aim enum: - Aim field: type: string enum: - aim title: Segment Field description: Segment by interaction with a specific campaign. example: aim op: type: string enum: - open - click - sent - noopen - noclick - nosent title: Segment Operator description: 'The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn''t open, didn''t click, or was not sent.' example: open value: type: string title: Segment Data description: Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Automation Segment description: Segment by interaction with an Automation workflow. required: - field - op - value properties: condition_type: type: string x-value: Automation enum: - Automation field: type: string enum: - automation title: Segment Field description: Segment by interaction with an Automation workflow. example: automation op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow.' example: started value: type: string title: Segment Data description: The web id for the automation workflow to segment against. example: '2135217' - type: object title: Poll Activity Segment description: Segment by poll activity. required: - field - op - value properties: condition_type: type: string x-value: CampaignPoll enum: - CampaignPoll field: type: string enum: - poll title: Segment Field description: Segment by poll activity. example: poll op: type: string enum: - member - notmember title: Segment Operator description: Members have/have not interacted with a specific poll in a Mailchimp email. example: member value: type: number title: Segment Operator description: The id for the poll. example: 409 - type: object title: Conversation Segment description: Segment by interaction with a campaign via Conversations. required: - field - op - value properties: condition_type: type: string x-value: Conversation enum: - Conversation field: type: string enum: - conversation title: Segment Field description: Segment by interaction with a campaign via Conversations. example: conversation op: type: string enum: - member - notmember title: Segment Operator description: 'The status of a member''s interaction with a conversation. One of the following: has replied or has not replied.' example: member value: type: string title: Segment Data description: The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns. example: any - type: object title: Date Segment description: Segment by a specific date field. required: - field - op - value properties: condition_type: type: string x-value: Date enum: - Date field: type: string enum: - timestamp_opt - info_changed - ecomm_date title: Segment Field description: 'The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase.' example: timestamp_opt op: type: string enum: - greater - less - is - not - blank - blank_not - within - notwithin title: Segment Operator description: 'When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank.' example: greater value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' example: date extra: type: string title: Segment Extra Value description: When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign. example: '2015-01-30' - type: object title: Email Client Segment description: Segment by use of a particular email client. required: - field - op - value properties: condition_type: type: string x-value: EmailClient enum: - EmailClient field: type: string enum: - email_client title: Segment Field description: Segment by use of a particular email client. example: email_client op: type: string enum: - client_is - client_not title: Segment Operator description: The operation to determine whether we select clients that match the value, or clients that do not match the value. example: client_is value: type: string title: Segment Data description: The name of the email client. example: Gmail - type: object title: Language Segment description: Segment by language. required: - field - op - value properties: condition_type: type: string x-value: Language enum: - Language field: type: string enum: - language title: Segment Field description: Segmenting based off of a subscriber's language. example: language op: type: string enum: - is - not title: Segment Operator description: Whether the member's language is or is not set to a specific language. example: is value: type: string title: Segment Data description: A two-letter language identifier. example: en - type: object title: Member Rating Segment description: Segment by member rating. required: - field - op - value properties: condition_type: type: string x-value: MemberRating enum: - MemberRating field: type: string enum: - rating title: Segment Field description: Segment by member rating. example: rating op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number. example: greater value: type: number title: Segment Operator description: The star rating number to segment against. example: 4 - type: object title: Signup Source Segment description: Segment by signup source. required: - field - condition_type - op properties: condition_type: type: string enum: - SignupSource x-value: SignupSource title: Type field: type: string enum: - source title: Segment Field example: source op: type: string enum: - source_is - source_not title: Segment Operator description: Whether the member's signup source was/was not a particular value. example: source_is value: type: string title: Segment Data description: The signup source. example: List Import - type: object title: Survey Monkey Segment description: Segment by interaction with a SurveyMonkey survey. required: - field - op - value properties: condition_type: type: string x-value: SurveyMonkey enum: - SurveyMonkey field: type: string enum: - survey_monkey title: Segment Field description: Segment by interaction with a SurveyMonkey survey. example: survey_monkey op: type: string enum: - started - completed - not_started - not_completed title: Segment Operator description: 'The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey.' example: started value: type: string title: Survey ID description: The unique ID of the survey monkey survey. example: '32179586' - type: object title: VIP Segment description: Segment by VIP status. required: - field - op properties: condition_type: type: string x-value: VIP enum: - VIP field: type: string enum: - gmonkey title: Segment Field description: Segment by VIP status. example: gmonkey op: type: string enum: - member - notmember title: Segment Operator description: Whether the member is or is not marked as VIP. example: member - type: object title: Interests Segment description: Segment by an interest group merge field. properties: condition_type: type: string x-value: Interests enum: - Interests field: type: string title: Segment Field description: Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'. example: interests-123 op: type: string enum: - interestcontains - interestcontainsall - interestnotcontains title: Segment Operator description: Whether the member is a part of one, all, or none of the groups. example: interestcontains value: type: array title: Segment Value description: An array containing strings, each representing a group id. items: type: string example: - '44401' - '44405' - '44409' - type: object title: Ecommerce Category Segment description: Segment by purchases in specific items or categories. properties: condition_type: type: string x-value: EcommCategory enum: - EcommCategory field: type: string enum: - ecomm_cat - ecomm_prod title: Segment Field description: Segment by purchases in specific items or categories. example: ecomm_cat op: type: string enum: - is - not - contains - notcontain - starts - ends title: Segment Operator description: A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string. example: is value: type: string title: Segment Data description: The ecommerce category/item information. example: Product - type: object title: Ecommerce Number Segment description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. required: - field - op - value properties: condition_type: type: string x-value: EcommNumber enum: - EcommNumber field: type: string enum: - ecomm_spent_avg - ecomm_orders - ecomm_prod_all - ecomm_avg_ord title: Segment Field description: Segment by average spent total, number of orders, total number of products purchased, or average number of products per order. example: ecomm_orders op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value. example: greater value: type: number title: Segment Operator description: Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount. example: 42 - type: object title: Ecommerce Purchased Segment description: Segment by whether someone has purchased anything. properties: condition_type: type: string x-value: EcommPurchased enum: - EcommPurchased field: type: string enum: - ecomm_purchased title: Segment Field description: Segment by whether someone has purchased anything. example: ecomm_purchased op: type: string enum: - member - notmember title: Segment Operator description: Members who have have ('member') or have not ('notmember') purchased. example: member - type: object title: Ecommerce Spent Segment description: Segment by amount spent on a single order or across all orders. properties: condition_type: type: string x-value: EcommSpent enum: - EcommSpent field: type: string enum: - ecomm_spent_one - ecomm_spent_all title: Segment Field description: Segment by amount spent on a single order or across all orders. example: ecomm_spent_one op: type: string enum: - greater - less title: Segment Operator description: Members who have spent 'more' or 'less' than then specified value. example: greater value: type: integer title: Segment Data description: The total amount a member spent. example: 42 - type: object title: Ecommerce Purchased Store Segment description: Segment by purchases from a specific store. properties: condition_type: type: string x-value: EcommStore enum: - EcommStore field: type: string enum: - ecomm_store title: Segment Field description: Segment by purchases from a specific store. example: ecomm_store op: type: string enum: - is - not title: Segment Operator description: Members who have or have not purchased from a specific store. example: is value: type: string title: Segment Operator description: The store id to segment against. example: '289' - type: object title: Goal Activity Segment description: Segment by Goal activity. required: - field - op - value properties: condition_type: type: string x-value: GoalActivity enum: - GoalActivity field: type: string enum: - goal title: Segment Field description: Segment by Goal activity. example: goal op: type: string enum: - is - goal_not - contains - goal_notcontain - starts - ends title: Segment Operator description: Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string. example: is value: type: string title: Segment Value description: The URL to check Goal activity against. - type: object title: Goal Timestamp Segment description: Segment by most recent interaction with a website. required: - field - op - value properties: condition_type: type: string x-value: GoalTimestamp enum: - GoalTimestamp field: type: string enum: - goal_last_visited title: Segment Field description: Segment by most recent interaction with a website. example: goal_last_visited op: type: string enum: - greater - less - is title: Segment Operator description: Whether the website activity happened after, before, or at a given timestamp. example: greater value: type: string title: Segment Value description: The date to check Goal activity against. example: '2015-07-20 19:45:21' - type: object title: Similar Subscribers Segment Member Segment description: Segment by similar subscribers. required: - field - op - value properties: condition_type: type: string x-value: FuzzySegment enum: - FuzzySegment field: type: string enum: - fuzzy_segment title: Segment Field description: Segment by similar subscribers. example: fuzzy_segment op: type: string enum: - fuzzy_is - fuzzy_not title: Segment Operator description: Members who are/are not apart of a 'similar subscribers' segment. example: fuzzy_is value: type: number title: Segment Operator description: The id for the 'similar subscribers' segment. example: 48433 - type: object title: Static Segment Member Segment description: Segment by a given static segment. required: - field - op - value properties: condition_type: type: string x-value: StaticSegment enum: - StaticSegment field: type: string enum: - static_segment title: Segment Field description: Segment by a given static segment. example: static_segment op: type: string enum: - static_is - static_not title: Segment Operator description: Members who are/are not apart of a static segment. example: static_is value: type: number title: Segment Operator description: The id for the static segment. example: 48433 - type: object title: Location-Based Segment description: Segment by a specific country or US state. required: - field - op - value properties: condition_type: type: string x-value: IPGeoCountryState enum: - IPGeoCountryState field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeocountry - ipgeonotcountry - ipgeostate - ipgeonotstate title: Segment Operator description: Segment members who are within a specific country or US state. example: ipgeocountry value: type: string title: Segment Data description: The two-letter country code or US state abbreviation. example: US - type: object title: Geolocation Segment description: Segment by a specific geographic region. required: - field - op - value - addr - lat - lng properties: condition_type: type: string x-value: IPGeoIn enum: - IPGeoIn field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoin - ipgeonotin title: Segment Operator description: Segment members who are within a specific geographic region. example: ipgeoin value: type: integer title: Segment Data description: The radius of the target location. example: 42 addr: type: string title: Segment Location Address description: The address of the target location. example: Atlanta, GA, USA lat: type: string title: Segment Location Latitude description: The latitude of the target location. example: '33.7489954' lng: type: string title: Segment Location Longitude description: The longitude of the target location. example: '-84.3879824' - type: object title: US Zip Code Segment description: Segment by a specific US ZIP code. required: - field - op - value - extra properties: condition_type: type: string x-value: IPGeoInZip enum: - IPGeoInZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoinzip title: Segment Operator description: Segment members who are within a specific US zip code. example: ipgeoinzip value: type: integer title: Segment Data description: The radius of the target location. example: 25 extra: type: integer title: Extra Data description: The zip code to segment against. example: 30318 - type: object title: Unknown Location-Based Segment description: Segment members whose location information is unknown. required: - field - op properties: condition_type: type: string x-value: IPGeoUnknown enum: - IPGeoUnknown field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeounknown title: Segment Operator description: Segment members for which location information is unknown. example: ipgeounknown - type: object title: Zip Code Location-Based Segment description: Segment by a specific US ZIP code. required: - field - op - value properties: condition_type: type: string x-value: IPGeoZip enum: - IPGeoZip field: type: string enum: - ipgeo title: Segment Field description: Segmenting subscribers who are within a specific location. example: ipgeo op: type: string enum: - ipgeoiszip - ipgeonotzip title: Segment Operator description: Segment members who are/are not within a specific US zip code. example: ipgeonotzip value: type: integer title: Segment Data description: The 5-digit zip code. example: 30318 - type: object title: Social Profiles Age Segment description: Segment by age ranges in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialAge enum: - SocialAge field: type: string enum: - social_age title: Segment Field description: Segment by age ranges in Social Profiles data. example: social_age op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-54 - 55+ title: Segment Operator description: The age range to segment. example: 35-54 - type: object title: Social Profiles Gender Segment description: Segment by listed gender in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialGender enum: - SocialGender field: type: string enum: - social_gender title: Segment Field description: Segment by listed gender in Social Profiles data. example: social_gender op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The Social Profiles gender to segment. example: female - type: object title: Social Profiles Influence Segment description: Segment by influence rating in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialInfluence enum: - SocialInfluence field: type: string enum: - social_influence title: Segment Field description: Segment by influence rating in Social Profiles data. example: social_influence op: type: string enum: - is - not - greater - less title: Segment Operator description: Members who have a rating that is/not or greater/less than the rating provided. example: greater value: type: number title: Segment Operator description: The Social Profiles influence rating to segment. example: 2 - type: object title: Social Profiles Social Network Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkMember enum: - SocialNetworkMember field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - member - notmember title: Segment Operator description: Members who are/not on a given social network. example: member value: type: string enum: - twitter - facebook - linkedin - flickr - foursquare - lastfm - myspace - quora - vimeo - yelp - youtube title: Segment Operator description: The social network to segment against. example: twitter - type: object title: Social Profiles Social Network Follow Segment description: Segment by social network in Social Profiles data. required: - field - op - value properties: condition_type: type: string x-value: SocialNetworkFollow enum: - SocialNetworkFollow field: type: string enum: - social_network title: Segment Field description: Segment by social network in Social Profiles data. example: social_network op: type: string enum: - follow - notfollow title: Segment Operator description: Members who are/not following a linked account on a given social network. example: follow value: type: string enum: - twitter_follow title: Segment Operator description: The social network to segment against. example: twitter_follow - type: object title: Address Merge Field Segment description: Segment by an address-type merge field. required: - field - op properties: condition_type: type: string x-value: AddressMerge enum: - AddressMerge field: type: string title: Segment Field description: An address-type merge field to segment. example: MMERGE3 op: type: string enum: - contains - notcontain - blank - blank_not title: Segment Operator description: Whether the member's address merge field contains/does not contain a value or is/is not blank. example: contains value: type: string title: Segment Value description: The value to segment a text merge field with. example: Atlanta - type: object title: Address/Zip Merge Field Segment description: Segment by an address-type merge field within a given distance. required: - field - op - value - extra properties: condition_type: type: string x-value: ZipMerge enum: - ZipMerge field: type: string title: Segment Field description: An address or zip-type merge field to segment. example: MMERGE2 op: type: string enum: - geoin title: Segment Operator description: Whether the member's address merge field is within a given distance from a city or zip. example: geoin value: type: string title: Segment Value description: The distance from the city/zip. example: '25' extra: type: string title: Segment Extra description: The city or the zip being used to segment against. example: '30318' - type: object title: Birthday Merge Field Segment description: Segment by a contact's birthday. required: - field - op properties: condition_type: type: string x-value: BirthdayMerge enum: - BirthdayMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE4 op: type: string enum: - is - not - blank - blank_not title: Segment Operator description: Whether the member's birthday merge information is/is not a certain date or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against (mm/dd). example: 01/30 - type: object title: Date Merge Field Segment description: Segment by a given date merge field. required: - field - op properties: condition_type: type: string x-value: DateMerge enum: - DateMerge field: type: string title: Segment Field description: A date merge field to segment. example: MMERGE5 op: type: string enum: - is - not - less - blank - blank_not - greater title: Segment Operator description: Whether the member's merge information is/is not, is greater/less than a value or is/is not blank. example: is value: type: string title: Segment Value description: A date to segment against. example: 01/30/2015 - type: object title: Dropdown/Radio Merge Field Segment description: An individual segment condition required: - field - op properties: condition_type: type: string x-value: SelectMerge enum: - SelectMerge field: type: string title: Segment Field description: A merge field to segment. example: MMERGE6 op: type: string enum: - is - not - blank - blank_not - notcontain - contains title: Segment Operator description: Whether the member's merge information is/is not a value or is/is not blank. example: is value: type: string title: Segment Value description: The value to segment a text merge field with. example: Second Choice - type: object title: Text or Number Merge Field Segment description: Segment by a given text or number merge field. required: - field - op properties: condition_type: type: string x-value: TextMerge enum: - TextMerge field: type: string title: Segment Field description: A text or number merge field to segment. example: MMERGE7 op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less - blank - blank_not title: Segment Operator description: Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value example: contains value: type: string title: Segment Value description: The value to segment a text or number merge field with. example: Freddie's Jokes - type: object title: Email Segment description: Segment by email address. required: - field - op properties: condition_type: type: string x-value: EmailAddress enum: - EmailAddress field: type: string enum: - merge0 - EMAIL title: Segment Field description: Segmenting based off of a subscriber's email address. example: EMAIL op: type: string enum: - is - not - contains - notcontain - starts - ends - greater - less title: Segment Operator description: Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string. value: type: string title: Segment Value description: The value to compare the email against. example: urist.mcvankab@freddiesjokes.com - type: object title: Predicted Gender Segment description: Segment by predicted gender. required: - field - op - value properties: condition_type: type: string x-value: PredictedGender enum: - PredictedGender field: type: string enum: - predicted_gender title: Segment Field description: Segment by predicted gender. op: type: string enum: - is - not title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - male - female title: Segment Operator description: The predicted gender to segment. example: female - type: object title: Predicted Age Segment description: Segment by predicted age. required: - field - op - value properties: condition_type: type: string x-value: PredictedAge enum: - PredictedAge field: type: string enum: - predicted_age_range title: Segment Field description: Segment by predicted age. op: type: string enum: - is title: Segment Operator description: Members who are/not the exact criteria listed. example: is value: type: string enum: - 18-24 - 25-34 - 35-44 - 45-54 - 55-64 - 65+ title: Segment Operator description: The predicted age to segment. example: female - type: object title: New Subscribers Prebuilt Segment description: Segment by when people subscribed. properties: condition_type: type: string x-value: NewSubscribers enum: - NewSubscribers field: type: string enum: - timestamp_opt title: Segment Field description: Segment by when people subscribed. op: type: string enum: - date_within title: Segment Operator description: Whe the event took place, namely within a time frame. value: type: string title: Segment Data description: 'What type of data to segment on: a specific date, a specific campaign, or the last campaign sent.' list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_segment methodNameCamel: updateSegment x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Batch Add or Remove Members description: Batch add/remove list members to static segment operationId: postListsIdSegmentsId parameters: - name: body in: body description: '' required: true schema: type: object title: Members to add/remove to/from a static segment description: Members to add/remove to/from a static segment properties: members_to_add: type: array title: Members to add to the static segment description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. items: type: string members_to_remove: type: array title: Members to remove from the static segment description: An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent. items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Batch add/remove List members to/from static segment description: Batch add/remove List members to/from static segment properties: members_added: type: array title: Members Added description: An array of objects, each representing a new member that was added to the static segment. items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true members_removed: type: array title: Members Removed description: An array of objects, each representing an existing list member that got deleted from the static segment. items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Member Merge Var description: An individual merge var and value for a member. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: The tags applied to this member. readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true errors: type: array title: Errors description: An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details. items: type: object properties: email_addresses: type: array title: Email addresses added to the static segment or removed description: Email addresses added to the static segment or removed items: type: string error: type: string title: Error message description: The error message indicating why the email addresses could not be added or updated. total_added: type: integer title: Item Count description: The total number of items matching the query, irrespective of pagination. example: 42 total_removed: type: integer title: Item Count description: The total number of items matching the query, irrespective of pagination. example: 42 error_count: type: integer title: Item Count description: The total number of items matching the query, irrespective of pagination. example: 42 _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: batch_segment_members methodNameCamel: batchSegmentMembers x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments/{segment_id}/members: get: summary: Mailchimp List Members in Segment description: Get information about members in a saved segment. operationId: getListsIdSegmentsIdMembers parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: include_cleaned in: query x-title: Include Cleaned description: Include cleaned members in response required: false type: boolean x-example: false example: example_value - name: include_transactional in: query x-title: Include Transactional description: Include transactional members in response required: false type: boolean x-example: false example: example_value - name: include_unsubscribed in: query x-title: Include Unsubscribed description: Include unsubscribed members in response required: false type: boolean x-example: false example: example_value responses: '200': description: '' schema: type: object title: Segment Members description: View members in a specific list segment. properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_segment_members_list methodNameCamel: getSegmentMembersList x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member to Segment description: Add a member to a static segment. operationId: postListsIdSegmentsIdMembers parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object required: - email_address properties: email_address: type: string title: Email Address description: Email address for a subscriber. example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: create_segment_member methodNameCamel: createSegmentMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}: delete: summary: Mailchimp Remove List Member From Segment description: Remove a member from the specified static segment. operationId: deleteListsIdSegmentsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: remove_segment_member methodNameCamel: removeSegmentMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/tag-search: get: summary: Mailchimp Search for Tags on a List by Name. description: Search for tags on a list by name. If no name is provided, will return all tags on the list. operationId: searchTagsByName parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: name x-title: Name in: query description: The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned. required: false type: string example: Example Title responses: '200': description: '' schema: type: object title: Tag search results description: A list of tags matching the input query. properties: tags: type: array title: Tags description: A list of matching tags. readOnly: true items: properties: id: type: integer title: Tag ID description: The unique id for the tag. readOnly: true name: type: string title: Tag Name description: The name of the tag. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 x-custom-config: methodNameSnake: tag_search methodNameCamel: tagSearch deprecated: false tags: - List_id x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members: get: summary: Mailchimp List Members Info description: Get information about members in a specific Mailchimp list. operationId: getListsIdMembers parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: email_type x-title: Email Type in: query required: false description: The email type. type: string example: user@example.com - name: status x-title: Subscriber Status in: query required: false description: The subscriber's status. type: string enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived example: example_value - name: since_timestamp_opt x-title: Since Timestamp Opt in: query description: 'Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: before_timestamp_opt x-title: Before Timestamp Opt in: query description: 'Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: since_last_changed x-title: Since Last Changed in: query description: 'Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: before_last_changed x-title: Before Last Changed in: query description: 'Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: unique_email_id x-title: Unique Email ID in: query description: A unique identifier for the email address across all Mailchimp lists. required: false type: string example: user@example.com - name: vip_only x-title: VIP Only in: query description: A filter to return only the list's VIP members. Passing `true` will restrict results to VIP list members, passing `false` will return all list members. required: false type: boolean example: example_value - name: interest_category_id x-title: Interest Category ID in: query description: The unique id for the interest category. required: false type: string example: '500123' - name: interest_ids x-title: Interest Ids in: query required: false description: Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories. type: string example: example_value - name: interest_match x-title: Interest Match in: query required: false enum: - any - all - none description: Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. "any" will match a member with any of the interest supplied, "all" will only match members with every interest supplied, and "none" will match members without any of the interest supplied. type: string example: example_value - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - timestamp_opt - timestamp_signup - last_changed example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: since_last_campaign x-title: Since Last Campaign in: query required: false description: Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter. type: boolean example: example_value - name: unsubscribed_since x-title: Unsubscribed Since in: query required: false description: Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error. type: string example: example_value responses: '200': description: '' schema: type: object title: List Members description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. list_id: type: string title: List ID description: The list id. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_members_info methodNameCamel: getListMembersInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member to List description: Add a new member to the list. operationId: postListsIdMembers parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: skip_merge_validation x-title: Skip Merge Validation in: query description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. required: - email_address - status properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time tags: type: array title: Tags on a member description: The tags that are associated with a member. items: type: string description: The name of the tag that will be associated with this member. example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: add_list_member methodNameCamel: addListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}: get: summary: Mailchimp Get Member Info description: Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member. operationId: getListsIdMembersId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_member methodNameCamel: getListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Add or Update List Member description: Add or update a list member. operationId: putListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: skip_merge_validation x-title: Skip Merge Validation in: query description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. required: - email_address - status_if_new properties: email_address: type: string title: Email Address description: Email address for a subscriber. This value is required only if the email address is not already present on the list. status_if_new: type: string title: New Member Status description: Subscriber's status. This value is required only if the email address is not already present on the list. enum: - subscribed - unsubscribed - cleaned - pending - transactional email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: set_list_member methodNameCamel: setListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update List Member description: Update information for a specific list member. operationId: patchListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: skip_merge_validation x-title: Skip Merge Validation in: query description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_list_member methodNameCamel: updateListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Archive List Member description: Archive a list member. To permanently delete, use the delete-permanent action. operationId: deleteListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_list_member methodNameCamel: deleteListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/activity: get: summary: Mailchimp View Recent Activity 50 description: Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivity parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - in: query name: action x-title: Action type: array required: false items: type: string collectionFormat: csv enum: - - abuse - - bounce - - click - - open - - sent - - unsub - - ecomm description: A comma seperated list of actions to return. example: example_value responses: '200': description: '' schema: type: object title: Member Activity Events description: The last 50 member events for a list. properties: activity: type: array title: Activity description: An array of objects, each representing a member event. items: type: object title: Member Activity description: Member activity events. properties: action: type: string title: Action Type description: The type of action recorded for the subscriber. timestamp: type: string title: Timestamp format: date-time description: The date and time recorded for the action. url: type: string title: URL description: For clicks, the URL the subscriber clicked on. type: type: string title: Campaign Type description: The type of campaign that was sent. campaign_id: type: string title: Campaign ID description: The web-based ID for the campaign. title: type: string title: Campaign Title description: If set, the campaign's title. parent_campaign: type: string title: Parent Campaign ID description: The ID of the parent campaign. email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_member_activity methodNameCamel: getListMemberActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/activity-feed: get: summary: Mailchimp View Recent Activity description: Get a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivityFeed parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - in: query name: activity_filters x-title: Activity Filters type: array required: false items: type: string collectionFormat: csv enum: - - bounce - - click - - conversation - - ecommerce_signup - - event - - web_engagement - - generic_signup - - landing_page_signup - - marketing_permission - - note - - open - - order - - postcard_sent - - sent - - signup - - squatter_signup - - unsub - - website_signup - - survey_response - - sms_bulk_sent - - inbox_thread - - qbo_payment_link - - video_call_transcripts description: A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,bounce,click". example: example_value responses: '200': description: '' schema: type: object title: Member Activity Events description: The member activity events for a given member. x-hidden: false properties: activity: type: array title: Activity description: An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas). readOnly: true items: x-discriminator: propertyName: activity_type type: string x-oneOf: - type: object title: Email Opens description: Activity feed item representing opening an email. properties: activity_type: type: string description: The type of event activity. x-value: open enum: - open created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. - type: object title: Email Clicks description: Activity feed item representing having a link clicked by a contact. properties: activity_type: type: string description: The type of event activity. x-value: click enum: - click created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. link_clicked: type: string title: Link Clicked description: The URL of the link that was clicked. - type: object title: Email Bounced description: Activity feed item representing an email to this contact bouncing. properties: activity_type: type: string description: The type of event activity. x-value: bounce enum: - bounce created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. bounce_type: type: string title: Bounce Type description: The type of bounce. enum: - hard - soft bounce_has_open_activity: type: boolean title: Bounce Has Open Activity description: Indicates if the email associated with this bounce also has open activity on the same campaign. - type: object title: List Unsubscribed description: Activity feed item representing this contact unsubscribing from a list. properties: activity_type: type: string description: The type of event activity. x-value: unsub enum: - unsub created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Text description: The title of the campaign. is_admin_unsubscribed: type: boolean title: Is Admin Unsubscribed description: Indicates if an admin unsubscribed a contact. unsubscribe_reason: type: string title: Unsubscribe Reason description: Indicates the reason that the contact was unsubscribed. - type: object title: Email Sent description: Activity feed item representing having an email sent to the contact. properties: activity_type: type: string description: The type of event activity. x-value: sent enum: - sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. - type: object title: Email Conversation description: Activity feed item representing an individual reply in a conversation. properties: activity_type: type: string description: The type of event activity. x-value: conversation enum: - conversation created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. thread_id: type: string title: Thread ID description: The thread's unique id of the conversation referenced in this event. message_text: type: string title: Message Text description: The body of the message in this conversation. created_by: type: string title: Created By description: The username of the person who created this event. is_user: type: boolean title: Is User description: Indicates that the message created by a user (as opposed to a contact). has_read: type: boolean title: Has Read description: Indicates that the message has been read. from_email: type: string title: From Email description: The email of the contact who sent the reply. avatar_url: type: string title: Avatar URL description: The gravatar URL of the contact who sent the reply. - type: object title: Note description: Activity feed item representing a note on the contact record. properties: activity_type: type: string description: The type of event activity. x-value: note enum: - note created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. updated_at_timestamp: type: string title: Updated At Timestamp format: date-time description: The updated at timestamp in ISO8601. note_id: type: string title: Note ID description: The note's unique id. note_text: type: string title: Note Text description: The note's text. created_by: type: string title: Created By description: The person who created the note. avatar_url: type: string title: Avatar URL description: The URL of the contact's profile gravatar image. - type: object title: Marketing Permission description: Activity feed item indicating if a marketing permission was added or updated. properties: activity_type: type: string description: The type of event activity. x-value: marketing_permission enum: - marketing_permission created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. marketing_permission_text: type: string title: Marketing Permission Text description: The text describing this marketing permission. updated_by: type: string title: Updated By description: The name of the contact who updated this permission. marketing_permission_opted_in: type: boolean title: Marketing Permission Opted In description: Indicates if the marketing permission is enabled or not. - type: object title: Postcard Sent description: Activity feed item representing a time when a contact was sent a particular postcard. properties: activity_type: type: string description: The type of event activity. x-value: postcard_sent enum: - postcard_sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Squatter Signup description: Activity feed item to representing a contact signing up for the audience from a squatter page. properties: activity_type: type: string description: The type of event activity. x-value: squatter_signup enum: - squatter_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Website Signup description: Activity feed item to representing a contact signing up for the contact through a website page. properties: activity_type: type: string description: The type of event activity. x-value: website_signup enum: - website_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Landing Page Signup description: Activity feed item to representing a contact signing up for the list via a landing page. properties: activity_type: type: string description: The type of event activity. x-value: landing_page_signup enum: - landing_page_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Ecommerce Signup description: Activity feed item to representing a contact signing up for the list via a ecommerce store. properties: activity_type: type: string description: The type of event activity. x-value: ecommerce_signup enum: - ecommerce_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. store_name: type: string title: Store Name description: The name of the store. - type: object title: Generic Signup description: Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to). properties: activity_type: type: string description: The type of event activity. x-value: generic_signup enum: - generic_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. signup_category: type: string title: Signup Category description: How was this user added to the list. - type: object title: Ecommerce Order description: Activity feed item that represents an order. properties: activity_type: type: string description: The type of event activity. x-value: order enum: - order created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_type: type: string title: Outreach Type description: The type of outreach that triggered the event. outreach_title: type: string title: Outreach Title description: The title of the outreach. order_id: type: string title: Order ID description: The unique order id. order_total: type: string title: Order Total description: The order total formatted as a string. order_items: type: array title: Order Items description: An array of items that have been ordered. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true store_name: type: string title: Store Name description: The name of the store for an order. order_url: type: string title: Order URL description: The order URL. integration_platform: type: string title: Integration Platform description: The name of the integration platform this order originated through. - type: object title: Contact Activity Event description: Activity feed item that represents a generic event. properties: activity_type: type: string description: The type of event activity. x-value: event enum: - event created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. event_name: type: string title: Event Name description: The name of the event. event_properties: type: array title: Event Properties items: x-skip-validation: true type: string description: An arbitrary datastore containing properties for the given event. - type: object title: Survey response description: Represents when a contact completes and submits a survey properties: activity_type: type: string description: The type of event activity. x-value: survey_response enum: - survey_response created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. survey_id: type: string title: Survey ID description: The survey's unique id. survey_title: type: string title: Survey Title description: The title of the survey. - type: object title: SMS Bulk Sent description: Activity feed item representing an SMS campaign sent to the contact. properties: activity_type: type: string description: The type of event activity. x-value: sms_bulk_sent enum: - sms_bulk_sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the SMS campaign. - type: object title: Inbox Thread description: Activity feed item representing a thread located in Inbox. properties: activity_type: type: string description: The type of event activity. x-value: inbox_thread enum: - inbox_thread created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: Thread ID description: The ID of the thread. thread_subject: type: string title: Thread Subject description: The subject of the thread. thread_url: type: string title: Thread URL description: The url of the thread. thread_direction: type: string title: Thread Direction description: The direction of the message noting if it is outbound or inbound. enum: - INBOUND - OUTBOUND thread_author: type: string title: Thread Author description: The author of the thread. - type: object title: QBO Payment Link description: Activity feed item representing a payment link from QBO. properties: activity_type: type: string description: The type of event activity. x-value: qbo_payment_link enum: - qbo_payment_link created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: id description: The QuickBooks payment link id. qbo_payment_external_id: type: string title: QBO Payment External ID description: The external QuickBooks payment id. integration_platform: type: string title: Integration Platform description: The platform Mailchimp is integrated with. enum: - quickbooks - type: object title: Video Call Transcripts description: Activity feed item representing a video call transcript. properties: activity_type: type: string description: The type of event activity. x-value: video_call_transcripts enum: - video_call_transcripts created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: id description: The id for video call transcripts. scheduled_meeting_start_timestamp: type: string title: Scheduled Meeting Start Timestamp format: date-time description: The Scheduled Meeting Start timestamp in ISO8601. expire_at_timestamp: type: string title: Expire At Timestamp format: date-time description: The Expire At timestamp in ISO8601. email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_member_activity_feed methodNameCamel: getListMemberActivityFeed x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/tags: get: summary: Mailchimp List Member Tags description: Get the tags on a list member. operationId: getListMemberTags parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value responses: '200': description: '' schema: type: object title: Collection of Tags description: A list of tags assigned to a list member. properties: tags: type: array title: Tags description: A list of tags assigned to the list member. readOnly: false items: properties: id: type: integer title: Tag ID description: The unique id for the tag. readOnly: true name: type: string title: Tag Name description: The name of the tag. date_added: type: string title: Date Added description: The date and time the tag was added to the list member in ISO 8601 format. format: date-time readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_member_tags methodNameCamel: getListMemberTags x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add or Remove Member Tags description: Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. operationId: postListMemberTags parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: body in: body required: true description: '' schema: type: object title: Member Tags description: A list of tags assigned to a list member. required: - tags properties: tags: type: array title: Tags description: A list of tags assigned to the list member. items: type: object title: Member Tag description: Add or remove tags on a member by declaring a tag either active or inactive on a member. required: - name - status properties: name: type: string title: Tag Name description: The name of the tag. status: type: string title: Status description: The status for the tag on the member, pass in active to add a tag or inactive to remove it. enum: - inactive - active is_syncing: type: boolean title: Is Syncing description: When is_syncing is true, automations based on the tags in the request will not fire example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_list_member_tags methodNameCamel: updateListMemberTags x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/events: get: summary: Mailchimp List Member Events description: Get events for a contact. operationId: getListsIdMembersIdEvents parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Collection of Events description: A collection of events for a given contact properties: events: type: array items: type: object title: Event description: A specific event for a contact. properties: occurred_at: type: string title: Occurred Time description: The date and time the event occurred in ISO 8601 format. format: date-time readOnly: true name: type: string title: Event Name description: The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length properties: type: object title: Properties description: An optional list of properties additionalProperties: type: string title: Events description: An array of objects, each representing an event. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_member_events methodNameCamel: getListMemberEvents x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Event description: Add an event for a list member. operationId: postListMemberEvents parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: body in: body description: '' required: true schema: type: object title: Events description: A new event for a specific list member required: - name properties: name: type: string title: Event Name description: The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length properties: type: object title: Properties description: An optional list of properties additionalProperties: type: string is_syncing: type: boolean title: Is Syncing description: Events created with the is_syncing value set to `true` will not trigger automations. occurred_at: type: string title: Occurred Time description: The date and time the event occurred in ISO 8601 format. format: date-time example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: create_list_member_event methodNameCamel: createListMemberEvent x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/goals: get: summary: Mailchimp List Member Goal Events description: Get the last 50 Goal events for a member on a specific list. operationId: getListsIdMembersIdGoals parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Collection of Member Activity Events description: The last 50 Goal events for a member on a specific list. properties: goals: type: array title: Goal Activity description: The last 50 Goal events triggered by a member. items: type: object title: Goal description: A single instance of a goal activity. properties: goal_id: type: integer title: Goal ID description: The id for a Goal event. event: type: string title: Event Name description: The name/type of Goal event triggered. last_visited_at: type: string title: Last Visit Date description: The date and time the user last triggered the Goal event in ISO 8601 format. format: date-time data: type: string title: Additional Data description: Any extra data passed with the Goal event. list_id: type: string title: List ID description: The list id. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: getListMemberGoals methodNameCamel: getListMemberGoals x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/notes: get: summary: Mailchimp List Recent Member Notes description: Get recent notes for a specific list member. operationId: getListsIdMembersIdNotes parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: sort_field x-title: Sort By Field description: Returns notes sorted by the specified field. in: query required: false type: string enum: - created_at - updated_at - note_id example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value responses: '200': description: '' schema: type: object title: Collection of Notes description: The last 10 notes for a specific list member, based on date created. properties: notes: type: array items: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Notes description: An array of objects, each representing a note resource. email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_member_notes methodNameCamel: getListMemberNotes x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member Note description: Add a new note for a specific subscriber. operationId: postListsIdMembersIdNotes parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: body in: body required: true description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: note: type: string title: Note description: The content of the note. Note length is limited to 1,000 characters. example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: create_list_member_note methodNameCamel: createListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}: get: summary: Mailchimp Get Member Note description: Get a specific note for a specific list member. operationId: getListsIdMembersIdNotesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: note_id x-title: Note ID in: path description: The id for the note. required: true type: string example: '500123' - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_member_note methodNameCamel: getListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Note description: Update a specific note for a specific list member. operationId: patchListsIdMembersIdNotesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: note_id x-title: Note ID in: path description: The id for the note. required: true type: string example: '500123' - name: body in: body required: true description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: note: type: string title: Note description: The content of the note. Note length is limited to 1,000 characters. example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_list_member_note methodNameCamel: updateListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Note description: Delete a specific note for a specific list member. operationId: deleteListsIdMembersIdNotesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: note_id x-title: Note ID in: path description: The id for the note. required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_list_member_note methodNameCamel: deleteListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent: post: summary: Mailchimp Delete List Member description: Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member. parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_list_member_permanent methodNameCamel: deleteListMemberPermanent operationId: postListsIdMembersHashActionsDeletePermanent x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/merge-fields: get: summary: Mailchimp List Merge Fields description: Get a list of all merge fields for an audience. operationId: getListsIdMergeFields parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: type x-title: Merge Type in: query required: false description: The merge field type. type: string example: example_value - name: required x-title: Required in: query required: false description: Whether it's a required merge field. type: boolean example: example_value responses: '200': description: '' schema: type: object title: Collection of Merge Fields description: The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_fields: type: array items: type: object title: Merge Field description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: 'In a phone field, the phone number type: US or International.' date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Merge Fields description: An array of objects, each representing a merge field resource. list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_merge_fields methodNameCamel: getListMergeFields x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Merge Field description: Add a new merge field for a specific audience. operationId: postListsIdMergeFields parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: Merge Field description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. required: - name - type properties: tag: type: string title: Merge Tag description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip required: type: boolean title: Required description: Whether the merge field is required to import a contact. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: In an address field, the default country code if none supplied. items: type: string phone_format: type: string title: Phone Type description: 'In a phone field, the phone number type: US or International.' date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. example: example_value responses: '200': description: '' schema: type: object title: Merge Field description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: 'In a phone field, the phone number type: US or International.' date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: add_list_merge_field methodNameCamel: addListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/merge-fields/{merge_id}: get: summary: Mailchimp Get Merge Field description: Get information about a specific merge field. operationId: getListsIdMergeFieldsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: merge_id x-title: Merge ID description: The id for the merge field. in: path required: true type: string example: '500123' - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Merge Field description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: 'In a phone field, the phone number type: US or International.' date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_merge_field methodNameCamel: getListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Merge Field description: Update a specific merge field. operationId: patchListsIdMergeFieldsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: merge_id x-title: Merge ID description: The id for the merge field. in: path required: true type: string example: '500123' - name: body in: body description: '' schema: type: object title: Merge Field description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. required: - name properties: tag: type: string title: Merge Tag description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). required: type: boolean title: Required description: Whether the merge field is required to import a contact. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: 'In a phone field, the phone number type: US or International.' date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: In a radio or dropdown non-group field, the available options for members to pick from. items: type: string example: - First Choice - Second Choice - Third Choice help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. required: true example: example_value responses: '200': description: '' schema: type: object title: Merge Field description: A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience. properties: merge_id: type: integer title: Merge Field ID description: An unchanging id for the merge field. readOnly: true tag: type: string title: Merge Tag description: The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts). name: type: string title: Merge Field Name description: The name of the merge field (audience field). type: type: string title: Merge Field Type description: The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field. enum: - text - number - address - phone - date - url - imageurl - radio - dropdown - birthday - zip readOnly: true required: type: boolean title: Required description: The boolean value if the merge field is required. default_value: type: string title: Default Value description: The default value for the merge field if `null`. public: type: boolean title: Merge Field Public Status description: Whether the merge field is displayed on the signup form. display_order: type: integer title: Display Order description: The order that the merge field displays on the list signup form. options: type: object title: Merge Field Options description: Extra options for some merge field types. properties: default_country: type: integer title: Default Country description: In an address field, the default country code if none supplied. phone_format: type: string title: Phone Type description: 'In a phone field, the phone number type: US or International.' date_format: type: string title: Date Type description: In a date or birthday field, the format of the date. choices: type: array title: Choices description: In a radio or dropdown non-group field, the available options for contacts to pick from. items: type: string example: - First Choice - Second Choice - Third Choice size: type: integer title: Text Field Size description: In a text field, the default length of the text field. readOnly: true help_text: type: string title: Merge Field Help Text description: Extra text to help the subscriber fill out the form. list_id: type: string title: List ID description: The ID that identifies this merge field's audience'. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_list_merge_field methodNameCamel: updateListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Merge Field description: Delete a specific merge field. operationId: deleteListsIdMergeFieldsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: merge_id x-title: Merge ID description: The id for the merge field. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_list_merge_field methodNameCamel: deleteListMergeField x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/webhooks: get: summary: Mailchimp List Webhooks description: Get information about all webhooks for a specific list. operationId: getListsIdWebhooks parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Webhooks description: Manage webhooks for a specific list. properties: webhooks: type: array items: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Webhooks description: An array of objects, each representing a specific list member. list_id: type: string title: List ID description: The list id. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_webhooks methodNameCamel: getListWebhooks x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Webhook description: Create a new webhook for a specific list. operationId: postListsIdWebhooks parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body description: '' schema: type: object title: Add Webhook description: Configure a webhook for the given list. properties: url: type: string title: URL description: A valid URL for the Webhook. example: http://yourdomain.com/webhook events: type: object title: Events description: The events that can trigger the webhook and whether they are enabled. properties: subscribe: type: boolean title: Subscribed description: Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: user: type: boolean title: User description: Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: Whether the webhook is triggered by actions initiated via the API. example: true required: true example: example_value responses: '200': description: '' schema: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: create_list_webhook methodNameCamel: createListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/webhooks/{webhook_id}: get: summary: Mailchimp Get Webhook Info description: Get information about a specific webhook. operationId: getListsIdWebhooksId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: webhook_id in: path description: The webhook's id. type: string required: true example: '500123' responses: '200': description: '' schema: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_webhook methodNameCamel: getListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Webhook description: Delete a specific webhook in a list. operationId: deleteListsIdWebhooksId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: webhook_id in: path description: The webhook's id. type: string required: true example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: delete_list_webhook methodNameCamel: deleteListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Webhook description: Update the settings for an existing webhook. operationId: patchListsIdWebhooksId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: webhook_id in: path description: The webhook's id. type: string required: true example: '500123' - name: body in: body description: '' schema: type: object title: Add Webhook description: Configure a webhook for the given list. properties: url: type: string title: URL description: A valid URL for the Webhook. example: http://yourdomain.com/webhook events: type: object title: Events description: The events that can trigger the webhook and whether they are enabled. properties: subscribe: type: boolean title: Subscribed description: Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: The possible sources of any events that can trigger the webhook and whether they are enabled. properties: user: type: boolean title: User description: Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: Whether the webhook is triggered by actions initiated via the API. example: true required: true example: example_value responses: '200': description: '' schema: type: object title: List Webhooks description: Webhook configured for the given list. properties: id: type: string title: Unique ID description: An string that uniquely identifies this webhook. readOnly: true example: 5d9a5e3f7b url: type: string title: URL description: A valid URL for the Webhook. readOnly: true example: http://yourdomain.com/webhook events: type: object title: Events description: The events that can trigger the webhook and whether they are enabled. readOnly: true properties: subscribe: type: boolean title: Subscribed description: Whether the webhook is triggered when a list subscriber is added. example: true unsubscribe: type: boolean title: Unsubscribed description: Whether the webhook is triggered when a list member unsubscribes. example: true profile: type: boolean title: Profile Updated description: Whether the webhook is triggered when a subscriber's profile is updated. example: true cleaned: type: boolean title: Cleaned description: Whether the webhook is triggered when a subscriber's email address is cleaned from the list. example: true upemail: type: boolean title: Email Address Updated description: Whether the webhook is triggered when a subscriber's email address is changed. example: true campaign: type: boolean title: Campaign Sent description: Whether the webhook is triggered when a campaign is sent or cancelled. example: true sources: type: object title: Sources description: The possible sources of any events that can trigger the webhook and whether they are enabled. readOnly: true properties: user: type: boolean title: User description: Whether the webhook is triggered by subscriber-initiated actions. example: true admin: type: boolean title: Admin description: Whether the webhook is triggered by admin-initiated actions in the web interface. example: true api: type: boolean title: API description: Whether the webhook is triggered by actions initiated via the API. example: true list_id: type: string title: List ID description: The unique id for the list. readOnly: true example: 4ca5becb8d _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_list_webhook methodNameCamel: updateListWebhook x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/signup-forms: get: summary: Mailchimp List Signup Forms description: Get signup forms for a specific list. operationId: getListsIdSignupForms parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Signup Forms description: List Signup Forms. properties: signup_forms: type: array items: type: object title: Signup Form description: List signup form. properties: header: type: object title: Signup form header options description: Options for customizing your signup form header. properties: image_url: type: string title: Header Image URL description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png text: type: string title: Header Text description: Header text. example: Header Text goes here image_width: type: string title: Image width description: Image width, in pixels. example: '800' image_height: type: string title: Image height description: Image height, in pixels. example: '200' image_alt: type: string title: Image Alt description: Alt text for the image. example: This is an image image_link: type: string title: Image Link description: The URL that the header image will link to. example: gotothisimage.com image_align: type: string title: Image align description: Image alignment. enum: - none - left - center - right example: center image_border_width: type: string title: Image border width description: Image border width. example: '2' image_border_style: type: string title: Image border style description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid image_border_color: type: string title: Image border color description: Image border color. example: '#896d6d' image_target: type: string title: Image target description: Image link target. enum: - _blank - 'null' example: _blank contents: type: array items: type: object title: Collection of Content for List Signup Forms description: Collection of Content for List Signup Forms. properties: section: type: string title: Content Section Name description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message value: type: string title: Content Section Value description: The content section text. example: Signup message goes here title: Signup form body content description: The signup form body content. styles: type: array items: type: object title: Collection of Element style for List Signup Forms description: Collection of Element style for List Signup Forms. properties: selector: type: string title: Selector description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background options: type: array title: Options description: A collection of options for a selector. items: type: object title: An option for Signup Form Styles description: An option for Signup Form Styles. properties: property: type: string title: Property description: A string that identifies the property. example: background-color value: type: string title: Value description: A string that identifies value of the property. example: '#111111' title: Signup Form element style description: An array of objects, each representing an element style for the signup form. signup_form_url: type: string title: Signup form URL description: Signup form URL. list_id: type: string title: List ID description: The signup form's list id. readOnly: true example: 4ca5becb8d _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: List Signup Form description: List signup form. list_id: type: string title: List ID description: The list id. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_signup_forms methodNameCamel: getListSignupForms x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Customize Signup Form description: Customize a list's default signup form. operationId: postListsIdSignupForms parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: body in: body description: '' schema: type: object title: Signup Form description: List signup form. properties: header: type: object title: Signup form header options description: Options for customizing your signup form header. properties: image_url: type: string title: Header Image URL description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png text: type: string title: Header Text description: Header text. example: Header Text goes here image_width: type: string title: Image width description: Image width, in pixels. example: '800' image_height: type: string title: Image height description: Image height, in pixels. example: '200' image_alt: type: string title: Image Alt description: Alt text for the image. example: This is an image image_link: type: string title: Image Link description: The URL that the header image will link to. example: gotothisimage.com image_align: type: string title: Image align description: Image alignment. enum: - none - left - center - right example: center image_border_width: type: string title: Image border width description: Image border width. example: '2' image_border_style: type: string title: Image border style description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid image_border_color: type: string title: Image border color description: Image border color. example: '#896d6d' image_target: type: string title: Image target description: Image link target. enum: - _blank - 'null' example: _blank contents: type: array items: type: object title: Collection of Content for List Signup Forms description: Collection of Content for List Signup Forms. properties: section: type: string title: Content Section Name description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message value: type: string title: Content Section Value description: The content section text. example: Signup message goes here title: Signup form body content description: The signup form body content. styles: type: array items: type: object title: Collection of Element style for List Signup Forms description: Collection of Element style for List Signup Forms. properties: selector: type: string title: Selector description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background options: type: array title: Options description: A collection of options for a selector. items: type: object title: An option for Signup Form Styles description: An option for Signup Form Styles. properties: property: type: string title: Property description: A string that identifies the property. example: background-color value: type: string title: Value description: A string that identifies value of the property. example: '#111111' title: Signup Form element style description: An array of objects, each representing an element style for the signup form. required: true example: example_value responses: '200': description: '' schema: type: object title: Signup Form description: List signup form. properties: header: type: object title: Signup form header options description: Options for customizing your signup form header. properties: image_url: type: string title: Header Image URL description: Header image URL. example: http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png text: type: string title: Header Text description: Header text. example: Header Text goes here image_width: type: string title: Image width description: Image width, in pixels. example: '800' image_height: type: string title: Image height description: Image height, in pixels. example: '200' image_alt: type: string title: Image Alt description: Alt text for the image. example: This is an image image_link: type: string title: Image Link description: The URL that the header image will link to. example: gotothisimage.com image_align: type: string title: Image align description: Image alignment. enum: - none - left - center - right example: center image_border_width: type: string title: Image border width description: Image border width. example: '2' image_border_style: type: string title: Image border style description: Image border style. enum: - none - solid - dotted - dashed - double - groove - outset - inset - ridge example: solid image_border_color: type: string title: Image border color description: Image border color. example: '#896d6d' image_target: type: string title: Image target description: Image link target. enum: - _blank - 'null' example: _blank contents: type: array items: type: object title: Collection of Content for List Signup Forms description: Collection of Content for List Signup Forms. properties: section: type: string title: Content Section Name description: The content section name. enum: - signup_message - unsub_message - signup_thank_you_title example: signup_message value: type: string title: Content Section Value description: The content section text. example: Signup message goes here title: Signup form body content description: The signup form body content. styles: type: array items: type: object title: Collection of Element style for List Signup Forms description: Collection of Element style for List Signup Forms. properties: selector: type: string title: Selector description: A string that identifies the element selector. enum: - page_background - page_header - page_outer_wrapper - body_background - body_link_style - forms_buttons - forms_buttons_hovered - forms_field_label - forms_field_text - forms_required - forms_required_legend - forms_help_text - forms_errors - monkey_rewards_badge example: page_background options: type: array title: Options description: A collection of options for a selector. items: type: object title: An option for Signup Form Styles description: An option for Signup Form Styles. properties: property: type: string title: Property description: A string that identifies the property. example: background-color value: type: string title: Value description: A string that identifies value of the property. example: '#111111' title: Signup Form element style description: An array of objects, each representing an element style for the signup form. signup_form_url: type: string title: Signup form URL description: Signup form URL. list_id: type: string title: List ID description: The signup form's list id. readOnly: true example: 4ca5becb8d _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: update_list_signup_form methodNameCamel: updateListSignupForm x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/locations: get: summary: Mailchimp List Locations description: Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address. operationId: getListsIdLocations parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: List Locations description: A summary of List's locations. properties: locations: type: array items: type: object title: List Location properties: country: type: string title: Country Name description: The name of the country. readOnly: true cc: type: string title: cc description: The ISO 3166 2 digit country code. readOnly: true percent: type: number title: percent description: The percent of subscribers in the country. readOnly: true total: type: integer title: total description: The total number of subscribers in the country. readOnly: true title: Locations description: An array of objects, each representing a list's top subscriber locations. list_id: type: string title: List ID description: The unique id for the list. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_list_locations methodNameCamel: getListLocations x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/surveys: get: summary: Mailchimp Get Information About All Surveys for a List description: Get information about all available surveys for a specific list. operationId: getListsIdSurveys parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' responses: '200': description: '' default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id x-custom-config: methodNameSnake: get_all_surveys_for_list methodNameCamel: getAllSurveysForList x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/surveys/{survey_id}: get: summary: Mailchimp Get Survey description: Get details about a specific survey. operationId: getListsIdSurveysId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: survey_id x-title: Survey ID type: string required: true description: The ID of the survey. example: '500123' responses: '200': description: '' default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - List_id 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: - List_id 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: - List_id 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: - List_id x-custom-config: methodNameSnake: create_email methodNameCamel: createEmail operationId: postListsIdSurveysIdActionsCreateEmail 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: []