{ "opencollection": "1.0.0", "info": { "name": "Mailchimp Marketing API", "version": "3.0.91" }, "items": [ { "info": { "name": "root", "type": "folder" }, "items": [ { "info": { "name": "List api root resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get links to all other resources available in the API." } ] }, { "info": { "name": "activityFeed", "type": "folder" }, "items": [ { "info": { "name": "Get latest chimp chatter", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/activity-feed/chimp-chatter", "params": [ { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Return the Chimp Chatter for this account ordered by most recent." } ] }, { "info": { "name": "accountExports", "type": "folder" }, "items": [ { "info": { "name": "List account exports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/account-exports", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get a list of account exports for a given account." }, { "info": { "name": "Add export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/account-exports" }, "docs": "Create a new account export in your Mailchimp account." } ] }, { "info": { "name": "accountExport", "type": "folder" }, "items": [ { "info": { "name": "Get account export info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/account-exports/:export_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "export_id", "value": "", "type": "path", "description": "The unique id for the account export." } ] }, "docs": "Get information about a specific account export." } ] }, { "info": { "name": "contacts", "type": "folder" }, "items": [ { "info": { "name": "Get a list of audiences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/audiences", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get information about all audiences in the account." }, { "info": { "name": "Get audience info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/audiences/:audience_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "audience_id", "value": "", "type": "path", "description": "The unique ID for the audience." } ] }, "docs": "Get information about a specific audience." }, { "info": { "name": "Archive Contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/audiences/:audience_id/contacts/:contact_id/actions/archive", "params": [ { "name": "audience_id", "value": "", "type": "path", "description": "The unique ID for the audience." }, { "name": "contact_id", "value": "", "type": "path", "description": "The unique id for the contact." } ] }, "docs": "Archives a Contact." }, { "info": { "name": "Forget Contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/audiences/:audience_id/contacts/:contact_id/actions/forget", "params": [ { "name": "audience_id", "value": "", "type": "path", "description": "The unique ID for the audience." }, { "name": "contact_id", "value": "", "type": "path", "description": "The unique id for the contact." } ] }, "docs": "Forgets a Contact." } ] }, { "info": { "name": "audiences", "type": "folder" }, "items": [ { "info": { "name": "Get Contacts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/audiences/:audience_id/contacts", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "cursor", "value": "", "type": "query", "description": "Paginate through a collection of records by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request. Default value fetches the first \"page\" of results." }, { "name": "created_before", "value": "", "type": "query", "description": "Restricts the response to contacts created at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00." }, { "name": "created_since", "value": "", "type": "query", "description": "Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00." }, { "name": "updated_before", "value": "", "type": "query", "description": "Restricts the response to contacts updated at or before the specified time (inclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00." }, { "name": "updated_since", "value": "", "type": "query", "description": "Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00." }, { "name": "audience_id", "value": "", "type": "path", "description": "The unique ID for the audience." }, { "name": "sort_field", "value": "", "type": "query", "description": "Specifies the field to sort the returned contacts by." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get a list of omni-channel contacts for a given audience." }, { "info": { "name": "Add Contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/audiences/:audience_id/contacts", "params": [ { "name": "audience_id", "value": "", "type": "path", "description": "The unique ID for the audience." }, { "name": "merge_field_validation_mode", "value": "", "type": "query", "description": "Defines how merge field validation is handled. When set to `ignore_required_checks`, the API does not raise an error if required merge fields are missing from the request. When set to `strict`, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, `strict` is applied by default." }, { "name": "data_mode", "value": "", "type": "query", "description": "Indicates the data processing mode. In `historical` mode, contact data changes do not trigger automations or webhooks. In `live mode`, such changes do trigger them." } ] }, "docs": "Create a new omni-channel contact for an audience." }, { "info": { "name": "Get Contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/audiences/:audience_id/contacts/:contact_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "audience_id", "value": "", "type": "path", "description": "The unique ID for the audience." }, { "name": "contact_id", "value": "", "type": "path", "description": "A unique identifier for the contact, which can be a Mailchimp contact ID or a channel hash. A channel hash must follow the format email:[md5_hash] (where the hash is the MD5 of the lowercased email address) or sms:[sha256_hash] (where the hash is the SHA256 of the E.164-formatted phone number)." } ] }, "docs": "Retrieve a specific omni-channel contact in an audience." }, { "info": { "name": "Update Contact", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/audiences/:audience_id/contacts/:contact_id", "params": [ { "name": "audience_id", "value": "", "type": "path", "description": "The unique ID for the audience." }, { "name": "contact_id", "value": "", "type": "path", "description": "The unique id for the contact." }, { "name": "merge_field_validation_mode", "value": "", "type": "query", "description": "Defines how merge field validation is handled. When set to `ignore_required_checks`, the API does not raise an error if required merge fields are missing from the request. When set to `strict`, the API enforces validation and returns an error if any required merge field is not provided. If this setting is omitted, `strict` is applied by default." }, { "name": "data_mode", "value": "", "type": "query", "description": "Indicates the data processing mode. In `historical` mode, contact data changes do not trigger automations or webhooks. In `live mode`, such changes do trigger them." } ] }, "docs": "Update an existing omni-channel contact." } ] }, { "info": { "name": "authorizedApps", "type": "folder" }, "items": [ { "info": { "name": "List authorized apps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authorized-apps", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get a list of an account's registered, connected applications." }, { "info": { "name": "Get authorized app info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authorized-apps/:app_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "app_id", "value": "", "type": "path", "description": "The unique id for the connected authorized application." } ] }, "docs": "Get information about a specific authorized application." } ] }, { "info": { "name": "automations", "type": "folder" }, "items": [ { "info": { "name": "List automations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations", "params": [ { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "before_create_time", "value": "", "type": "query", "description": "Restrict the response to automations created before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_create_time", "value": "", "type": "query", "description": "Restrict the response to automations created after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "before_start_time", "value": "", "type": "query", "description": "Restrict the response to automations started before this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_start_time", "value": "", "type": "query", "description": "Restrict the response to automations started after this time. Uses the ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "status", "value": "", "type": "query", "description": "Restrict the results to automations with the specified status." } ] }, "docs": "Get a summary of an account's classic automations." }, { "info": { "name": "Add automation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations" }, "docs": "Create a new classic automation in your Mailchimp account." }, { "info": { "name": "Get automation info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations/:workflow_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." } ] }, "docs": "Get a summary of an individual classic automation workflow's settings and content. The `trigger_settings` object returns information for the first email in the workflow." }, { "info": { "name": "Pause automation emails", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations/:workflow_id/actions/pause-all-emails", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." } ] }, "docs": "Pause all emails in a specific classic automation workflow." }, { "info": { "name": "Start automation emails", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations/:workflow_id/actions/start-all-emails", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." } ] }, "docs": "Start all emails in a classic automation workflow." }, { "info": { "name": "Archive automation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations/:workflow_id/actions/archive", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." } ] }, "docs": "Archiving will permanently end your automation and keep the report data. You’ll be able to replicate your archived automation, but you can’t restart it." }, { "info": { "name": "List automated emails", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations/:workflow_id/emails", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." } ] }, "docs": "Get a summary of the emails in a classic automation workflow." }, { "info": { "name": "Get workflow email info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." } ] }, "docs": "Get information about an individual classic automation workflow email." }, { "info": { "name": "Update workflow email", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." } ] }, "docs": "Update settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome." }, { "info": { "name": "Delete workflow email", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." } ] }, "docs": "Removes an individual classic automation workflow email. Emails from certain workflow types, including the Abandoned Cart Email (abandonedCart) and Product Retargeting Email (abandonedBrowse) Workflows, cannot be deleted." }, { "info": { "name": "List automated email subscribers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id/queue", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." } ] }, "docs": "Get information about a classic automation email queue." }, { "info": { "name": "Add subscriber to workflow email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id/queue", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." } ] }, "docs": "Manually add a subscriber to a workflow, bypassing the default trigger settings. You can also use this endpoint to trigger a series of automated emails in an API 3.0 workflow type." }, { "info": { "name": "Get automated email subscriber", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id/queue/:subscriber_hash", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." }, { "name": "subscriber_hash", "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 in a classic automation email queue." }, { "info": { "name": "Pause automated email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id/actions/pause", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." } ] }, "docs": "Pause an automated email." }, { "info": { "name": "Start automated email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations/:workflow_id/emails/:workflow_email_id/actions/start", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "workflow_email_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow email." } ] }, "docs": "Start an automated email." }, { "info": { "name": "List subscribers removed from workflow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations/:workflow_id/removed-subscribers", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." } ] }, "docs": "Get information about subscribers who were removed from a classic automation workflow." }, { "info": { "name": "Remove subscriber from workflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/automations/:workflow_id/removed-subscribers", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." } ] }, "docs": "Remove a subscriber from a specific classic automation workflow. You can remove a subscriber at any point in an automation workflow, regardless of how many emails they've been sent from that workflow. Once they're removed, they can never be added back to the same workflow." }, { "info": { "name": "Get subscriber removed from workflow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/automations/:workflow_id/removed-subscribers/:subscriber_hash", "params": [ { "name": "workflow_id", "value": "", "type": "path", "description": "The unique id for the Automation workflow." }, { "name": "subscriber_hash", "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 was removed from a classic automation workflow." } ] }, { "info": { "name": "batches", "type": "folder" }, "items": [ { "info": { "name": "List batch requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batches", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get a summary of batch requests that have been made." }, { "info": { "name": "Start batch operation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/batches" }, "docs": "Begin processing a batch operations request." }, { "info": { "name": "Get batch operation status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batches/:batch_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "batch_id", "value": "", "type": "path", "description": "The unique id for the batch operation." } ] }, "docs": "Get the status of a batch request." }, { "info": { "name": "Delete batch request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/batches/:batch_id", "params": [ { "name": "batch_id", "value": "", "type": "path", "description": "The unique id for the batch operation." } ] }, "docs": "Stops a batch request from running. Since only one batch request is run at a time, this can be used to cancel a long running request. The results of any completed operations will not be available after this call." } ] }, { "info": { "name": "batchWebhooks", "type": "folder" }, "items": [ { "info": { "name": "List batch webhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batch-webhooks", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get all webhooks that have been configured for batches." }, { "info": { "name": "Add batch webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/batch-webhooks" }, "docs": "Configure a webhook that will fire whenever any batch request completes processing. You may only have a maximum of 20 batch webhooks." }, { "info": { "name": "Get batch webhook info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batch-webhooks/:batch_webhook_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "batch_webhook_id", "value": "", "type": "path", "description": "The unique id for the batch webhook." } ] }, "docs": "Get information about a specific batch webhook." }, { "info": { "name": "Update batch webhook", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/batch-webhooks/:batch_webhook_id", "params": [ { "name": "batch_webhook_id", "value": "", "type": "path", "description": "The unique id for the batch webhook." } ] }, "docs": "Update a webhook that will fire whenever any batch request completes processing." }, { "info": { "name": "Delete batch webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/batch-webhooks/:batch_webhook_id", "params": [ { "name": "batch_webhook_id", "value": "", "type": "path", "description": "The unique id for the batch webhook." } ] }, "docs": "Remove a batch webhook. Webhooks will no longer be sent to the given URL." } ] }, { "info": { "name": "templateFolders", "type": "folder" }, "items": [ { "info": { "name": "List template folders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/template-folders", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get all folders used to organize templates." }, { "info": { "name": "Add template folder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/template-folders" }, "docs": "Create a new template folder." }, { "info": { "name": "Get template folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/template-folders/:folder_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the template folder." } ] }, "docs": "Get information about a specific folder used to organize templates." }, { "info": { "name": "Update template folder", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/template-folders/:folder_id", "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the template folder." } ] }, "docs": "Update a specific folder used to organize templates." }, { "info": { "name": "Delete template folder", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/template-folders/:folder_id", "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the template folder." } ] }, "docs": "Delete a specific template folder, and mark all the templates in the folder as 'unfiled'." } ] }, { "info": { "name": "campaignFolders", "type": "folder" }, "items": [ { "info": { "name": "List campaign folders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaign-folders", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get all folders used to organize campaigns." }, { "info": { "name": "Add campaign folder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaign-folders" }, "docs": "Create a new campaign folder." }, { "info": { "name": "Get campaign folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaign-folders/:folder_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the campaign folder." } ] }, "docs": "Get information about a specific folder used to organize campaigns." }, { "info": { "name": "Update campaign folder", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/campaign-folders/:folder_id", "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the campaign folder." } ] }, "docs": "Update a specific folder used to organize campaigns." }, { "info": { "name": "Delete campaign folder", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/campaign-folders/:folder_id", "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the campaign folder." } ] }, "docs": "Delete a specific campaign folder, and mark all the campaigns in the folder as 'unfiled'." } ] }, { "info": { "name": "campaigns", "type": "folder" }, "items": [ { "info": { "name": "List campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaigns", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "type", "value": "", "type": "query", "description": "The campaign type." }, { "name": "status", "value": "", "type": "query", "description": "The status of the campaign." }, { "name": "before_send_time", "value": "", "type": "query", "description": "Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_send_time", "value": "", "type": "query", "description": "Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "before_create_time", "value": "", "type": "query", "description": "Restrict the response to campaigns created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_create_time", "value": "", "type": "query", "description": "Restrict the response to campaigns created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "list_id", "value": "", "type": "query", "description": "The unique id for the list." }, { "name": "folder_id", "value": "", "type": "query", "description": "The unique folder id." }, { "name": "member_id", "value": "", "type": "query", "description": "Retrieve campaigns sent to a particular list member. Member ID is The MD5 hash of the lowercase version of the list member’s email address." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "include_resend_shortcut_eligibility", "value": "", "type": "query", "description": "Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered." }, { "name": "include_resend_shortcut_usage", "value": "", "type": "query", "description": "Return the `resend_shortcut_usage` field in the response. This includes information about campaigns related by a shortcut." } ] }, "docs": "Get all campaigns in an account." }, { "info": { "name": "Add campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns" }, "docs": "Create a new Mailchimp campaign." }, { "info": { "name": "Get campaign info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaigns/:campaign_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "include_resend_shortcut_eligibility", "value": "", "type": "query", "description": "Return the `resend_shortcut_eligibility` field in the response, which tells you if the campaign is eligible for the various Campaign Resend Shortcuts offered." }, { "name": "include_resend_shortcut_usage", "value": "", "type": "query", "description": "Return the `resend_shortcut_usage` field in the response. This includes information about campaigns related by a shortcut." } ] }, "docs": "Get information about a specific campaign." }, { "info": { "name": "Update campaign settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/campaigns/:campaign_id", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Update some or all of the settings for a specific campaign." }, { "info": { "name": "Delete campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/campaigns/:campaign_id", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Remove a campaign from your Mailchimp account." }, { "info": { "name": "Cancel campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/cancel-send", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Cancel a Regular or Plain-Text Campaign after you send, before all of your recipients receive it. This feature is included with Mailchimp Pro." }, { "info": { "name": "Replicate campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/replicate", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Replicate a campaign in saved or send status." }, { "info": { "name": "Send campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/send", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately." }, { "info": { "name": "Schedule campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/schedule", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Schedule a campaign for delivery. If you're using Multivariate Campaigns to test send times or sending RSS Campaigns, use the send action instead." }, { "info": { "name": "Unschedule campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/unschedule", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Unschedule a scheduled campaign that hasn't started sending." }, { "info": { "name": "Send test email", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/test", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Send a test email." }, { "info": { "name": "Pause rss campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/pause", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Pause an RSS-Driven campaign." }, { "info": { "name": "Resume rss campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/resume", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Resume an RSS-Driven campaign." }, { "info": { "name": "Resend campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/actions/create-resend", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Remove the guesswork for resending a campaign to certain segments. You can use this endpoint as a shortcut to replicate a campaign and resend it to common segments, such as those who didn't open the campaign, or any new subscribers since it was sent." }, { "info": { "name": "Get campaign content", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaigns/:campaign_id/content", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get the the HTML and plain-text content for a campaign." }, { "info": { "name": "Set campaign content", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/campaigns/:campaign_id/content", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Set the content for a campaign." }, { "info": { "name": "List campaign feedback", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaigns/:campaign_id/feedback", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get team feedback while you're working together on a Mailchimp campaign." }, { "info": { "name": "Add campaign feedback", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/campaigns/:campaign_id/feedback", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Add feedback on a specific campaign." }, { "info": { "name": "Get campaign feedback message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaigns/:campaign_id/feedback/:feedback_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "feedback_id", "value": "", "type": "path", "description": "The unique id for the feedback message." } ] }, "docs": "Get a specific feedback message from a campaign." }, { "info": { "name": "Update campaign feedback message", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/campaigns/:campaign_id/feedback/:feedback_id", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "feedback_id", "value": "", "type": "path", "description": "The unique id for the feedback message." } ] }, "docs": "Update a specific feedback message for a campaign." }, { "info": { "name": "Delete campaign feedback message", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/campaigns/:campaign_id/feedback/:feedback_id", "params": [ { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "feedback_id", "value": "", "type": "path", "description": "The unique id for the feedback message." } ] }, "docs": "Remove a specific feedback message for a campaign." }, { "info": { "name": "Get campaign send checklist", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/campaigns/:campaign_id/send-checklist", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Review the send checklist for a campaign, and resolve any issues before sending." } ] }, { "info": { "name": "connectedSites", "type": "folder" }, "items": [ { "info": { "name": "List connected sites", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/connected-sites", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get all connected sites in an account." }, { "info": { "name": "Add connected site", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/connected-sites" }, "docs": "Create a new Mailchimp connected site." }, { "info": { "name": "Get connected site", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/connected-sites/:connected_site_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "connected_site_id", "value": "", "type": "path", "description": "The unique identifier for the site." } ] }, "docs": "Get information about a specific connected site." }, { "info": { "name": "Delete connected site", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/connected-sites/:connected_site_id", "params": [ { "name": "connected_site_id", "value": "", "type": "path", "description": "The unique identifier for the site." } ] }, "docs": "Remove a connected site from your Mailchimp account." }, { "info": { "name": "Verify connected site script", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/connected-sites/:connected_site_id/actions/verify-script-installation", "params": [ { "name": "connected_site_id", "value": "", "type": "path", "description": "The unique identifier for the site." } ] }, "docs": "Verify that the connected sites script has been installed, either via the script URL or fragment." }, { "info": { "name": "Enable pixel for connected site", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/connected-sites/:connected_site_id/actions/enable-pixel", "params": [ { "name": "connected_site_id", "value": "", "type": "path", "description": "The unique identifier for the site." } ] }, "docs": "Enable the Mailchimp tracking pixel for a connected site." }, { "info": { "name": "Disable pixel for connected site", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/connected-sites/:connected_site_id/actions/disable-pixel", "params": [ { "name": "connected_site_id", "value": "", "type": "path", "description": "The unique identifier for the site." } ] }, "docs": "Disable the Mailchimp tracking pixel for a connected site." } ] }, { "info": { "name": "conversations", "type": "folder" }, "items": [ { "info": { "name": "List conversations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "has_unread_messages", "value": "", "type": "query", "description": "Whether the conversation has any unread messages." }, { "name": "list_id", "value": "", "type": "query", "description": "The unique id for the list." }, { "name": "campaign_id", "value": "", "type": "query", "description": "The unique id for the campaign." } ] }, "docs": "Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint." }, { "info": { "name": "Get conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations/:conversation_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "conversation_id", "value": "", "type": "path", "description": "The unique id for the conversation." } ] }, "docs": "Get details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint." }, { "info": { "name": "List messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations/:conversation_id/messages", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "conversation_id", "value": "", "type": "path", "description": "The unique id for the conversation." }, { "name": "is_read", "value": "", "type": "query", "description": "Whether a conversation message has been marked as read." }, { "name": "before_timestamp", "value": "", "type": "query", "description": "Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_timestamp", "value": "", "type": "query", "description": "Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." } ] }, "docs": "Get messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint." }, { "info": { "name": "Get message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations/:conversation_id/messages/:message_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "conversation_id", "value": "", "type": "path", "description": "The unique id for the conversation." }, { "name": "message_id", "value": "", "type": "path", "description": "The unique id for the conversation message." } ] }, "docs": "Get an individual message in a conversation. Conversations has been deprecated in favor of Inbox and these endpoints don't include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint." } ] }, { "info": { "name": "customerJourneys", "type": "folder" }, "items": [ { "info": { "name": "Customer Journeys API trigger for a contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/customer-journeys/journeys/:journey_id/steps/:step_id/actions/trigger", "params": [ { "name": "journey_id", "value": "", "type": "path", "description": "The id for the flow." }, { "name": "step_id", "value": "", "type": "path", "description": "The id for the Step." } ] }, "docs": "A step trigger in an Automation flow. To use it, create a starting point or step from the Automation flow builder in the app using the Customer Journey API condition. We’ll provide a url during the process that includes the {journey_id} and {step_id}. You’ll then be able to use this endpoint to trigger the condition for the posted contact." } ] }, { "info": { "name": "fileManager", "type": "folder" }, "items": [ { "info": { "name": "List stored files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/file-manager/files", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "type", "value": "", "type": "query", "description": "The file type for the File Manager file." }, { "name": "created_by", "value": "", "type": "query", "description": "The Mailchimp account user who created the File Manager file." }, { "name": "before_created_at", "value": "", "type": "query", "description": "Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_created_at", "value": "", "type": "query", "description": "Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get a list of available images and files stored in the File Manager for the account." }, { "info": { "name": "Add file", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/file-manager/files" }, "docs": "Upload a new image or file to the File Manager." }, { "info": { "name": "Get file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/file-manager/files/:file_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "file_id", "value": "", "type": "path", "description": "The unique id for the File Manager file." } ] }, "docs": "Get information about a specific file in the File Manager." }, { "info": { "name": "Update file", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/file-manager/files/:file_id", "params": [ { "name": "file_id", "value": "", "type": "path", "description": "The unique id for the File Manager file." } ] }, "docs": "Update a file in the File Manager." }, { "info": { "name": "Delete file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/file-manager/files/:file_id", "params": [ { "name": "file_id", "value": "", "type": "path", "description": "The unique id for the File Manager file." } ] }, "docs": "Remove a specific file from the File Manager." }, { "info": { "name": "List folders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/file-manager/folders", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "created_by", "value": "", "type": "query", "description": "The Mailchimp account user who created the File Manager file." }, { "name": "before_created_at", "value": "", "type": "query", "description": "Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_created_at", "value": "", "type": "query", "description": "Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." } ] }, "docs": "Get a list of all folders in the File Manager." }, { "info": { "name": "Add folder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/file-manager/folders" }, "docs": "Create a new folder in the File Manager." }, { "info": { "name": "Get folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/file-manager/folders/:folder_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the File Manager folder." } ] }, "docs": "Get information about a specific folder in the File Manager." }, { "info": { "name": "Update folder", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/file-manager/folders/:folder_id", "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the File Manager folder." } ] }, "docs": "Update a specific File Manager folder." }, { "info": { "name": "Delete folder", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/file-manager/folders/:folder_id", "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the File Manager folder." } ] }, "docs": "Delete a specific folder in the File Manager." }, { "info": { "name": "List stored files", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/file-manager/folders/:folder_id/files", "params": [ { "name": "folder_id", "value": "", "type": "path", "description": "The unique id for the File Manager folder." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "type", "value": "", "type": "query", "description": "The file type for the File Manager file." }, { "name": "created_by", "value": "", "type": "query", "description": "The Mailchimp account user who created the File Manager file." }, { "name": "before_created_at", "value": "", "type": "query", "description": "Restrict the response to files created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_created_at", "value": "", "type": "query", "description": "Restrict the response to files created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get a list of available images and files stored in this folder." } ] }, { "info": { "name": "lists", "type": "folder" }, "items": [ { "info": { "name": "Get lists info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "before_date_created", "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": "", "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": "", "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": "", "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": "", "type": "query", "description": "Restrict results to lists that include a specific subscriber's email address." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "has_ecommerce_store", "value": "", "type": "query", "description": "Restrict results to lists that contain an active, connected, undeleted ecommerce store." }, { "name": "include_total_contacts", "value": "", "type": "query", "description": "Deprecated. Return the total_contacts field in the stats response, which contains an approximate count of subscribed, unsubscribed, and transactional contacts. For a complete audience contact count, use the /audiences endpoint instead." } ] }, "docs": "Get information about all lists in the account." }, { "info": { "name": "Add list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists" }, "docs": "Create a new list in your Mailchimp account." }, { "info": { "name": "Get list info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "include_total_contacts", "value": "", "type": "query", "description": "Deprecated. Return the total_contacts field in the stats response, which contains an approximate count of subscribed, unsubscribed, and transactional contacts. For a complete audience contact count, use the /audiences endpoint instead." } ] }, "docs": "Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned." }, { "info": { "name": "Batch subscribe or unsubscribe", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "skip_merge_validation", "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." }, { "name": "skip_duplicate_check", "value": "", "type": "query", "description": "If skip_duplicate_check is true, we will ignore duplicates sent in the request when using the batch sub/unsub on the lists endpoint. The status of the first appearance in the request will be saved. This defaults to false." } ] }, "docs": "Batch subscribe or unsubscribe list members." }, { "info": { "name": "Update lists", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Update the settings for a specific list." }, { "info": { "name": "Delete list", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Delete a list from your Mailchimp account. If you delete a list, you'll lose the list history—including subscriber activity, unsubscribes, complaints, and bounces. You’ll also lose subscribers’ email addresses, unless you exported and backed up your list." }, { "info": { "name": "List abuse reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/abuse-reports", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Get all abuse reports for a specific list." }, { "info": { "name": "Get abuse report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/abuse-reports/:report_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "report_id", "value": "", "type": "path", "description": "The id for the abuse report." } ] }, "docs": "Get details about a specific abuse report." }, { "info": { "name": "List recent activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/activity", "params": [ { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Get up to the previous 180 days of daily detailed aggregated activity stats for a list, not including Automation activity." }, { "info": { "name": "List top email clients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/clients", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Get a list of the top email clients based on user-agent strings." }, { "info": { "name": "List growth history data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/growth-history", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get a month-by-month summary of a specific list's growth activity." }, { "info": { "name": "Get growth history by month", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/growth-history/:month", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "month", "value": "", "type": "path", "description": "A specific month of list growth history." } ] }, "docs": "Get a summary of a specific list's growth activity for a specific month and year." }, { "info": { "name": "List interest categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/interest-categories", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "type", "value": "", "type": "query", "description": "Restrict results a type of interest group" }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns interest categories sorted by the specified field. Defaults to display_order." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get information about a list's interest categories." }, { "info": { "name": "Add interest category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/interest-categories", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Create a new interest category." }, { "info": { "name": "Get interest category info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "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": "Update interest category", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." } ] }, "docs": "Update a specific interest category." }, { "info": { "name": "Delete interest category", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." } ] }, "docs": "Delete a specific interest category." }, { "info": { "name": "List interests in category", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id/interests", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get a list of this category's interests." }, { "info": { "name": "Add interest in category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/interest-categories/:interest_category_id/interests", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." } ] }, "docs": "Create a new interest or 'group name' for a specific category." }, { "info": { "name": "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": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." }, { "name": "interest_id", "value": "", "type": "path", "description": "The specific interest or 'group name'." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "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": "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": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." }, { "name": "interest_id", "value": "", "type": "path", "description": "The specific interest or 'group name'." } ] }, "docs": "Update interests or 'group names' for a specific category." }, { "info": { "name": "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": "", "type": "path", "description": "The unique ID for the list." }, { "name": "interest_category_id", "value": "", "type": "path", "description": "The unique ID for the interest category." }, { "name": "interest_id", "value": "", "type": "path", "description": "The specific interest or 'group name'." } ] }, "docs": "Delete interests or group names in a specific category." }, { "info": { "name": "List segments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/segments", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "type", "value": "", "type": "query", "description": "Limit results based on segment type." }, { "name": "since_created_at", "value": "", "type": "query", "description": "Restrict results to segments created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "before_created_at", "value": "", "type": "query", "description": "Restrict results to segments created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "include_cleaned", "value": "", "type": "query", "description": "Include cleaned members in response" }, { "name": "include_transactional", "value": "", "type": "query", "description": "Include transactional members in response" }, { "name": "include_unsubscribed", "value": "", "type": "query", "description": "Include unsubscribed members in response" }, { "name": "since_updated_at", "value": "", "type": "query", "description": "Restrict results to segments update after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "before_updated_at", "value": "", "type": "query", "description": "Restrict results to segments update before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "exclude_type", "value": "", "type": "query", "description": "Exclude results based on segment type. For example, use `exclude_type=static` to exclude tags from the response." } ] }, "docs": "Get information about all available segments for a specific list." }, { "info": { "name": "Add segment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/segments", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Create a new segment in a specific list." }, { "info": { "name": "Get segment info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "", "type": "path", "description": "The unique id for the segment." }, { "name": "include_cleaned", "value": "", "type": "query", "description": "Include cleaned members in response" }, { "name": "include_transactional", "value": "", "type": "query", "description": "Include transactional members in response" }, { "name": "include_unsubscribed", "value": "", "type": "query", "description": "Include unsubscribed members in response" } ] }, "docs": "Get information about a specific segment." }, { "info": { "name": "Batch add or remove members", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "", "type": "path", "description": "The unique id for the segment." } ] }, "docs": "Batch add/remove list members to static segment" }, { "info": { "name": "Update segment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "", "type": "path", "description": "The unique id for the segment." } ] }, "docs": "Update a specific segment in a list." }, { "info": { "name": "Delete segment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "", "type": "path", "description": "The unique id for the segment." } ] }, "docs": "Delete a specific segment in a list." }, { "info": { "name": "List members in segment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id/members", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "", "type": "path", "description": "The unique id for the segment." }, { "name": "include_cleaned", "value": "", "type": "query", "description": "Include cleaned members in response" }, { "name": "include_transactional", "value": "", "type": "query", "description": "Include transactional members in response" }, { "name": "include_unsubscribed", "value": "", "type": "query", "description": "Include unsubscribed members in response" } ] }, "docs": "Get information about members in a saved segment." }, { "info": { "name": "Add member to segment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/segments/:segment_id/members", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "", "type": "path", "description": "The unique id for the segment." } ] }, "docs": "Add a member to a static segment." }, { "info": { "name": "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": "", "type": "path", "description": "The unique ID for the list." }, { "name": "segment_id", "value": "", "type": "path", "description": "The unique id for the segment." }, { "name": "subscriber_hash", "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": "Search for tags on a list by name.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/tag-search", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "name", "value": "", "type": "query", "description": "The search query used to filter tags. The search query will be compared to each tag as a prefix, so all tags that have a name starting with this field will be returned." } ] }, "docs": "Search for tags on a list by name. If no name is provided, will return all tags on the list." }, { "info": { "name": "List members info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "email_type", "value": "", "type": "query", "description": "The email type." }, { "name": "status", "value": "", "type": "query", "description": "The subscriber's status." }, { "name": "since_timestamp_opt", "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": "", "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": "", "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": "", "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": "", "type": "query", "description": "A unique identifier for the email address across all Mailchimp lists." }, { "name": "vip_only", "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": "", "type": "query", "description": "The unique id for the interest category." }, { "name": "interest_ids", "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": "", "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": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "since_last_campaign", "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": "", "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": "Add member to list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "skip_merge_validation", "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": "Get member info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "Add or update list member", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "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": "Update list member", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "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": "Archive list member", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "View recent activity 50", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/activity", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "action", "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": "View recent activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/activity-feed", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "activity_filters", "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": "List member tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/tags", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get the tags on a list member." }, { "info": { "name": "Add or remove member tags", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/tags", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "List member events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/events", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "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": "Add event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/events", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "List member goal events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/goals", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "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": "List recent member notes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "value": "", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns notes sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get recent notes for a specific list member." }, { "info": { "name": "Add member note", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "Get member note", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes/:note_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "path", "description": "The id for the note." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "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": "Update note", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes/:note_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "path", "description": "The id for the note." } ] }, "docs": "Update a specific note for a specific list member." }, { "info": { "name": "Delete note", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/notes/:note_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "", "type": "path", "description": "The id for the note." } ] }, "docs": "Delete a specific note for a specific list member." }, { "info": { "name": "Delete list member", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/members/:subscriber_hash/actions/delete-permanent", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "subscriber_hash", "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": "List merge fields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/merge-fields", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "type", "value": "", "type": "query", "description": "The merge field type." }, { "name": "required", "value": "", "type": "query", "description": "Whether it's a required merge field." } ] }, "docs": "Get a list of all merge fields for an audience." }, { "info": { "name": "Add merge field", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/merge-fields", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Add a new merge field for a specific audience." }, { "info": { "name": "Get merge field", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/merge-fields/:merge_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "merge_id", "value": "", "type": "path", "description": "The id for the merge field." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "fields", "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": "Update merge field", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/merge-fields/:merge_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "merge_id", "value": "", "type": "path", "description": "The id for the merge field." } ] }, "docs": "Update a specific merge field." }, { "info": { "name": "Delete merge field", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/merge-fields/:merge_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "merge_id", "value": "", "type": "path", "description": "The id for the merge field." } ] }, "docs": "Delete a specific merge field." }, { "info": { "name": "List webhooks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/webhooks", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Get information about all webhooks for a specific list." }, { "info": { "name": "Add webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/webhooks", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Create a new webhook for a specific list." }, { "info": { "name": "Get webhook info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/webhooks/:webhook_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "webhook_id", "value": "", "type": "path", "description": "The webhook's id." } ] }, "docs": "Get information about a specific webhook." }, { "info": { "name": "Update webhook", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/webhooks/:webhook_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "webhook_id", "value": "", "type": "path", "description": "The webhook's id." } ] }, "docs": "Update the settings for an existing webhook." }, { "info": { "name": "Delete webhook", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/webhooks/:webhook_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "webhook_id", "value": "", "type": "path", "description": "The webhook's id." } ] }, "docs": "Delete a specific webhook in a list." }, { "info": { "name": "List signup forms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/signup-forms", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Get signup forms for a specific list." }, { "info": { "name": "Customize signup form", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/signup-forms", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Customize a list's default signup form." }, { "info": { "name": "List locations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/locations", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address." }, { "info": { "name": "Get information about all surveys for a list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/surveys", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Get information about all available surveys for a specific list." }, { "info": { "name": "Create survey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/surveys", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." } ] }, "docs": "Create a draft survey for an audience." }, { "info": { "name": "Get survey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Get details about a specific survey." }, { "info": { "name": "Update survey", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Update a survey. When sections is provided, send the complete section list in display order. Any existing section not included is deleted." }, { "info": { "name": "Delete survey", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Delete a survey." }, { "info": { "name": "Replicate survey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id/actions/replicate", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Replicate a survey." } ] }, { "info": { "name": "Surveys", "type": "folder" }, "items": [ { "info": { "name": "Publish a Survey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id/actions/publish", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Publish a survey that is in draft, unpublished, or has been previously published and edited." }, { "info": { "name": "Unpublish a Survey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id/actions/unpublish", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Unpublish a survey that has been published." }, { "info": { "name": "Create a Survey Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/lists/:list_id/surveys/:survey_id/actions/create-email", "params": [ { "name": "list_id", "value": "", "type": "path", "description": "The unique ID for the list." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Utilize the List ID and Survey ID to generate a Campaign that links to your survey." } ] }, { "info": { "name": "landingPages", "type": "folder" }, "items": [ { "info": { "name": "List landing pages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/landing-pages", "params": [ { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" } ] }, "docs": "Get all landing pages." }, { "info": { "name": "Add landing page", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/landing-pages", "params": [ { "name": "use_default_list", "value": "", "type": "query", "description": "Will create the Landing Page using the account's Default List instead of requiring a list_id." } ] }, "docs": "Create an unpublished and contentless Mailchimp landing page." }, { "info": { "name": "Get landing page info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/landing-pages/:page_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "page_id", "value": "", "type": "path", "description": "The unique id for the page." } ] }, "docs": "Get information about a specific page." }, { "info": { "name": "Update landing page", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/landing-pages/:page_id", "params": [ { "name": "page_id", "value": "", "type": "path", "description": "The unique id for the page." } ] }, "docs": "Update a landing page." }, { "info": { "name": "Delete landing page", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/landing-pages/:page_id", "params": [ { "name": "page_id", "value": "", "type": "path", "description": "The unique id for the page." } ] }, "docs": "Delete a landing page." }, { "info": { "name": "Publish landing page", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/landing-pages/:page_id/actions/publish", "params": [ { "name": "page_id", "value": "", "type": "path", "description": "The unique id for the page." } ] }, "docs": "Publish a landing page that is in draft, unpublished, or has been previously published and edited." }, { "info": { "name": "Unpublish landing page", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/landing-pages/:page_id/actions/unpublish", "params": [ { "name": "page_id", "value": "", "type": "path", "description": "The unique id for the page." } ] }, "docs": "Unpublish a landing page that is in draft or has been published." }, { "info": { "name": "Get landing page content", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/landing-pages/:page_id/content", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "page_id", "value": "", "type": "path", "description": "The unique id for the page." } ] }, "docs": "Get the the HTML for your landing page." } ] }, { "info": { "name": "reports", "type": "folder" }, "items": [ { "info": { "name": "List campaign reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "type", "value": "", "type": "query", "description": "The campaign type." }, { "name": "before_send_time", "value": "", "type": "query", "description": "Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "since_send_time", "value": "", "type": "query", "description": "Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." } ] }, "docs": "Get campaign reports." }, { "info": { "name": "Get campaign report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get report details for a specific sent campaign." }, { "info": { "name": "List abuse reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/abuse-reports", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get a list of abuse complaints for a specific campaign." }, { "info": { "name": "Get abuse report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/abuse-reports/:report_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "report_id", "value": "", "type": "path", "description": "The id for the abuse report." } ] }, "docs": "Get information about a specific abuse report for a campaign." }, { "info": { "name": "List campaign feedback", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/advice", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get feedback based on a campaign's statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more." }, { "info": { "name": "List campaign details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/click-details", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns click reports sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "filter_bots", "value": "", "type": "query", "description": "When true, exclude automated bot clicks so the returned click counts reflect human clicks only, matching the in-app Recipient Activity view. Filtering changes a link's counts, but never removes a link from the response. Defaults to false (all clicks)." } ] }, "docs": "Get information about clicks on specific links in your Mailchimp campaigns." }, { "info": { "name": "Get campaign link details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/click-details/:link_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "link_id", "value": "", "type": "path", "description": "The id for the link." }, { "name": "filter_bots", "value": "", "type": "query", "description": "When true, exclude automated bot clicks so the returned click counts reflect human clicks only, matching the in-app Recipient Activity view. Filtering changes a link's counts, but never removes a link from the response. Defaults to false (all clicks)." } ] }, "docs": "Get click details for a specific link in a campaign." }, { "info": { "name": "List clicked link subscribers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/click-details/:link_id/members", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "link_id", "value": "", "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": "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": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "link_id", "value": "", "type": "path", "description": "The id for the link." }, { "name": "subscriber_hash", "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": "List campaign open details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/open-details", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "since", "value": "", "type": "query", "description": "Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns open reports sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." }, { "name": "filter_bots", "value": "", "type": "query", "description": "When true, exclude automated (proxy/bot) opens so the returned open counts reflect human opens only, matching the in-app Recipient Activity view. A member whose opens are all automated is excluded from the human-only view. Defaults to false (all opens)." } ] }, "docs": "Get detailed information about any campaign emails that were opened by a list member." }, { "info": { "name": "Get opened campaign subscriber", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/open-details/:subscriber_hash", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "subscriber_hash", "value": "", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." }, { "name": "filter_bots", "value": "", "type": "query", "description": "When true, exclude automated (proxy/bot) opens so the returned open counts reflect human opens only, matching the in-app Recipient Activity view. A member whose opens are all automated is excluded from the human-only view. Defaults to false (all opens)." } ] }, "docs": "Get information about a specific subscriber who opened a campaign." }, { "info": { "name": "List domain performance stats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/domain-performance", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get statistics for the top-performing email domains in a campaign." }, { "info": { "name": "List EepURL activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/eepurl", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get a summary of social activity for the campaign, tracked by EepURL." }, { "info": { "name": "List email activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/email-activity", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "since", "value": "", "type": "query", "description": "Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "filter_bots", "value": "", "type": "query", "description": "When true, exclude automated bot and Apple Mail Privacy Protection (MPP) proxy activity so the returned activity reflects human-only opens and clicks, matching the in-app Recipient Activity view. Filtering removes events from a member's activity, but never removes the member from the response. Defaults to false (all activity)." } ] }, "docs": "Get a list of member's subscriber activity in a specific campaign." }, { "info": { "name": "Get subscriber email activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/email-activity/:subscriber_hash", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "subscriber_hash", "value": "", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." }, { "name": "since", "value": "", "type": "query", "description": "Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "filter_bots", "value": "", "type": "query", "description": "When true, exclude automated bot and Apple Mail Privacy Protection (MPP) proxy activity so the returned activity reflects human-only opens and clicks, matching the in-app Recipient Activity view. Filtering removes events from a member's activity, but never removes the member from the response. Defaults to false (all activity)." } ] }, "docs": "Get a specific list member's activity in a campaign including opens, clicks, and bounces." }, { "info": { "name": "List top open activities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/locations", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get top open locations for a specific campaign." }, { "info": { "name": "List campaign recipients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/sent-to", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get information about campaign recipients." }, { "info": { "name": "Get campaign recipient info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/sent-to/:subscriber_hash", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "subscriber_hash", "value": "", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." } ] }, "docs": "Get information about a specific campaign recipient." }, { "info": { "name": "List child campaign reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/sub-reports", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get a list of reports with child campaigns for a specific parent campaign." }, { "info": { "name": "List unsubscribed members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/unsubscribed", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." } ] }, "docs": "Get information about members who have unsubscribed from a specific campaign." }, { "info": { "name": "Get unsubscribed member", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/unsubscribed/:subscriber_hash", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "subscriber_hash", "value": "", "type": "path", "description": "The MD5 hash of the lowercase version of the list member's email address." } ] }, "docs": "Get information about a specific list member who unsubscribed from a campaign." }, { "info": { "name": "List campaign product activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports/:campaign_id/ecommerce-product-activity", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "path", "description": "The unique id for the campaign." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." } ] }, "docs": "Get breakdown of product activity for a campaign" } ] }, { "info": { "name": "templates", "type": "folder" }, "items": [ { "info": { "name": "List templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/templates", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "created_by", "value": "", "type": "query", "description": "The Mailchimp account user who created the template." }, { "name": "since_date_created", "value": "", "type": "query", "description": "Restrict the response to templates created after the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "before_date_created", "value": "", "type": "query", "description": "Restrict the response to templates created before the set date. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00." }, { "name": "type", "value": "", "type": "query", "description": "Limit results based on template type." }, { "name": "category", "value": "", "type": "query", "description": "Limit results based on category." }, { "name": "folder_id", "value": "", "type": "query", "description": "The unique folder id." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns user templates sorted by the specified field." }, { "name": "content_type", "value": "", "type": "query", "description": "Limit results based on how the template's content is put together. Only templates of type `user` can be filtered by `content_type`. If you want to retrieve saved templates created with the legacy email editor, then filter `content_type` to `template`. If you'd rather pull your saved templates for the new editor, filter to `multichannel`. For code your own templates, filter to `html`." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get a list of an account's available templates." }, { "info": { "name": "Add template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/templates" }, "docs": "Create a new template for the account. Only Classic templates are supported." }, { "info": { "name": "Get template info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/templates/:template_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "template_id", "value": "", "type": "path", "description": "The unique id for the template." } ] }, "docs": "Get information about a specific template." }, { "info": { "name": "Update template", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/templates/:template_id", "params": [ { "name": "template_id", "value": "", "type": "path", "description": "The unique id for the template." } ] }, "docs": "Update the name, HTML, or `folder_id` of an existing template." }, { "info": { "name": "Delete template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/templates/:template_id", "params": [ { "name": "template_id", "value": "", "type": "path", "description": "The unique id for the template." } ] }, "docs": "Delete a specific template." }, { "info": { "name": "View default content", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/templates/:template_id/default-content", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "template_id", "value": "", "type": "path", "description": "The unique id for the template." } ] }, "docs": "Get the sections that you can edit in a template, including each section's default content." } ] }, { "info": { "name": "ecommerce", "type": "folder" }, "items": [ { "info": { "name": "List account orders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/orders", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "campaign_id", "value": "", "type": "query", "description": "Restrict results to orders with a specific `campaign_id` value." }, { "name": "outreach_id", "value": "", "type": "query", "description": "Restrict results to orders with a specific `outreach_id` value." }, { "name": "customer_id", "value": "", "type": "query", "description": "Restrict results to orders made by a specific customer." }, { "name": "has_outreach", "value": "", "type": "query", "description": "Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad." } ] }, "docs": "Get information about an account's orders." }, { "info": { "name": "List stores", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get information about all stores in the account." }, { "info": { "name": "Add store", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores" }, "docs": "Add a new store to your Mailchimp account." }, { "info": { "name": "Get store info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Get information about a specific store." }, { "info": { "name": "Update store", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Update a store." }, { "info": { "name": "Delete store", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts." }, { "info": { "name": "List carts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Get information about a store's carts." }, { "info": { "name": "Add cart", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Add a new cart to a store." }, { "info": { "name": "Get cart info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." } ] }, "docs": "Get information about a specific cart." }, { "info": { "name": "Update cart", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." } ] }, "docs": "Update a specific cart." }, { "info": { "name": "Delete cart", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." } ] }, "docs": "Delete a cart." }, { "info": { "name": "List cart line items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id/lines", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." } ] }, "docs": "Get information about a cart's line items." }, { "info": { "name": "Add cart line item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id/lines", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." } ] }, "docs": "Add a new line item to an existing cart." }, { "info": { "name": "Get cart line item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id/lines/:line_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." }, { "name": "line_id", "value": "", "type": "path", "description": "The id for the line item of a cart." } ] }, "docs": "Get information about a specific cart line item." }, { "info": { "name": "Update cart line item", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id/lines/:line_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." }, { "name": "line_id", "value": "", "type": "path", "description": "The id for the line item of a cart." } ] }, "docs": "Update a specific cart line item." }, { "info": { "name": "Delete cart line item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/carts/:cart_id/lines/:line_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "cart_id", "value": "", "type": "path", "description": "The id for the cart." }, { "name": "line_id", "value": "", "type": "path", "description": "The id for the line item of a cart." } ] }, "docs": "Delete a specific cart line item." }, { "info": { "name": "List customers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/customers", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "email_address", "value": "", "type": "query", "description": "Restrict the response to customers with the email address." } ] }, "docs": "Get information about a store's customers." }, { "info": { "name": "Add customer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/customers", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Add a new customer to a store." }, { "info": { "name": "Get customer info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/customers/:customer_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "customer_id", "value": "", "type": "path", "description": "The id for the customer of a store." } ] }, "docs": "Get information about a specific customer." }, { "info": { "name": "Add or update customer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ecommerce/stores/:store_id/customers/:customer_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "customer_id", "value": "", "type": "path", "description": "The id for the customer of a store." } ] }, "docs": "Add or update a customer." }, { "info": { "name": "Update customer", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/customers/:customer_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "customer_id", "value": "", "type": "path", "description": "The id for the customer of a store." } ] }, "docs": "Update a customer." }, { "info": { "name": "Delete customer", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/customers/:customer_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "customer_id", "value": "", "type": "path", "description": "The id for the customer of a store." } ] }, "docs": "Delete a customer from a store." }, { "info": { "name": "List promo rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Get information about a store's promo rules." }, { "info": { "name": "Add promo rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Add a new promo rule to a store." }, { "info": { "name": "Get promo rule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." } ] }, "docs": "Get information about a specific promo rule." }, { "info": { "name": "Update promo rule", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." } ] }, "docs": "Update a promo rule." }, { "info": { "name": "Delete promo rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." } ] }, "docs": "Delete a promo rule from a store." }, { "info": { "name": "List promo codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Get information about a store's promo codes." }, { "info": { "name": "Add promo code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." } ] }, "docs": "Add a new promo code to a store." }, { "info": { "name": "Get promo code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes/:promo_code_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." }, { "name": "promo_code_id", "value": "", "type": "path", "description": "The id for the promo code of a store." } ] }, "docs": "Get information about a specific promo code." }, { "info": { "name": "Update promo code", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes/:promo_code_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." }, { "name": "promo_code_id", "value": "", "type": "path", "description": "The id for the promo code of a store." } ] }, "docs": "Update a promo code." }, { "info": { "name": "Delete promo code", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/promo-rules/:promo_rule_id/promo-codes/:promo_code_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "promo_rule_id", "value": "", "type": "path", "description": "The id for the promo rule of a store." }, { "name": "promo_code_id", "value": "", "type": "path", "description": "The id for the promo code of a store." } ] }, "docs": "Delete a promo code from a store." }, { "info": { "name": "List orders", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "customer_id", "value": "", "type": "query", "description": "Restrict results to orders made by a specific customer." }, { "name": "has_outreach", "value": "", "type": "query", "description": "Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad." }, { "name": "campaign_id", "value": "", "type": "query", "description": "Restrict results to orders with a specific `campaign_id` value." }, { "name": "outreach_id", "value": "", "type": "query", "description": "Restrict results to orders with a specific `outreach_id` value." } ] }, "docs": "Get information about a store's orders." }, { "info": { "name": "Add order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Add a new order to a store." }, { "info": { "name": "Get order info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." } ] }, "docs": "Get information about a specific order." }, { "info": { "name": "Add or update order", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." } ] }, "docs": "Add or update an order." }, { "info": { "name": "Update order", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." } ] }, "docs": "Update a specific order." }, { "info": { "name": "Delete order", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." } ] }, "docs": "Delete an order." }, { "info": { "name": "List order line items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id/lines", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." } ] }, "docs": "Get information about an order's line items." }, { "info": { "name": "Add order line item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id/lines", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." } ] }, "docs": "Add a new line item to an existing order." }, { "info": { "name": "Get order line item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id/lines/:line_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." }, { "name": "line_id", "value": "", "type": "path", "description": "The id for the line item of an order." } ] }, "docs": "Get information about a specific order line item." }, { "info": { "name": "Update order line item", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id/lines/:line_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." }, { "name": "line_id", "value": "", "type": "path", "description": "The id for the line item of an order." } ] }, "docs": "Update a specific order line item." }, { "info": { "name": "Delete order line item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/orders/:order_id/lines/:line_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "order_id", "value": "", "type": "path", "description": "The id for the order in a store." }, { "name": "line_id", "value": "", "type": "path", "description": "The id for the line item of an order." } ] }, "docs": "Delete a specific order line item." }, { "info": { "name": "List product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Get information about a store's products." }, { "info": { "name": "Add product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." } ] }, "docs": "Add a new product to a store." }, { "info": { "name": "Get product info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Get information about a specific product." }, { "info": { "name": "Create or update product", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Update a specific product." }, { "info": { "name": "Update product", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Update a specific product." }, { "info": { "name": "Delete product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Delete a product." }, { "info": { "name": "List product variants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/variants", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Get information about a product's variants." }, { "info": { "name": "Add product variant", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/variants", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Add a new variant to the product." }, { "info": { "name": "Get product variant info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." }, { "name": "variant_id", "value": "", "type": "path", "description": "The id for the product variant." } ] }, "docs": "Get information about a specific product variant." }, { "info": { "name": "Add or update product variant", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." }, { "name": "variant_id", "value": "", "type": "path", "description": "The id for the product variant." } ] }, "docs": "Add or update a product variant." }, { "info": { "name": "Update product variant", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." }, { "name": "variant_id", "value": "", "type": "path", "description": "The id for the product variant." } ] }, "docs": "Update a product variant." }, { "info": { "name": "Delete product variant", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/variants/:variant_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." }, { "name": "variant_id", "value": "", "type": "path", "description": "The id for the product variant." } ] }, "docs": "Delete a product variant." }, { "info": { "name": "List product images", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/images", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Get information about a product's images." }, { "info": { "name": "Add product image", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/images", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." } ] }, "docs": "Add a new image to the product." }, { "info": { "name": "Get product image info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/images/:image_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." }, { "name": "image_id", "value": "", "type": "path", "description": "The id for the product image." } ] }, "docs": "Get information about a specific product image." }, { "info": { "name": "Update product image", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/images/:image_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." }, { "name": "image_id", "value": "", "type": "path", "description": "The id for the product image." } ] }, "docs": "Update a product image." }, { "info": { "name": "Delete product image", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/ecommerce/stores/:store_id/products/:product_id/images/:image_id", "params": [ { "name": "store_id", "value": "", "type": "path", "description": "The store id." }, { "name": "product_id", "value": "", "type": "path", "description": "The id for the product of a store." }, { "name": "image_id", "value": "", "type": "path", "description": "The id for the product image." } ] }, "docs": "Delete a product image." } ] }, { "info": { "name": "searchCampaigns", "type": "folder" }, "items": [ { "info": { "name": "Search campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search-campaigns", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "query", "value": "", "type": "query", "description": "The search query used to filter results." } ] }, "docs": "Search all campaigns for the specified query terms." } ] }, { "info": { "name": "sms-campaigns", "type": "folder" }, "items": [ { "info": { "name": "List SMS campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms-campaigns", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get all SMS campaigns in an account." }, { "info": { "name": "Add SMS campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms-campaigns" }, "docs": "Create a new SMS campaign." }, { "info": { "name": "Get SMS campaign info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Get information about a specific SMS campaign." }, { "info": { "name": "Update SMS campaign settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id", "params": [ { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Update some or all of the settings for a specific SMS campaign." }, { "info": { "name": "Delete SMS campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id", "params": [ { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Remove an SMS campaign from your Mailchimp account." }, { "info": { "name": "Send SMS campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id/actions/send", "params": [ { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Send an SMS campaign." }, { "info": { "name": "Schedule SMS campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id/actions/schedule", "params": [ { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Schedule an SMS campaign to send at a specific time." }, { "info": { "name": "Cancel SMS campaign send", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id/actions/cancel-send", "params": [ { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Cancel a scheduled or sending SMS campaign." }, { "info": { "name": "Get SMS campaign content", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id/content", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Get the content for an SMS campaign." }, { "info": { "name": "Set SMS campaign content", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sms-campaigns/:sms_campaign_id/content", "params": [ { "name": "sms_campaign_id", "value": "", "type": "path", "description": "The unique id for the SMS campaign." } ] }, "docs": "Set the content for an SMS campaign." } ] }, { "info": { "name": "searchMembers", "type": "folder" }, "items": [ { "info": { "name": "Search members", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/search-members", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "query", "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": "", "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." } ] }, { "info": { "name": "ping", "type": "folder" }, "items": [ { "info": { "name": "Ping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ping" }, "docs": "A health check for the API that won't return any account-specific information." } ] }, { "info": { "name": "facebookAds", "type": "folder" }, "items": [ { "info": { "name": "List facebook ads", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/facebook-ads", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get list of Facebook ads." }, { "info": { "name": "Get facebook ad info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/facebook-ads/:outreach_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "outreach_id", "value": "", "type": "path", "description": "The outreach id." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get details of a Facebook ad." } ] }, { "info": { "name": "reporting", "type": "folder" }, "items": [ { "info": { "name": "List facebook ads reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/facebook-ads", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." }, { "name": "sort_dir", "value": "", "type": "query", "description": "Determines the order direction for sorted results." } ] }, "docs": "Get reports of Facebook ads." }, { "info": { "name": "Get facebook ad report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/facebook-ads/:outreach_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "outreach_id", "value": "", "type": "path", "description": "The outreach id." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get report of a Facebook ad." }, { "info": { "name": "List facebook ecommerce report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/facebook-ads/:outreach_id/ecommerce-product-activity", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." }, { "name": "outreach_id", "value": "", "type": "path", "description": "The outreach id." }, { "name": "sort_field", "value": "", "type": "query", "description": "Returns files sorted by the specified field." } ] }, "docs": "Get breakdown of product activity for an outreach." }, { "info": { "name": "Get landing page report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/landing-pages/:outreach_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "outreach_id", "value": "", "type": "path", "description": "The outreach id." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." } ] }, "docs": "Get report of a landing page." }, { "info": { "name": "List landing pages reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/landing-pages", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get reports of landing pages." }, { "info": { "name": "List survey reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/surveys", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "count", "value": "", "type": "query", "description": "The number of records to return. Default value is 10. Maximum value is 1000" }, { "name": "offset", "value": "", "type": "query", "description": "Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this is the number of records from a collection to skip. Default value is 0." } ] }, "docs": "Get reports for surveys." }, { "info": { "name": "Get survey report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/surveys/:survey_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Get report for a survey." }, { "info": { "name": "List survey question reports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/surveys/:survey_id/questions", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." } ] }, "docs": "Get reports for survey questions." }, { "info": { "name": "Get survey question report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/surveys/:survey_id/questions/:question_id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." }, { "name": "question_id", "value": "", "type": "path", "description": "The ID of the survey question." } ] }, "docs": "Get report for a survey question." }, { "info": { "name": "List answers for question", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/surveys/:survey_id/questions/:question_id/answers", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." }, { "name": "question_id", "value": "", "type": "path", "description": "The ID of the survey question." }, { "name": "respondent_familiarity_is", "value": "", "type": "query", "description": "Filter survey responses by familiarity of the respondents." } ] }, "docs": "Get answers for a survey question." }, { "info": { "name": "List survey responses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/surveys/:survey_id/responses", "params": [ { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation." }, { "name": "exclude_fields", "value": "", "type": "query", "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation." }, { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." }, { "name": "answered_question", "value": "", "type": "query", "description": "The ID of the question that was answered." }, { "name": "chose_answer", "value": "", "type": "query", "description": "The ID of the option chosen to filter responses on." }, { "name": "respondent_familiarity_is", "value": "", "type": "query", "description": "Filter survey responses by familiarity of the respondents." } ] }, "docs": "Get responses to a survey." }, { "info": { "name": "Get survey response", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reporting/surveys/:survey_id/responses/:response_id", "params": [ { "name": "survey_id", "value": "", "type": "path", "description": "The ID of the survey." }, { "name": "response_id", "value": "", "type": "path", "description": "The ID of the survey response." } ] }, "docs": "Get a single survey response." } ] }, { "info": { "name": "verifiedDomains", "type": "folder" }, "items": [ { "info": { "name": "Get domain info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/verified-domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path", "description": "The domain name." } ] }, "docs": "Get the details for a single domain on the account." }, { "info": { "name": "Delete domain", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/verified-domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path", "description": "The domain name." } ] }, "docs": "Delete a verified domain from the account." }, { "info": { "name": "Verify domain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/verified-domains/:domain_name/actions/verify", "params": [ { "name": "domain_name", "value": "", "type": "path", "description": "The domain name." } ] }, "docs": "Verify a domain for sending." }, { "info": { "name": "List sending domains", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/verified-domains" }, "docs": "Get all of the sending domains on the account." }, { "info": { "name": "Add domain to account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/verified-domains" }, "docs": "Add a domain to the account." } ] } ], "bundled": true }