{ "opencollection": "1.0.0", "info": { "name": "Mailchimp Marketing Abuse Lists API", "version": "3.0.55" }, "items": [ { "info": { "name": "Lists", "type": "folder" }, "items": [ { "info": { "name": "Mailchimp Get Lists Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists", "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": "before_date_created", "value": "example_value", "type": "query", "description": "Restrict response to lists created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_date_created", "value": "example_value", "type": "query", "description": "Restrict results to lists created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "before_campaign_last_sent", "value": "example_value", "type": "query", "description": "Restrict results to lists created before the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_campaign_last_sent", "value": "example_value", "type": "query", "description": "Restrict results to lists created after the last campaign send date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "email", "value": "user@example.com", "type": "query", "description": "Restrict results to lists that include a specific subscriber's email address." }, { "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": "has_ecommerce_store", "value": "example_value", "type": "query", "description": "Restrict results to lists that contain an active, connected, undeleted ecommerce store." }, { "name": "include_total_contacts", "value": "example_value", "type": "query", "description": "Return the total_contacts field in the stats response, which contains an approximate count of all contacts in any state." } ] }, "docs": "Get information about all lists in the account." }, { "info": { "name": "Mailchimp Add List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists" }, "docs": "Create a new list in your Mailchimp account." }, { "info": { "name": "Mailchimp Get Abuse Report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/abuse-reports/:report_id", "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": "report_id", "value": "500123", "type": "path", "description": "The id for the abuse report." } ] }, "docs": "Get details about a specific abuse report." }, { "info": { "name": "Mailchimp Get Interest Category Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "500123", "type": "path", "description": "The unique ID for the interest category." }, { "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 information about a specific interest category." }, { "info": { "name": "Mailchimp Update Interest Category", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "500123", "type": "path", "description": "The unique ID for the interest category." } ] }, "docs": "Update a specific interest category." }, { "info": { "name": "Mailchimp Delete Interest Category", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "500123", "type": "path", "description": "The unique ID for the interest category." } ] }, "docs": "Delete a specific interest category." }, { "info": { "name": "Mailchimp Get Interest in Category", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id/interests/:interest_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "500123", "type": "path", "description": "The unique ID for the interest category." }, { "name": "interest_id", "value": "500123", "type": "path", "description": "The specific interest or 'group name'." }, { "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 interests or 'group names' for a specific category." }, { "info": { "name": "Mailchimp Update Interest in Category", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id/interests/:interest_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "500123", "type": "path", "description": "The unique ID for the interest category." }, { "name": "interest_id", "value": "500123", "type": "path", "description": "The specific interest or 'group name'." } ] }, "docs": "Update interests or 'group names' for a specific category." }, { "info": { "name": "Mailchimp Delete Interest in Category", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id/interests/:interest_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "500123", "type": "path", "description": "The unique ID for the interest category." }, { "name": "interest_id", "value": "500123", "type": "path", "description": "The specific interest or 'group name'." } ] }, "docs": "Delete interests or group names in a specific category." }, { "info": { "name": "Mailchimp Get Segment Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "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": "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 a specific segment." }, { "info": { "name": "Mailchimp Batch Add or Remove Members", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "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": "Batch add/remove list members to static segment" }, { "info": { "name": "Mailchimp Update Segment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "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": "Update a specific segment in a list." }, { "info": { "name": "Mailchimp Delete Segment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "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": "Delete a specific segment in a list." }, { "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 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 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 Get Merge Field", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/merge-fields/:merge_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "merge_id", "value": "500123", "type": "path", "description": "The id for the merge field." }, { "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": "fields", "value": "example_value", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get information about a specific merge field." }, { "info": { "name": "Mailchimp Update Merge Field", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/merge-fields/:merge_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "merge_id", "value": "500123", "type": "path", "description": "The id for the merge field." } ] }, "docs": "Update a specific merge field." }, { "info": { "name": "Mailchimp Delete Merge Field", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/merge-fields/:merge_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "merge_id", "value": "500123", "type": "path", "description": "The id for the merge field." } ] }, "docs": "Delete a specific merge field." }, { "info": { "name": "Mailchimp Get Survey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id", "params": [ { "name": "list_id", "value": "500123", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "500123", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Get details about a specific survey." } ] } ], "bundled": true }