{ "opencollection": "1.0.0", "info": { "name": "Mailchimp Marketing Abuse Members API", "version": "3.0.55" }, "items": [ { "info": { "name": "Members", "type": "folder" }, "items": [ { "info": { "name": "Mailchimp List Members in Segment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id/members", "params": [ { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "example_value", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "example_value", "type": "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." }, { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "500123", "type": "path", "description": "The unique id for the segment." }, { "name": "include_cleaned", "value": "example_value", "type": "query", "description": "Include cleaned members in response" }, { "name": "include_transactional", "value": "example_value", "type": "query", "description": "Include transactional members in response" }, { "name": "include_unsubscribed", "value": "example_value", "type": "query", "description": "Include unsubscribed members in response" } ] }, "docs": "Get information about members in a saved segment." }, { "info": { "name": "Mailchimp Add Member to Segment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id/members", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "500123", "type": "path", "description": "The unique id for the segment." } ] }, "docs": "Add a member to a static segment." }, { "info": { "name": "Mailchimp Remove List Member From Segment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id/members/:subscriber_hash", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "500123", "type": "path", "description": "The unique id for the segment." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." } ] }, "docs": "Remove a member from the specified static segment." }, { "info": { "name": "Mailchimp List Members Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members", "params": [ { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "example_value", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "example_value", "type": "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." }, { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "email_type", "value": "user@example.com", "type": "query", "description": "The email type." }, { "name": "status", "value": "example_value", "type": "query", "description": "The subscriber's status." }, { "name": "since_timestamp_opt", "value": "example_value", "type": "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." }, { "name": "before_timestamp_opt", "value": "example_value", "type": "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." }, { "name": "since_last_changed", "value": "example_value", "type": "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." }, { "name": "before_last_changed", "value": "example_value", "type": "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." }, { "name": "unique_email_id", "value": "user@example.com", "type": "query", "description": "A unique identifier for the email address across all Mailchimp lists." }, { "name": "vip_only", "value": "example_value", "type": "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." }, { "name": "interest_category_id", "value": "500123", "type": "query", "description": "The unique id for the interest category." }, { "name": "interest_ids", "value": "example_value", "type": "query", "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." }, { "name": "interest_match", "value": "example_value", "type": "query", "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." }, { "name": "sort_field", "value": "example_value", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "example_value", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "since_last_campaign", "value": "example_value", "type": "query", "description": "Filter subscribers by those subscribed/unsubscribed/pending/cleaned since last email campaign send. Member status is required to use this filter." }, { "name": "unsubscribed_since", "value": "example_value", "type": "query", "description": "Filter subscribers by those unsubscribed since a specific date. Using any status other than unsubscribed with this filter will result in an error." } ] }, "docs": "Get information about members in a specific Mailchimp list." }, { "info": { "name": "Mailchimp Add Member to List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "skip_merge_validation", "value": "example_value", "type": "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." } ] }, "docs": "Add a new member to the list." }, { "info": { "name": "Mailchimp Get Member Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." } ] }, "docs": "Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member." }, { "info": { "name": "Mailchimp Add or Update List Member", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "skip_merge_validation", "value": "example_value", "type": "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." } ] }, "docs": "Add or update a list member." }, { "info": { "name": "Mailchimp Update List Member", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "skip_merge_validation", "value": "example_value", "type": "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." } ] }, "docs": "Update information for a specific list member." }, { "info": { "name": "Mailchimp Archive List Member", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." } ] }, "docs": "Archive a list member. To permanently delete, use the delete-permanent action." }, { "info": { "name": "Mailchimp View Recent Activity 50", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/activity", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "action", "value": "example_value", "type": "query", "description": "A comma seperated list of actions to return." } ] }, "docs": "Get the last 50 events of a member's activity on a specific list, including opens, clicks, and unsubscribes." }, { "info": { "name": "Mailchimp View Recent Activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/activity-feed", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "example_value", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "example_value", "type": "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." }, { "name": "activity_filters", "value": "example_value", "type": "query", "description": "A comma-separated list of activity filters that correspond to a set of activity types, e.g \"?activity_filters=open,bounce,click\"." } ] }, "docs": "Get a member's activity on a specific list, including opens, clicks, and unsubscribes." }, { "info": { "name": "Mailchimp List Member Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/tags", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "example_value", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "example_value", "type": "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." } ] }, "docs": "Get the tags on a list member." }, { "info": { "name": "Mailchimp Add or Remove Member Tags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/tags", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." } ] }, "docs": "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." }, { "info": { "name": "Mailchimp List Member Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/events", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "count", "value": "example_value", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "example_value", "type": "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." }, { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get events for a contact." }, { "info": { "name": "Mailchimp Add Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/events", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." } ] }, "docs": "Add an event for a list member." }, { "info": { "name": "Mailchimp List Member Goal Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/goals", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get the last 50 Goal events for a member on a specific list." }, { "info": { "name": "Mailchimp List Recent Member Notes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." }, { "name": "sort_field", "value": "example_value", "type": "query", "description": "Returns notes sorted by the specified field." }, { "name": "sort_dir", "value": "example_value", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "example_value", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "example_value", "type": "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." } ] }, "docs": "Get recent notes for a specific list member." }, { "info": { "name": "Mailchimp Add Member Note", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." } ] }, "docs": "Add a new note for a specific subscriber." }, { "info": { "name": "Mailchimp Get Member Note", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes/:note_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "note_id", "value": "500123", "type": "path", "description": "The id for the note." }, { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get a specific note for a specific list member." }, { "info": { "name": "Mailchimp Update Note", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes/:note_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "note_id", "value": "500123", "type": "path", "description": "The id for the note." } ] }, "docs": "Update a specific note for a specific list member." }, { "info": { "name": "Mailchimp Delete Note", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes/:note_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "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." }, { "name": "note_id", "value": "500123", "type": "path", "description": "The id for the note." } ] }, "docs": "Delete a specific note for a specific list member." }, { "info": { "name": "Mailchimp Delete List Member", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/actions/delete-permanent", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." } ] }, "docs": "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." }, { "info": { "name": "Mailchimp List Clicked Link Subscribers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/click-details/:link_id/members", "params": [ { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "example_value", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "example_value", "type": "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." }, { "name": "campaign_id", "value": "500123", "type": "path", "description": "The unique id for the campaign." }, { "name": "link_id", "value": "500123", "type": "path", "description": "The id for the link." } ] }, "docs": "Get information about list members who clicked on a specific link in a campaign." }, { "info": { "name": "Mailchimp Get Clicked Link Subscriber", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/click-details/:link_id/members/:subscriber_hash", "params": [ { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "500123", "type": "path", "description": "The unique id for the campaign." }, { "name": "link_id", "value": "500123", "type": "path", "description": "The id for the link." }, { "name": "subscriber_hash", "value": "example_value", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." } ] }, "docs": "Get information about a specific subscriber who clicked a link in a specific campaign." }, { "info": { "name": "Mailchimp Search Members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search-members", "params": [ { "name": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "query", "value": "example_value", "type": "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." }, { "name": "list_id", "value": "500123", "type": "query", "description": "The unique id for the list." } ] }, "docs": "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." } ] } ], "bundled": true }