swagger: '2.0' info: version: 3.0.55 title: Mailchimp Marketing Abuse Lists 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: Lists paths: /lists: get: summary: Mailchimp Get Lists Info description: Get information about all lists in the account. operationId: getLists parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: before_date_created x-title: Before Date Created in: query required: false description: 'Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string example: example_value - name: since_date_created x-title: Since Date Created in: query required: false description: 'Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string example: example_value - name: before_campaign_last_sent x-title: Before Campaign Last Sent in: query required: false description: 'Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string example: example_value - name: since_campaign_last_sent x-title: Since Campaign Last Sent in: query required: false description: 'Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' type: string example: example_value - name: email x-title: Subscriber Email description: Restrict results to lists that include a specific subscriber's email address. in: query required: false type: string example: user@example.com - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - date_created example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: has_ecommerce_store x-title: Has Ecommerce Store in: query required: false description: Restrict results to lists that contain an active, connected, undeleted ecommerce store. type: boolean example: example_value - name: include_total_contacts x-title: Include Total Contacts in: query description: Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state. required: false type: boolean example: example_value responses: '200': description: '' schema: type: object title: Subscriber Lists description: A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization. properties: lists: type: array items: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: '[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.' properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: '[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.' properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: 'Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.' default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Lists description: An array of objects, each representing a list. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true constraints: type: object title: Collection Authorization description: Do particular authorization constraints around this collection limit creation of new instances? properties: may_create: type: boolean title: Resource creation authorization description: May the user create additional instances of this resource? max_instances: type: integer title: Max instances description: How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited. current_total_instances: type: integer title: Current total instances description: How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited. required: - may_create - max_instances _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true required: - lists default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Lists x-custom-config: methodNameSnake: get_all_lists methodNameCamel: getAllLists x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add List description: Create a new list in your Mailchimp account. operationId: postLists parameters: - name: body in: body required: true schema: type: object title: Subscriber List description: Information about a specific list. required: - name - permission_reminder - email_type_option - contact - campaign_defaults properties: name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: '[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.' required: - company - address1 - city - country properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: '[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.' required: - from_name - from_email - subject - language properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false email_type_option: type: boolean title: Email Type Option description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. double_optin: type: boolean title: Double Opt In description: Whether or not to require the subscriber to confirm subscription via email. default: false marketing_permissions: type: boolean title: Marketing Permissions description: Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false example: example_value responses: '200': description: '' schema: type: object title: Subscriber List description: Information about a specific list. properties: id: type: string title: List ID description: A string that uniquely identifies this list. readOnly: true web_id: type: integer title: List Web ID description: The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`. readOnly: true name: type: string title: List Name description: The name of the list. contact: type: object title: List Contact description: '[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws.' properties: company: type: string title: Company Name description: The company name for the list. address1: type: string title: Address description: The street address for the list contact. address2: type: string title: Address description: The street address for the list contact. city: type: string title: City description: The city for the list contact. state: type: string title: State description: The state for the list contact. zip: type: string title: Postal Code description: The postal or zip code for the list contact. country: type: string title: Country Code description: A two-character ISO3166 country code. Defaults to US if invalid. phone: type: string title: Phone Number description: The phone number for the list contact. permission_reminder: type: string title: Permission Reminder description: The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list. use_archive_bar: type: boolean title: Use Archive Bar description: Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default. default: false campaign_defaults: type: object title: Campaign Defaults description: '[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list.' properties: from_name: type: string title: Sender's Name description: The default from name for campaigns sent to this list. from_email: type: string title: Sender's Email Address description: The default from email for campaigns sent to this list. subject: type: string title: Subject description: The default subject line for campaigns sent to this list. language: type: string title: Language description: The default language for this lists's forms. notify_on_subscribe: type: string title: Notify on Subscribe description: The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false notify_on_unsubscribe: type: string title: Notify on Unsubscribe description: The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to. default: false date_created: type: string title: Creation Date description: The date and time that this list was created in ISO 8601 format. format: date-time readOnly: true list_rating: type: integer title: List Rating description: An auto-generated activity score for the list (0-5). readOnly: true email_type_option: type: boolean title: Email Type Option description: Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup. subscribe_url_short: type: string title: Subscribe URL Short description: Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form. readOnly: true subscribe_url_long: type: string title: Subscribe URL Long description: The full version of this list's subscribe form (host will vary). readOnly: true beamer_address: type: string title: Beamer Address description: The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address. readOnly: true visibility: type: string title: Visibility enum: - pub - prv description: Legacy - visibility settings are no longer used double_optin: type: boolean title: Double Opt In description: Whether or not to require the subscriber to confirm subscription via email. default: false has_welcome: type: boolean title: Has Welcome description: 'Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup.' default: false example: false marketing_permissions: type: boolean title: Marketing Permissions description: Whether or not the list has marketing permissions (eg. GDPR) enabled. default: false modules: type: array title: Modules description: Any list-specific modules installed for this list. items: type: string readOnly: true stats: type: object title: Statistics description: Stats for the list. Many of these are cached for at least five minutes. readOnly: true properties: member_count: type: integer title: Member Count description: The number of active members in the list. readOnly: true total_contacts: type: integer title: Total Contacts description: The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included. readOnly: true unsubscribe_count: type: integer title: Unsubscribe Count description: The number of members who have unsubscribed from the list. readOnly: true cleaned_count: type: integer title: Cleaned Count description: The number of members cleaned from the list. readOnly: true member_count_since_send: type: integer title: Member Count Since Send description: The number of active members in the list since the last campaign was sent. readOnly: true unsubscribe_count_since_send: type: integer title: Unsubscribe Count Since Send description: The number of members who have unsubscribed since the last campaign was sent. readOnly: true cleaned_count_since_send: type: integer title: Cleaned Count Since Send description: The number of members cleaned from the list since the last campaign was sent. readOnly: true campaign_count: type: integer title: Campaign Count description: The number of campaigns in any status that use this list. readOnly: true campaign_last_sent: type: string format: date-time title: Campaign Last Sent description: The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients. readOnly: true merge_field_count: type: integer title: Merge Field Count description: The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL). readOnly: true avg_sub_rate: type: number title: Average Subscription Rate description: The average number of subscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true avg_unsub_rate: type: number title: Average Unsubscription Rate description: The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet). readOnly: true target_sub_rate: type: number title: Average Subscription Rate description: The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet). readOnly: true open_rate: type: number title: Open Rate description: The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true click_rate: type: number title: Click Rate description: The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet). readOnly: true last_sub_date: type: string format: date-time title: Date of Last List Subscribe description: The date and time of the last time someone subscribed to this list in ISO 8601 format. readOnly: true last_unsub_date: type: string format: date-time title: Date of Last List Unsubscribe description: The date and time of the last time someone unsubscribed from this list in ISO 8601 format. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Lists x-custom-config: methodNameSnake: create_list methodNameCamel: createList x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/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: - Lists x-custom-config: methodNameSnake: get_list_abuse_report_details methodNameCamel: getListAbuseReportDetails 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: - Lists x-custom-config: methodNameSnake: get_interest_category methodNameCamel: getInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Interest Category description: Update a specific interest category. operationId: patchListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: body in: body required: true schema: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. required: - title - type properties: title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden example: example_value responses: '200': description: '' schema: type: object title: Interest Category description: Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application. properties: list_id: type: string title: List ID description: The unique list id for the category. readOnly: true id: type: string title: Category ID description: The id for the interest category. readOnly: true title: type: string title: Name description: The text description of this category. This field appears on signup forms and is often phrased as a question. display_order: type: integer title: Display Order description: The order that the categories are displayed in the list. Lower numbers display first. type: type: string title: Display Type description: Determines how this categorys interests appear on signup forms. enum: - checkboxes - dropdown - radio - hidden _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Lists x-custom-config: methodNameSnake: update_interest_category methodNameCamel: updateInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Interest Category description: Delete a specific interest category. operationId: deleteListsIdInterestCategoriesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Lists x-custom-config: methodNameSnake: delete_interest_category methodNameCamel: deleteInterestCategory x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/interest-categories/{interest_category_id}/interests/{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: - Lists x-custom-config: methodNameSnake: get_interest_category_interest methodNameCamel: getInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Interest in Category description: Update interests or 'group names' for a specific category. operationId: patchListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' - name: body in: body required: true description: '' schema: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. required: - name properties: name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. display_order: type: integer title: Display Order description: The display order for interests. example: example_value responses: '200': description: '' schema: type: object title: Interest description: Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. properties: category_id: type: string title: Interest Category ID description: The id for the interest category. readOnly: true list_id: type: string title: List ID description: The ID for the list that this interest belongs to. readOnly: true id: type: string title: Interest ID description: The ID for the interest. readOnly: true name: type: string title: Interest Name description: The name of the interest. This can be shown publicly on a subscription form. subscriber_count: type: string title: Subscriber Count description: The number of subscribers associated with this interest. readOnly: true display_order: type: integer title: Display Order description: The display order for interests. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Lists x-custom-config: methodNameSnake: update_interest_category_interest methodNameCamel: updateInterestCategoryInterest x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Interest in Category description: Delete interests or group names in a specific category. operationId: deleteListsIdInterestCategoriesIdInterestsId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: interest_category_id x-title: Interest Category ID in: path description: The unique ID for the interest category. required: true type: string example: '500123' - name: interest_id x-title: Interest ID in: path description: The specific interest or 'group name'. required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Lists x-custom-config: methodNameSnake: delete_interest_category_interest methodNameCamel: deleteInterestCategoryInterest 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: - Lists 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: - Lists 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: - Lists 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: - Lists x-custom-config: methodNameSnake: batch_segment_members methodNameCamel: batchSegmentMembers 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: - Lists x-custom-config: methodNameSnake: remove_segment_member methodNameCamel: removeSegmentMember 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: - Lists 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: - Lists 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: - Lists 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: - Lists x-custom-config: methodNameSnake: delete_list_member methodNameCamel: deleteListMember 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: - Lists 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: - Lists 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: - Lists 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: - Lists x-custom-config: methodNameSnake: delete_list_member_permanent methodNameCamel: deleteListMemberPermanent operationId: postListsIdMembersHashActionsDeletePermanent 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: - Lists 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: - Lists 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: - Lists x-custom-config: methodNameSnake: delete_list_merge_field methodNameCamel: deleteListMergeField 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: - Lists x-custom-config: methodNameSnake: get_survey methodNameCamel: getSurvey 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: []