openapi: 3.2.0 info: version: 3.0.91 title: Mailchimp Marketing Search Members 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 servers: - url: https://server.api.mailchimp.com/3.0 security: - basicAuth: [] tags: - name: searchMembers paths: /search-members: get: summary: Search members description: Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. operationId: getSearchMembers parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false style: form explode: false schema: type: array items: type: string - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false style: form explode: false schema: type: array items: type: string - name: query x-title: Query in: query description: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. required: true schema: type: string - name: list_id x-title: List ID in: query description: The unique id for the list. required: false schema: type: string responses: '200': description: '' content: application/json: schema: type: object title: Members description: Members found for given search term properties: exact_matches: type: object description: Exact matches of the provided search query. title: Exact Matches properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true full_search: type: object description: Partial matches of the provided search query. title: Partial Matches properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true application/problem+json: schema: type: object title: Members description: Members found for given search term properties: exact_matches: type: object description: Exact matches of the provided search query. title: Exact Matches properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true full_search: type: object description: Partial matches of the provided search query. title: Partial Matches properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. content: application/json: schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 application/problem+json: schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - searchMembers x-custom-config: methodNameSnake: search methodNameCamel: search components: securitySchemes: basicAuth: type: http scheme: 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 audiences: title: Audiences (BETA) description: Your Mailchimp audience is where you store and manage all of your omni-channel contacts. The Audiences Endpoints (BETA) is available for evaluation or testing purposes only, may contain bugs or errors, and may not be as reliable as other Mailchimp features. Intuit may modify or discontinue this feature at any time without notice. By accessing the endpoints you agree to the [Audiences Endpoints (BETA) Terms of Use](https://mailchimp.com/developer/marketing/docs/audiences-introduction). Consent must be accurately mapped to the supported marketing consent values. Unsupported values - including opt-outs - must be updated manually. See [Audiences Endpoints (BETA) Documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) for terms and additional details. paths: - /audiences - /audiences/{audience_id} subResources: - audiences-contacts - audiences-contact-privacy-remove audiences-contacts: title: Contacts description: Manage contacts within a Mailchimp audience. The Audiences Endpoints (BETA) is available for evaluation or testing purposes only, may contain bugs or errors, and may not be as reliable as other Mailchimp features. Intuit may modify or discontinue this feature at any time without notice. By accessing the endpoints you agree to the [Audiences Endpoints (BETA) Terms of Use](https://mailchimp.com/developer/marketing/docs/audiences-introduction). Consent must be accurately mapped to the supported marketing consent values. Unsupported values - including opt-outs - must be updated manually. See [Audiences Endpoints (BETA) Documentation](https://mailchimp.com/developer/marketing/docs/audiences-introduction) for terms and additional details. paths: - /audiences/{audience_id}/contacts - /audiences/{audience_id}/contacts/{contact_id} - /audiences/{audience_id}/contacts/{contact_id}/actions/archive - /audiences/{audience_id}/contacts/{contact_id}/actions/forget subResources: - audiences-contacts-tags - audiences-contact-events 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: Classic 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 workflows, emails, and queues for Classic Automations. Does not include Automation flows. 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 account export or download a finished account 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 sms-campaigns: title: SMS Campaigns description: SMS Campaigns allow you to send text message marketing campaigns to your Mailchimp audience. paths: - /sms-campaigns - /sms-campaigns/{sms_campaign_id} - /sms-campaigns/{sms_campaign_id}/actions/cancel-send - /sms-campaigns/{sms_campaign_id}/actions/send - /sms-campaigns/{sms_campaign_id}/actions/schedule subResources: - sms-campaign-content sms-campaign-content: title: SMS Campaign Content description: Manage the content of an SMS campaign. paths: - /sms-campaigns/{sms_campaign_id}/content subResources: [] 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 - /connected-sites/{connected_site_id}/actions/enable-pixel - /connected-sites/{connected_site_id}/actions/disable-pixel 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: Automation flows (Previously Customer Journeys) description: Manage Automation flows 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 - /lists/{list_id}/surveys/{survey_id}/actions/replicate 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-collections ecommerce-customers: title: Customers description: Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member. paths: - /ecommerce/stores/{store_id}/customers - /ecommerce/stores/{store_id}/customers/{customer_id} ecommerce-promo-rules: title: Promo Rules description: Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes. paths: - /ecommerce/stores/{store_id}/promo-rules - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} subResources: - ecommerce-promo-codes ecommerce-promo-codes: title: Promo Codes description: Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule. paths: - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} ecommerce-orders: title: Orders description: Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account. paths: - /ecommerce/orders - /ecommerce/stores/{store_id}/orders - /ecommerce/stores/{store_id}/orders/{order_id} subResources: - ecommerce-order-lines ecommerce-order-lines: title: Order Lines description: Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases. paths: - /ecommerce/stores/{store_id}/orders/{order_id}/lines - /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} ecommerce-products: title: Products description: E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant. paths: - /ecommerce/stores/{store_id}/products - /ecommerce/stores/{store_id}/products/{product_id} subResources: - ecommerce-product-variants - ecommerce-product-images ecommerce-product-variants: title: Product Variants description: A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product. paths: - /ecommerce/stores/{store_id}/products/{product_id}/variants - /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} ecommerce-product-images: title: Product Images description: A Product Image represents a specific product image. paths: - /ecommerce/stores/{store_id}/products/{product_id}/images - /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} ecommerce-carts: title: Carts description: Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumer’s 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: []