swagger: '2.0' info: version: 3.0.55 title: Mailchimp Marketing Abuse 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 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: Members paths: /lists/{list_id}/segments/{segment_id}/members: get: summary: Mailchimp List Members in Segment description: Get information about members in a saved segment. operationId: getListsIdSegmentsIdMembers parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: include_cleaned in: query x-title: Include Cleaned description: Include cleaned members in response required: false type: boolean x-example: false example: example_value - name: include_transactional in: query x-title: Include Transactional description: Include transactional members in response required: false type: boolean x-example: false example: example_value - name: include_unsubscribed in: query x-title: Include Unsubscribed description: Include unsubscribed members in response required: false type: boolean x-example: false example: example_value responses: '200': description: '' schema: type: object title: Segment Members description: View members in a specific list segment. properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_segment_members_list methodNameCamel: getSegmentMembersList x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member to Segment description: Add a member to a static segment. operationId: postListsIdSegmentsIdMembers parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object required: - email_address properties: email_address: type: string title: Email Address description: Email address for a subscriber. example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: create_segment_member methodNameCamel: createSegmentMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash}: delete: summary: Mailchimp Remove List Member From Segment description: Remove a member from the specified static segment. operationId: deleteListsIdSegmentsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: segment_id x-title: Segment ID in: path description: The unique id for the segment. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: remove_segment_member methodNameCamel: removeSegmentMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members: get: summary: Mailchimp List Members Info description: Get information about members in a specific Mailchimp list. operationId: getListsIdMembers parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: email_type x-title: Email Type in: query required: false description: The email type. type: string example: user@example.com - name: status x-title: Subscriber Status in: query required: false description: The subscriber's status. type: string enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived example: example_value - name: since_timestamp_opt x-title: Since Timestamp Opt in: query description: 'Restrict results to subscribers who opted-in after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: before_timestamp_opt x-title: Before Timestamp Opt in: query description: 'Restrict results to subscribers who opted-in before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: since_last_changed x-title: Since Last Changed in: query description: 'Restrict results to subscribers whose information changed after the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: before_last_changed x-title: Before Last Changed in: query description: 'Restrict results to subscribers whose information changed before the set timeframe. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.' required: false type: string example: example_value - name: unique_email_id x-title: Unique Email ID in: query description: A unique identifier for the email address across all Mailchimp lists. required: false type: string example: user@example.com - name: vip_only x-title: VIP Only in: query description: A filter to return only the list's VIP members. Passing `true` will restrict results to VIP list members, passing `false` will return all list members. required: false type: boolean example: example_value - name: interest_category_id x-title: Interest Category ID in: query description: The unique id for the interest category. required: false type: string example: '500123' - name: interest_ids x-title: Interest Ids in: query required: false description: Used to filter list members by interests. Must be accompanied by interest_category_id and interest_match. The value must be a comma separated list of interest ids present for any supplied interest categories. type: string example: example_value - name: interest_match x-title: Interest Match in: query required: false enum: - any - all - none description: Used to filter list members by interests. Must be accompanied by interest_category_id and interest_ids. "any" will match a member with any of the interest supplied, "all" will only match members with every interest supplied, and "none" will match members without any of the interest supplied. type: string example: example_value - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - timestamp_opt - timestamp_signup - last_changed example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: since_last_campaign x-title: Since Last Campaign in: query required: false description: Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter. type: boolean example: example_value - name: unsubscribed_since x-title: Unsubscribed Since in: query required: false description: Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error. type: string example: example_value responses: '200': description: '' schema: type: object title: List Members description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. list_id: type: string title: List ID description: The list id. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_list_members_info methodNameCamel: getListMembersInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member to List description: Add a new member to the list. operationId: postListsIdMembers parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - name: skip_merge_validation x-title: Skip Merge Validation in: query description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. required: - email_address - status properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time tags: type: array title: Tags on a member description: The tags that are associated with a member. items: type: string description: The name of the tag that will be associated with this member. example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: add_list_member methodNameCamel: addListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}: get: summary: Mailchimp Get Member Info description: Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member. operationId: getListsIdMembersId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_list_member methodNameCamel: getListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Add or Update List Member description: Add or update a list member. operationId: putListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: skip_merge_validation x-title: Skip Merge Validation in: query description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. required: - email_address - status_if_new properties: email_address: type: string title: Email Address description: Email address for a subscriber. This value is required only if the email address is not already present on the list. status_if_new: type: string title: New Member Status description: Subscriber's status. This value is required only if the email address is not already present on the list. enum: - subscribed - unsubscribed - cleaned - pending - transactional email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: set_list_member methodNameCamel: setListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update List Member description: Update information for a specific list member. operationId: patchListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: skip_merge_validation x-title: Skip Merge Validation in: query description: If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. required: false type: boolean example: example_value - name: body in: body description: '' required: true schema: type: object title: Add List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: email_address: type: string title: Email Address description: Email address for a subscriber. email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. format: date-time example: example_value responses: '200': description: '' schema: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: update_list_member methodNameCamel: updateListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Archive List Member description: Archive a list member. To permanently delete, use the delete-permanent action. operationId: deleteListsIdMembersId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: delete_list_member methodNameCamel: deleteListMember x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/activity: get: summary: Mailchimp View Recent Activity 50 description: Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivity parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - in: query name: action x-title: Action type: array required: false items: type: string collectionFormat: csv enum: - - abuse - - bounce - - click - - open - - sent - - unsub - - ecomm description: A comma seperated list of actions to return. example: example_value responses: '200': description: '' schema: type: object title: Member Activity Events description: The last 50 member events for a list. properties: activity: type: array title: Activity description: An array of objects, each representing a member event. items: type: object title: Member Activity description: Member activity events. properties: action: type: string title: Action Type description: The type of action recorded for the subscriber. timestamp: type: string title: Timestamp format: date-time description: The date and time recorded for the action. url: type: string title: URL description: For clicks, the URL the subscriber clicked on. type: type: string title: Campaign Type description: The type of campaign that was sent. campaign_id: type: string title: Campaign ID description: The web-based ID for the campaign. title: type: string title: Campaign Title description: If set, the campaign's title. parent_campaign: type: string title: Parent Campaign ID description: The ID of the parent campaign. email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_list_member_activity methodNameCamel: getListMemberActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/activity-feed: get: summary: Mailchimp View Recent Activity description: Get a member's activity on a specific list, including opens, clicks, and unsubscribes. operationId: getListsIdMembersIdActivityFeed parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - in: query name: activity_filters x-title: Activity Filters type: array required: false items: type: string collectionFormat: csv enum: - - bounce - - click - - conversation - - ecommerce_signup - - event - - web_engagement - - generic_signup - - landing_page_signup - - marketing_permission - - note - - open - - order - - postcard_sent - - sent - - signup - - squatter_signup - - unsub - - website_signup - - survey_response - - sms_bulk_sent - - inbox_thread - - qbo_payment_link - - video_call_transcripts description: A comma-separated list of activity filters that correspond to a set of activity types, e.g "?activity_filters=open,bounce,click". example: example_value responses: '200': description: '' schema: type: object title: Member Activity Events description: The member activity events for a given member. x-hidden: false properties: activity: type: array title: Activity description: An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas). readOnly: true items: x-discriminator: propertyName: activity_type type: string x-oneOf: - type: object title: Email Opens description: Activity feed item representing opening an email. properties: activity_type: type: string description: The type of event activity. x-value: open enum: - open created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. - type: object title: Email Clicks description: Activity feed item representing having a link clicked by a contact. properties: activity_type: type: string description: The type of event activity. x-value: click enum: - click created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. link_clicked: type: string title: Link Clicked description: The URL of the link that was clicked. - type: object title: Email Bounced description: Activity feed item representing an email to this contact bouncing. properties: activity_type: type: string description: The type of event activity. x-value: bounce enum: - bounce created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. bounce_type: type: string title: Bounce Type description: The type of bounce. enum: - hard - soft bounce_has_open_activity: type: boolean title: Bounce Has Open Activity description: Indicates if the email associated with this bounce also has open activity on the same campaign. - type: object title: List Unsubscribed description: Activity feed item representing this contact unsubscribing from a list. properties: activity_type: type: string description: The type of event activity. x-value: unsub enum: - unsub created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Text description: The title of the campaign. is_admin_unsubscribed: type: boolean title: Is Admin Unsubscribed description: Indicates if an admin unsubscribed a contact. unsubscribe_reason: type: string title: Unsubscribe Reason description: Indicates the reason that the contact was unsubscribed. - type: object title: Email Sent description: Activity feed item representing having an email sent to the contact. properties: activity_type: type: string description: The type of event activity. x-value: sent enum: - sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. - type: object title: Email Conversation description: Activity feed item representing an individual reply in a conversation. properties: activity_type: type: string description: The type of event activity. x-value: conversation enum: - conversation created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the campaign. thread_id: type: string title: Thread ID description: The thread's unique id of the conversation referenced in this event. message_text: type: string title: Message Text description: The body of the message in this conversation. created_by: type: string title: Created By description: The username of the person who created this event. is_user: type: boolean title: Is User description: Indicates that the message created by a user (as opposed to a contact). has_read: type: boolean title: Has Read description: Indicates that the message has been read. from_email: type: string title: From Email description: The email of the contact who sent the reply. avatar_url: type: string title: Avatar URL description: The gravatar URL of the contact who sent the reply. - type: object title: Note description: Activity feed item representing a note on the contact record. properties: activity_type: type: string description: The type of event activity. x-value: note enum: - note created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. updated_at_timestamp: type: string title: Updated At Timestamp format: date-time description: The updated at timestamp in ISO8601. note_id: type: string title: Note ID description: The note's unique id. note_text: type: string title: Note Text description: The note's text. created_by: type: string title: Created By description: The person who created the note. avatar_url: type: string title: Avatar URL description: The URL of the contact's profile gravatar image. - type: object title: Marketing Permission description: Activity feed item indicating if a marketing permission was added or updated. properties: activity_type: type: string description: The type of event activity. x-value: marketing_permission enum: - marketing_permission created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. marketing_permission_text: type: string title: Marketing Permission Text description: The text describing this marketing permission. updated_by: type: string title: Updated By description: The name of the contact who updated this permission. marketing_permission_opted_in: type: boolean title: Marketing Permission Opted In description: Indicates if the marketing permission is enabled or not. - type: object title: Postcard Sent description: Activity feed item representing a time when a contact was sent a particular postcard. properties: activity_type: type: string description: The type of event activity. x-value: postcard_sent enum: - postcard_sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Squatter Signup description: Activity feed item to representing a contact signing up for the audience from a squatter page. properties: activity_type: type: string description: The type of event activity. x-value: squatter_signup enum: - squatter_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Website Signup description: Activity feed item to representing a contact signing up for the contact through a website page. properties: activity_type: type: string description: The type of event activity. x-value: website_signup enum: - website_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Landing Page Signup description: Activity feed item to representing a contact signing up for the list via a landing page. properties: activity_type: type: string description: The type of event activity. x-value: landing_page_signup enum: - landing_page_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_title: type: string title: Outreach Title description: The title of the outreach. - type: object title: Ecommerce Signup description: Activity feed item to representing a contact signing up for the list via a ecommerce store. properties: activity_type: type: string description: The type of event activity. x-value: ecommerce_signup enum: - ecommerce_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. store_name: type: string title: Store Name description: The name of the store. - type: object title: Generic Signup description: Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to). properties: activity_type: type: string description: The type of event activity. x-value: generic_signup enum: - generic_signup created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. signup_category: type: string title: Signup Category description: How was this user added to the list. - type: object title: Ecommerce Order description: Activity feed item that represents an order. properties: activity_type: type: string description: The type of event activity. x-value: order enum: - order created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. outreach_id: type: string title: Outreach ID description: The outreach's unique id. outreach_type: type: string title: Outreach Type description: The type of outreach that triggered the event. outreach_title: type: string title: Outreach Title description: The title of the outreach. order_id: type: string title: Order ID description: The unique order id. order_total: type: string title: Order Total description: The order total formatted as a string. order_items: type: array title: Order Items description: An array of items that have been ordered. items: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true store_name: type: string title: Store Name description: The name of the store for an order. order_url: type: string title: Order URL description: The order URL. integration_platform: type: string title: Integration Platform description: The name of the integration platform this order originated through. - type: object title: Contact Activity Event description: Activity feed item that represents a generic event. properties: activity_type: type: string description: The type of event activity. x-value: event enum: - event created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. event_name: type: string title: Event Name description: The name of the event. event_properties: type: array title: Event Properties items: x-skip-validation: true type: string description: An arbitrary datastore containing properties for the given event. - type: object title: Survey response description: Represents when a contact completes and submits a survey properties: activity_type: type: string description: The type of event activity. x-value: survey_response enum: - survey_response created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. survey_id: type: string title: Survey ID description: The survey's unique id. survey_title: type: string title: Survey Title description: The title of the survey. - type: object title: SMS Bulk Sent description: Activity feed item representing an SMS campaign sent to the contact. properties: activity_type: type: string description: The type of event activity. x-value: sms_bulk_sent enum: - sms_bulk_sent created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. campaign_id: type: string title: Campaign ID description: The campaign's unique id. campaign_title: type: string title: Campaign Title description: The title of the SMS campaign. - type: object title: Inbox Thread description: Activity feed item representing a thread located in Inbox. properties: activity_type: type: string description: The type of event activity. x-value: inbox_thread enum: - inbox_thread created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: Thread ID description: The ID of the thread. thread_subject: type: string title: Thread Subject description: The subject of the thread. thread_url: type: string title: Thread URL description: The url of the thread. thread_direction: type: string title: Thread Direction description: The direction of the message noting if it is outbound or inbound. enum: - INBOUND - OUTBOUND thread_author: type: string title: Thread Author description: The author of the thread. - type: object title: QBO Payment Link description: Activity feed item representing a payment link from QBO. properties: activity_type: type: string description: The type of event activity. x-value: qbo_payment_link enum: - qbo_payment_link created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: id description: The QuickBooks payment link id. qbo_payment_external_id: type: string title: QBO Payment External ID description: The external QuickBooks payment id. integration_platform: type: string title: Integration Platform description: The platform Mailchimp is integrated with. enum: - quickbooks - type: object title: Video Call Transcripts description: Activity feed item representing a video call transcript. properties: activity_type: type: string description: The type of event activity. x-value: video_call_transcripts enum: - video_call_transcripts created_at_timestamp: type: string title: Created At Timestamp format: date-time description: The created at timestamp in ISO8601. id: type: string title: id description: The id for video call transcripts. scheduled_meeting_start_timestamp: type: string title: Scheduled Meeting Start Timestamp format: date-time description: The Scheduled Meeting Start timestamp in ISO8601. expire_at_timestamp: type: string title: Expire At Timestamp format: date-time description: The Expire At timestamp in ISO8601. email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_list_member_activity_feed methodNameCamel: getListMemberActivityFeed x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/tags: get: summary: Mailchimp List Member Tags description: Get the tags on a list member. operationId: getListMemberTags parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value responses: '200': description: '' schema: type: object title: Collection of Tags description: A list of tags assigned to a list member. properties: tags: type: array title: Tags description: A list of tags assigned to the list member. readOnly: false items: properties: id: type: integer title: Tag ID description: The unique id for the tag. readOnly: true name: type: string title: Tag Name description: The name of the tag. date_added: type: string title: Date Added description: The date and time the tag was added to the list member in ISO 8601 format. format: date-time readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_list_member_tags methodNameCamel: getListMemberTags x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add or Remove Member Tags description: Add or remove tags from a list member. If a tag that does not exist is passed in and set as 'active', a new tag will be created. operationId: postListMemberTags parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: body in: body required: true description: '' schema: type: object title: Member Tags description: A list of tags assigned to a list member. required: - tags properties: tags: type: array title: Tags description: A list of tags assigned to the list member. items: type: object title: Member Tag description: Add or remove tags on a member by declaring a tag either active or inactive on a member. required: - name - status properties: name: type: string title: Tag Name description: The name of the tag. status: type: string title: Status description: The status for the tag on the member, pass in active to add a tag or inactive to remove it. enum: - inactive - active is_syncing: type: boolean title: Is Syncing description: When is_syncing is true, automations based on the tags in the request will not fire example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: update_list_member_tags methodNameCamel: updateListMemberTags x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/events: get: summary: Mailchimp List Member Events description: Get events for a contact. operationId: getListsIdMembersIdEvents parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Collection of Events description: A collection of events for a given contact properties: events: type: array items: type: object title: Event description: A specific event for a contact. properties: occurred_at: type: string title: Occurred Time description: The date and time the event occurred in ISO 8601 format. format: date-time readOnly: true name: type: string title: Event Name description: The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length properties: type: object title: Properties description: An optional list of properties additionalProperties: type: string title: Events description: An array of objects, each representing an event. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_list_member_events methodNameCamel: getListMemberEvents x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Event description: Add an event for a list member. operationId: postListMemberEvents parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: body in: body description: '' required: true schema: type: object title: Events description: A new event for a specific list member required: - name properties: name: type: string title: Event Name description: The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length properties: type: object title: Properties description: An optional list of properties additionalProperties: type: string is_syncing: type: boolean title: Is Syncing description: Events created with the is_syncing value set to `true` will not trigger automations. occurred_at: type: string title: Occurred Time description: The date and time the event occurred in ISO 8601 format. format: date-time example: example_value responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: create_list_member_event methodNameCamel: createListMemberEvent x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/goals: get: summary: Mailchimp List Member Goal Events description: Get the last 50 Goal events for a member on a specific list. operationId: getListsIdMembersIdGoals parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Collection of Member Activity Events description: The last 50 Goal events for a member on a specific list. properties: goals: type: array title: Goal Activity description: The last 50 Goal events triggered by a member. items: type: object title: Goal description: A single instance of a goal activity. properties: goal_id: type: integer title: Goal ID description: The id for a Goal event. event: type: string title: Event Name description: The name/type of Goal event triggered. last_visited_at: type: string title: Last Visit Date description: The date and time the user last triggered the Goal event in ISO 8601 format. format: date-time data: type: string title: Additional Data description: Any extra data passed with the Goal event. list_id: type: string title: List ID description: The list id. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: getListMemberGoals methodNameCamel: getListMemberGoals x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/notes: get: summary: Mailchimp List Recent Member Notes description: Get recent notes for a specific list member. operationId: getListsIdMembersIdNotes parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: sort_field x-title: Sort By Field description: Returns notes sorted by the specified field. in: query required: false type: string enum: - created_at - updated_at - note_id example: example_value - name: sort_dir x-title: Sort Direction description: Determines the order direction for sorted results. in: query required: false type: string enum: - ASC - DESC example: example_value - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value responses: '200': description: '' schema: type: object title: Collection of Notes description: The last 10 notes for a specific list member, based on date created. properties: notes: type: array items: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Notes description: An array of objects, each representing a note resource. email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_list_member_notes methodNameCamel: getListMemberNotes x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Member Note description: Add a new note for a specific subscriber. operationId: postListsIdMembersIdNotes parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value - name: body in: body required: true description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: note: type: string title: Note description: The content of the note. Note length is limited to 1,000 characters. example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: create_list_member_note methodNameCamel: createListMemberNote x-microcks-operation: delay: 0 dispatcher: FALLBACK /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}: get: summary: Mailchimp Get Member Note description: Get a specific note for a specific list member. operationId: getListsIdMembersIdNotesId parameters: - name: list_id x-title: List ID in: path description: The unique ID for the list. required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. example: example_value - name: note_id x-title: Note ID in: path description: The id for the note. required: true type: string example: '500123' - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value responses: '200': description: '' schema: type: object title: Member Notes description: A specific note for a specific member. properties: id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true updated_at: type: string title: Updated Time description: The date and time the note was last updated in ISO 8601 format. format: date-time readOnly: true note: type: string title: Note description: The content of the note. list_id: type: string title: List ID description: The unique id for the list. readOnly: true email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members 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: - Members 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: - Members 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: - Members x-custom-config: methodNameSnake: delete_list_member_permanent methodNameCamel: deleteListMemberPermanent operationId: postListsIdMembersHashActionsDeletePermanent x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/click-details/{link_id}/members: get: summary: Mailchimp List Clicked Link Subscribers description: Get information about list members who clicked on a specific link in a campaign. operationId: getReportsIdClickDetailsIdMembers parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: link_id x-title: Link ID description: The id for the link. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Click Detail Members description: A collection of members who clicked on a specific link within a campaign. properties: members: type: array items: type: object title: Click Detail Member description: A subscriber who clicked a specific URL in a specific campaign. properties: email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' readOnly: true clicks: type: integer title: Total Clicks description: The total number of times the subscriber clicked on the link. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true url_id: type: string title: URL ID description: The id for the tracked URL in the campaign. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true list_is_active: type: boolean title: List Status description: The status of the list used, namely if it's deleted or disabled. readOnly: true contact_status: type: string title: Member Status description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Lists description: An array of objects, each representing a member who clicked a specific link within a campaign. campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_subscribers_info methodNameCamel: getSubscribersInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash}: get: summary: Mailchimp Get Clicked Link Subscriber description: Get information about a specific subscriber who clicked a link in a specific campaign. operationId: getReportsIdClickDetailsIdMembersId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: link_id x-title: Link ID description: The id for the link. in: path required: true type: string example: '500123' - in: path name: subscriber_hash x-title: Subscriber Hash type: string required: true description: The MD5 hash of the lowercase version of the list member's email address. example: example_value responses: '200': description: '' schema: type: object title: Click Detail Member description: A subscriber who clicked a specific URL in a specific campaign. properties: email_id: type: string title: Email Hash description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. readOnly: true merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' readOnly: true clicks: type: integer title: Total Clicks description: The total number of times the subscriber clicked on the link. readOnly: true campaign_id: type: string title: Campaign ID description: The campaign id. readOnly: true url_id: type: string title: URL ID description: The id for the tracked URL in the campaign. readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true list_is_active: type: boolean title: List Status description: The status of the list used, namely if it's deleted or disabled. readOnly: true contact_status: type: string title: Member Status description: The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: get_subscriber_info methodNameCamel: getSubscriberInfo x-microcks-operation: delay: 0 dispatcher: FALLBACK /search-members: get: summary: Mailchimp Search Members description: Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account. operationId: getSearchMembers parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: query x-title: Query in: query description: The search query used to filter results. Query should be a valid email, or a string representing a contact's first or last name. required: true type: string example: example_value - name: list_id x-title: List ID in: query description: The unique id for the list. required: false type: string example: '500123' responses: '200': description: '' schema: type: object title: Members description: Members found for given search term properties: exact_matches: type: object description: Exact matches of the provided search query. title: Exact Matches properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true full_search: type: object description: Partial matches of the provided search query. title: Partial Matches properties: members: type: array items: type: object title: List Members description: Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed. properties: id: type: string title: Email ID description: The MD5 hash of the lowercase version of the list member's email address. readOnly: true email_address: type: string title: Email Address description: Email address for a subscriber. unique_email_id: type: string title: Unique Email ID description: An identifier for the address across all of Mailchimp. readOnly: true contact_id: type: string title: Contact ID description: As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contacts inclusion of an email address. readOnly: true full_name: type: string title: Full Name description: The contact's full name. readOnly: true web_id: type: integer title: Member Web ID description: The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`. readOnly: true email_type: type: string title: Email Type description: Type of email this member asked to get ('html' or 'text'). status: type: string title: Status description: Subscriber's current status. enum: - subscribed - unsubscribed - cleaned - pending - transactional - archived unsubscribe_reason: type: string title: Unsubscribe Reason description: A subscriber's reason for unsubscribing. consents_to_one_to_one_messaging: type: boolean title: Messaging Consent description: Indicates whether a contact consents to 1:1 messaging. readOnly: true sms_phone_number: type: string title: SMS Phone Number description: A US phone number for SMS contact. sms_subscription_status: type: string title: SMS Subscription Status description: The status of an SMS subscription. enum: - subscribed - unsubscribed - nonsubscribed - pending sms_subscription_last_updated: type: string title: SMS Subscription Last Update description: The datetime when the SMS subscription was last updated merge_fields: type: object title: Merge Fields description: A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure. additionalProperties: description: This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field. interests: type: object title: Subscriber Interests description: The key of this object's properties is the ID of the interest in question. additionalProperties: type: boolean title: Interest Value description: Keys are interest IDs, values are booleans that describe whether the list member is in that group or not. stats: type: object title: Subscriber Stats description: Open and click rates for this subscriber. readOnly: true properties: avg_open_rate: type: number title: Average Open Rate description: A subscriber's average open rate. readOnly: true avg_click_rate: type: number title: Average Click Rate description: A subscriber's average clickthrough rate. readOnly: true ecommerce_data: type: object title: Ecommerce Stats description: Ecommerce stats for the list member if the list is attached to a store. readOnly: true properties: total_revenue: type: number title: Total Revenue description: The total revenue the list member has brought in. readOnly: true number_of_orders: type: number title: Total Number of Orders description: The total number of orders placed by the list member. readOnly: true currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. readOnly: true example: USD ip_signup: type: string title: Signup IP description: IP address the subscriber signed up from. readOnly: true timestamp_signup: type: string title: Signup Timestamp description: The date and time the subscriber signed up for the list in ISO 8601 format. format: date-time readOnly: true ip_opt: type: string title: Opt-in IP description: The IP address the subscriber used to confirm their opt-in status. readOnly: true timestamp_opt: type: string title: Opt-in Timestamp description: The date and time the subscriber confirmed their opt-in status in ISO 8601 format. readOnly: true format: date-time member_rating: type: integer title: Member Rating description: Star rating for this member, between 1 and 5. readOnly: true last_changed: type: string title: Last Changed Date description: The date and time the member's info was last changed in ISO 8601 format. readOnly: true format: date-time language: type: string title: Language description: If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/). vip: type: boolean title: VIP description: '[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber.' email_client: type: string title: Email Client description: The list member's email client. readOnly: true location: type: object title: Location description: Subscriber location information. properties: latitude: type: number title: Latitude description: The location latitude. longitude: type: number title: Longitude description: The location longitude. gmtoff: type: integer title: GMT Offset description: The time difference in hours from GMT. readOnly: true dstoff: type: integer title: DST Offset description: The offset for timezones where daylight saving time is observed. readOnly: true country_code: type: string title: Country Code description: The unique code for the location country. readOnly: true timezone: type: string title: Timezone description: The timezone for the location. readOnly: true region: type: string title: Region description: The region for the location. readOnly: true marketing_permissions: type: array title: Marketing Permissions description: The marketing permissions for the subscriber. items: type: object title: Marketing Permission description: A single marketing permission a subscriber has either opted-in to or opted-out of. properties: marketing_permission_id: type: string title: Marketing Permission ID description: The id for the marketing permission on the list text: type: string title: Marketing Permission Text description: The text of the marketing permission. enabled: type: boolean title: Enabled description: If the subscriber has opted-in to the marketing permission. last_note: type: object title: Notes description: The most recent Note added about this member. readOnly: true properties: note_id: type: integer title: Note ID description: The note id. readOnly: true created_at: type: string title: Created Time description: The date and time the note was created in ISO 8601 format. format: date-time readOnly: true created_by: type: string title: Author description: The author of the note. readOnly: true note: type: string title: Note description: The content of the note. readOnly: true source: type: string title: Subscriber Source description: The source from which the subscriber was added to this list. readOnly: true tags_count: type: integer title: Tags Count description: The number of tags applied to this member. readOnly: true tags: type: array title: Tags description: Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/). readOnly: false items: type: object properties: id: type: integer title: Tag ID description: The tag id. readOnly: true name: type: string title: Tag Name description: The name of the tag readOnly: true list_id: type: string title: List ID description: The list id. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true title: Members description: An array of objects, each representing a specific list member. total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Members x-custom-config: methodNameSnake: search methodNameCamel: search 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: []