diff --git a/spec/marketing.json b/spec/marketing.json index 3275db7..a14b699 100644 --- a/spec/marketing.json +++ b/spec/marketing.json @@ -16,6 +16,32 @@ "/activity-feed/chimp-chatter" ] }, + "audiences": { + "title": "Audiences (BETA)", + "description": "Your Mailchimp audience is where you store and manage all of your omni-channel contacts. The Audiences Endpoints (BETA) is available for evaluation or testing purposes only, may contain bugs or errors, and may not be as reliable as other Mailchimp features. Intuit may modify or discontinue this feature at any time without notice. By accessing the endpoints you agree to the [Audiences Endpoints (BETA) Terms of Use](https://mailchimp.com/developer/marketing/docs/audiences-intro). Consent must be accurately mapped to the supported marketing consent values. Unsupported values - including opt-outs - must be updated manually. See [Audiences Endpoints (BETA) Documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) for terms and additional details.", + "paths": [ + "/audiences", + "/audiences/{audience_id}" + ], + "subResources": [ + "audiences-contacts", + "audiences-contact-privacy-remove" + ] + }, + "audiences-contacts": { + "title": "Contacts", + "description": "Manage contacts within a Mailchimp audience. The Audiences Endpoints (BETA) is available for evaluation or testing purposes only, may contain bugs or errors, and may not be as reliable as other Mailchimp features. Intuit may modify or discontinue this feature at any time without notice. By accessing the endpoints you agree to the [Audiences Endpoints (BETA) Terms of Use](https://mailchimp.com/developer/marketing/docs/audiences-intro). Consent must be accurately mapped to the supported marketing consent values. Unsupported values - including opt-outs - must be updated manually. See [Audiences Endpoints (BETA) Documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) for terms and additional details.", + "paths": [ + "/audiences/{audience_id}/contacts", + "/audiences/{audience_id}/contacts/{contact_id}", + "/audiences/{audience_id}/contacts/{contact_id}/actions/archive", + "/audiences/{audience_id}/contacts/{contact_id}/actions/forget" + ], + "subResources": [ + "audiences-contacts-tags", + "audiences-contact-events" + ] + }, "authorized-apps": { "title": "Authorized Apps", "description": "Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints.", @@ -25,8 +51,8 @@ ] }, "automation": { - "title": "Automations", - "description": "Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Automation flows.", + "title": "Classic Automations", + "description": "Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage workflows, emails, and queues for Classic Automations. Does not include Automation flows.", "paths": [ "/automations", "/automations/{workflow_id}", @@ -813,7 +839,7 @@ }, "swagger": "2.0", "info": { - "version": "3.0.86", + "version": "3.0.87", "title": "Mailchimp Marketing API", "contact": { "name": "Mailchimp API Support", @@ -2047,6 +2073,2385 @@ } } }, + "/audiences": { + "get": { + "summary": "Get a list of audiences", + "description": "Get information about all audiences in the account.", + "operationId": "getAudienceContacts", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "count", + "x-title": "Count", + "in": "query", + "description": "The number of records to return. Default value is 10. Maximum value is 1000", + "required": false, + "default": 10, + "maximum": 1000, + "type": "integer" + }, + { + "name": "offset", + "x-title": "Offset", + "in": "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.", + "required": false, + "default": 0, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "description": "An array of objects, each representing an audience record.", + "properties": { + "audiences": { + "title": "Audiences", + "description": "An array of objects, each representing an audience record.", + "type": "array", + "items": { + "type": "object", + "description": "An instance of an audience.", + "properties": { + "id": { + "type": "string", + "title": "Audience ID", + "description": "The unique ID for the contact.", + "example": "773280e405" + }, + "name": { + "type": "string", + "title": "Audience Name", + "description": "The name of an audience", + "example": "Example Audience" + }, + "stats": { + "type": "object", + "title": "Audience Stats", + "properties": { + "total_contacts": { + "type": "integer", + "title": "Contact Count", + "description": "The total count of all contacts in an audience", + "readOnly": true + } + } + }, + "enabled_channels": { + "type": "array", + "title": "Enabled Channels", + "description": "The communication channels enabled on an audience", + "items": { + "type": "string" + } + } + } + } + }, + "total_items": { + "type": "integer", + "title": "Item Count", + "description": "The total number of items matching the query regardless of pagination.", + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "list_audiences", + "methodNameCamel": "listAudiences" + } + } + }, + "/audiences/{audience_id}": { + "get": { + "summary": "Get audience info", + "description": "Get information about a specific audience.", + "operationId": "getAudienceId", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "audience_id", + "x-title": "Audience ID", + "in": "path", + "description": "The unique ID for the audience.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "description": "An instance of an audience.", + "properties": { + "id": { + "type": "string", + "title": "Audience ID", + "description": "The unique ID for the contact.", + "example": "773280e405" + }, + "name": { + "type": "string", + "title": "Audience Name", + "description": "The name of an audience", + "example": "Example Audience" + }, + "stats": { + "type": "object", + "title": "Audience Stats", + "properties": { + "total_contacts": { + "type": "integer", + "title": "Contact Count", + "description": "The total count of all contacts in an audience", + "readOnly": true + } + } + }, + "enabled_channels": { + "type": "array", + "title": "Enabled Channels", + "description": "The communication channels enabled on an audience", + "items": { + "type": "string" + } + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "get_audience_id", + "methodNameCamel": "getAudienceId" + } + } + }, + "/audiences/{audience_id}/contacts": { + "get": { + "summary": "A collection of Audience Contacts", + "description": "Get a list of omni-channel contacts for a given audience.", + "operationId": "getAudienceContactList", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "count", + "x-title": "Count", + "in": "query", + "description": "The number of records to return. Default value is 10. Maximum value is 1000", + "required": false, + "default": 10, + "maximum": 1000, + "type": "integer" + }, + { + "name": "cursor", + "x-title": "cursor", + "in": "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.", + "required": false, + "type": "string" + }, + { + "name": "created_before", + "x-title": "Created Before Time", + "in": "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.", + "type": "string", + "format": "date-time", + "required": false + }, + { + "name": "created_since", + "x-title": "Created Since Time", + "in": "query", + "description": "Restricts the response to contacts created after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.", + "type": "string", + "format": "date-time", + "required": false + }, + { + "name": "updated_before", + "x-title": "Updated Before Time", + "in": "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.", + "type": "string", + "format": "date-time", + "required": false + }, + { + "name": "updated_since", + "x-title": "Updated Since Time", + "in": "query", + "description": "Restricts the response to contacts updated after the specified time (exclusive). Uses ISO 8601 format: 2025-04-23T15:41:36+00:00.", + "type": "string", + "format": "date-time", + "required": false + }, + { + "name": "offset", + "x-title": "Offset", + "in": "query", + "description": "The number of records to skip before returning results. Supported for compatibility with offset-based pagination, but using the `cursor` parameter is preferred for more efficient and consistent pagination.", + "required": false, + "default": 0, + "type": "integer" + }, + { + "name": "audience_id", + "x-title": "Audience ID", + "in": "path", + "description": "The unique ID for the audience.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "description": "An array of objects, each representing a contact record.", + "properties": { + "contacts": { + "title": "Contacts", + "description": "An array of objects, each representing a contact record.", + "type": "array", + "items": { + "type": "object", + "description": "An instance of a contact.", + "properties": { + "id": { + "type": "string", + "title": "Contact ID", + "description": "The unique ID for the contact.", + "example": "7CCF816ADF6CE1B11AE09BB024A02B9B", + "readOnly": true + }, + "audience_id": { + "type": "string", + "title": "Audience ID", + "description": "The unique ID for the audience.", + "example": "773280e405", + "readOnly": true + }, + "language": { + "type": "string", + "title": "Language", + "description": "The subscribers detected language.", + "enum": [ + "en", + "ar", + "af", + "be", + "bg", + "ca", + "zh", + "zh_CN", + "hr", + "cs", + "da", + "nl", + "et", + "fa", + "fi", + "fr", + "fr_CA", + "de", + "el", + "he", + "hi", + "hu", + "is", + "id", + "ga", + "it", + "ja", + "km", + "ko", + "lv", + "lt", + "mt", + "ms", + "mk", + "no", + "pl", + "pt", + "pt_PT", + "ro", + "ru", + "sr", + "sk", + "sl", + "es", + "es_ES", + "sw", + "sv", + "ta", + "th", + "tr", + "uk", + "vi" + ], + "example": "en" + }, + "status": { + "type": "string", + "title": "Status", + "description": "The status of a contact.", + "enum": [ + "active", + "archived" + ], + "example": "active", + "readOnly": true + }, + "email_channel": { + "type": "object", + "title": "Email Channel Details", + "properties": { + "email": { + "type": "string", + "title": "Email Address", + "description": "Email address", + "example": "example@freddiemail.com" + }, + "hashed_email": { + "type": "string", + "title": "Hashed Email Address", + "description": "MD5 hash of the email address", + "example": "9115d71ba28088047d342e3bcedacd0f" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "denied", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "sms_channel": { + "type": "object", + "title": "SMS Channel Details", + "properties": { + "sms_phone": { + "type": "string", + "title": "SMS Phone Number", + "description": "SMS Phone Number", + "example": "+14045550102" + }, + "hashed_sms_phone": { + "type": "string", + "title": "Hashed SMS Phone Number", + "description": "SHA256 hash of the SMS phone number", + "example": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "The tags assigned to this contact.", + "items": { + "type": "string", + "title": "Tag Name", + "description": "The name of the tag" + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At", + "description": "The date that the contact was created.", + "readOnly": true + }, + "last_updated_at": { + "type": "string", + "format": "date-time", + "title": "Update At", + "description": "The date that the contact was last updated.", + "readOnly": true + } + } + } + }, + "next_cursor": { + "type": "string", + "title": "Next Cursor", + "description": "A cursor pointing to the last item on this page of the collection. Paginate through a collection of records by setting the `cursor` parameter on a subsequent request to this value.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "audiences", + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "list_audience_contact_list", + "methodNameCamel": "listAudienceContactList" + } + }, + "post": { + "summary": "Add Contact", + "description": "Create a new omni-channel contact for an audience.", + "operationId": "createAudienceContact", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "description": "An instance of a contact.", + "properties": { + "language": { + "type": "string", + "title": "Language", + "description": "The subscribers detected language.", + "example": "EN" + }, + "email_channel": { + "type": "object", + "title": "Email Channel Details", + "properties": { + "email": { + "type": "string", + "title": "Email Address", + "description": "Email address", + "example": "example@freddiemail.com" + }, + "marketing_consent": { + "type": "object", + "title": "Marketing Consent Details", + "description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "description": "Status of a contacts Marketing Consent", + "enum": [ + "confirmed", + "consented", + "denied", + "unknown" + ], + "example": "confirmed" + } + } + } + } + }, + "sms_channel": { + "type": "object", + "title": "SMS Channel Details", + "properties": { + "sms_phone": { + "type": "string", + "title": "SMS Phone Number", + "description": "SMS Phone Number", + "example": "+16155550128" + }, + "marketing_consent": { + "type": "object", + "title": "Marketing Consent Details", + "description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "description": "The current consent status captured for a contact\u2019s marketing communications.", + "enum": [ + "confirmed", + "consented", + "unknown" + ], + "example": "confirmed" + } + } + } + } + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.", + "items": { + "type": "string", + "title": "Tag Name" + }, + "example": [ + "new_tag", + "another_tag" + ] + } + } + } + }, + { + "name": "audience_id", + "x-title": "Audience ID", + "in": "path", + "description": "The unique ID for the audience.", + "required": true, + "type": "string" + }, + { + "name": "merge_field_validation_mode", + "x-title": "Merge Field Validation Mode", + "in": "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.", + "required": false, + "type": "string", + "enum": [ + "ignore_required_checks", + "strict" + ] + }, + { + "name": "data_mode", + "x-title": "Data Mode", + "in": "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.", + "required": false, + "type": "string", + "enum": [ + "historical", + "live" + ] + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "description": "An instance of a contact.", + "properties": { + "id": { + "type": "string", + "title": "Contact ID", + "description": "The unique ID for the contact.", + "example": "7CCF816ADF6CE1B11AE09BB024A02B9B", + "readOnly": true + }, + "audience_id": { + "type": "string", + "title": "Audience ID", + "description": "The unique ID for the audience.", + "example": "773280e405", + "readOnly": true + }, + "language": { + "type": "string", + "title": "Language", + "description": "The subscribers detected language.", + "enum": [ + "en", + "ar", + "af", + "be", + "bg", + "ca", + "zh", + "zh_CN", + "hr", + "cs", + "da", + "nl", + "et", + "fa", + "fi", + "fr", + "fr_CA", + "de", + "el", + "he", + "hi", + "hu", + "is", + "id", + "ga", + "it", + "ja", + "km", + "ko", + "lv", + "lt", + "mt", + "ms", + "mk", + "no", + "pl", + "pt", + "pt_PT", + "ro", + "ru", + "sr", + "sk", + "sl", + "es", + "es_ES", + "sw", + "sv", + "ta", + "th", + "tr", + "uk", + "vi" + ], + "example": "en" + }, + "status": { + "type": "string", + "title": "Status", + "description": "The status of a contact.", + "enum": [ + "active", + "archived" + ], + "example": "active", + "readOnly": true + }, + "email_channel": { + "type": "object", + "title": "Email Channel Details", + "properties": { + "email": { + "type": "string", + "title": "Email Address", + "description": "Email address", + "example": "example@freddiemail.com" + }, + "hashed_email": { + "type": "string", + "title": "Hashed Email Address", + "description": "MD5 hash of the email address", + "example": "9115d71ba28088047d342e3bcedacd0f" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "denied", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "sms_channel": { + "type": "object", + "title": "SMS Channel Details", + "properties": { + "sms_phone": { + "type": "string", + "title": "SMS Phone Number", + "description": "SMS Phone Number", + "example": "+14045550102" + }, + "hashed_sms_phone": { + "type": "string", + "title": "Hashed SMS Phone Number", + "description": "SHA256 hash of the SMS phone number", + "example": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "The tags assigned to this contact.", + "items": { + "type": "string", + "title": "Tag Name", + "description": "The name of the tag" + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At", + "description": "The date that the contact was created.", + "readOnly": true + }, + "last_updated_at": { + "type": "string", + "format": "date-time", + "title": "Update At", + "description": "The date that the contact was last updated.", + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "audiences", + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "create_audience_contact", + "methodNameCamel": "createAudienceContact" + } + } + }, + "/audiences/{audience_id}/contacts/{contact_id}": { + "get": { + "summary": "Get Contact", + "description": "Retrieve a specific omni-channel contact in an audience.", + "operationId": "getAudienceContact", + "parameters": [ + { + "name": "fields", + "x-title": "Fields", + "in": "query", + "description": "A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "exclude_fields", + "x-title": "Exclude Fields", + "in": "query", + "description": "A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + { + "name": "audience_id", + "x-title": "Audience ID", + "in": "path", + "description": "The unique ID for the audience.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "contact_id", + "x-title": "Contact ID or Channel Hash", + "type": "string", + "required": true, + "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)." + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "description": "An instance of a contact.", + "properties": { + "id": { + "type": "string", + "title": "Contact ID", + "description": "The unique ID for the contact.", + "example": "7CCF816ADF6CE1B11AE09BB024A02B9B", + "readOnly": true + }, + "audience_id": { + "type": "string", + "title": "Audience ID", + "description": "The unique ID for the audience.", + "example": "773280e405", + "readOnly": true + }, + "language": { + "type": "string", + "title": "Language", + "description": "The subscribers detected language.", + "enum": [ + "en", + "ar", + "af", + "be", + "bg", + "ca", + "zh", + "zh_CN", + "hr", + "cs", + "da", + "nl", + "et", + "fa", + "fi", + "fr", + "fr_CA", + "de", + "el", + "he", + "hi", + "hu", + "is", + "id", + "ga", + "it", + "ja", + "km", + "ko", + "lv", + "lt", + "mt", + "ms", + "mk", + "no", + "pl", + "pt", + "pt_PT", + "ro", + "ru", + "sr", + "sk", + "sl", + "es", + "es_ES", + "sw", + "sv", + "ta", + "th", + "tr", + "uk", + "vi" + ], + "example": "en" + }, + "status": { + "type": "string", + "title": "Status", + "description": "The status of a contact.", + "enum": [ + "active", + "archived" + ], + "example": "active", + "readOnly": true + }, + "email_channel": { + "type": "object", + "title": "Email Channel Details", + "properties": { + "email": { + "type": "string", + "title": "Email Address", + "description": "Email address", + "example": "example@freddiemail.com" + }, + "hashed_email": { + "type": "string", + "title": "Hashed Email Address", + "description": "MD5 hash of the email address", + "example": "9115d71ba28088047d342e3bcedacd0f" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "denied", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "sms_channel": { + "type": "object", + "title": "SMS Channel Details", + "properties": { + "sms_phone": { + "type": "string", + "title": "SMS Phone Number", + "description": "SMS Phone Number", + "example": "+14045550102" + }, + "hashed_sms_phone": { + "type": "string", + "title": "Hashed SMS Phone Number", + "description": "SHA256 hash of the SMS phone number", + "example": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "The tags assigned to this contact.", + "items": { + "type": "string", + "title": "Tag Name", + "description": "The name of the tag" + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At", + "description": "The date that the contact was created.", + "readOnly": true + }, + "last_updated_at": { + "type": "string", + "format": "date-time", + "title": "Update At", + "description": "The date that the contact was last updated.", + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "tags": [ + "audiences", + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "get_audience_contact_id", + "methodNameCamel": "getAudienceContactId" + } + }, + "patch": { + "summary": "Update Contact", + "description": "Update an existing omni-channel contact.", + "operationId": "patchAudienceContact", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "description": "An instance of a contact.", + "properties": { + "language": { + "type": "string", + "title": "Language", + "description": "The subscribers detected language.", + "example": "EN" + }, + "email_channel": { + "type": "object", + "title": "Email Channel Details", + "properties": { + "email": { + "type": "string", + "title": "Email Address", + "description": "Email address", + "example": "example@freddiemail.com" + }, + "marketing_consent": { + "description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "denied", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + } + } + }, + "sms_channel": { + "type": "object", + "title": "SMS Channel Details", + "properties": { + "sms_phone": { + "type": "string", + "title": "SMS Phone Number", + "description": "SMS Phone Number", + "example": "+16155550128" + }, + "marketing_consent": { + "description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + } + } + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "An array of tag names to add to the contact. This operation is append-only; existing tags will be preserved, and only new tags from this array will be added.", + "items": { + "type": "string", + "title": "Tag Name" + }, + "example": [ + "tag_to_add_1", + "tag_to_add_2" + ] + } + } + } + }, + { + "name": "audience_id", + "x-title": "Audience ID", + "in": "path", + "description": "The unique ID for the audience.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "contact_id", + "x-title": "Contact ID", + "type": "string", + "required": true, + "description": "The unique id for the contact." + }, + { + "name": "merge_field_validation_mode", + "x-title": "Merge Field Validation Mode", + "in": "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.", + "required": false, + "type": "string", + "enum": [ + "ignore_required_checks", + "strict" + ] + }, + { + "name": "data_mode", + "x-title": "Data Mode", + "in": "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.", + "required": false, + "type": "string", + "enum": [ + "historical", + "live" + ] + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "description": "An instance of a contact.", + "properties": { + "id": { + "type": "string", + "title": "Contact ID", + "description": "The unique ID for the contact.", + "example": "7CCF816ADF6CE1B11AE09BB024A02B9B", + "readOnly": true + }, + "audience_id": { + "type": "string", + "title": "Audience ID", + "description": "The unique ID for the audience.", + "example": "773280e405", + "readOnly": true + }, + "language": { + "type": "string", + "title": "Language", + "description": "The subscribers detected language.", + "enum": [ + "en", + "ar", + "af", + "be", + "bg", + "ca", + "zh", + "zh_CN", + "hr", + "cs", + "da", + "nl", + "et", + "fa", + "fi", + "fr", + "fr_CA", + "de", + "el", + "he", + "hi", + "hu", + "is", + "id", + "ga", + "it", + "ja", + "km", + "ko", + "lv", + "lt", + "mt", + "ms", + "mk", + "no", + "pl", + "pt", + "pt_PT", + "ro", + "ru", + "sr", + "sk", + "sl", + "es", + "es_ES", + "sw", + "sv", + "ta", + "th", + "tr", + "uk", + "vi" + ], + "example": "en" + }, + "status": { + "type": "string", + "title": "Status", + "description": "The status of a contact.", + "enum": [ + "active", + "archived" + ], + "example": "active", + "readOnly": true + }, + "email_channel": { + "type": "object", + "title": "Email Channel Details", + "properties": { + "email": { + "type": "string", + "title": "Email Address", + "description": "Email address", + "example": "example@freddiemail.com" + }, + "hashed_email": { + "type": "string", + "title": "Hashed Email Address", + "description": "MD5 hash of the email address", + "example": "9115d71ba28088047d342e3bcedacd0f" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for email marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "denied", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "sms_channel": { + "type": "object", + "title": "SMS Channel Details", + "properties": { + "sms_phone": { + "type": "string", + "title": "SMS Phone Number", + "description": "SMS Phone Number", + "example": "+14045550102" + }, + "hashed_sms_phone": { + "type": "string", + "title": "Hashed SMS Phone Number", + "description": "SHA256 hash of the SMS phone number", + "example": "0572084e1f8288816f02cdb7bd930c62400bc8aef510adfaa9eec2b995fa7609" + }, + "effective_subscription_status": { + "type": "object", + "description": "A computation performed by the Mailchimp platform, triggered whenever any of its inputs change. Some inputs are controlled by API users, while others are tracked internally by the platform. Computation is based on: audience opt-in configuration (single vs. double opt-in), marketing consent status, and deliverability status (an internal state for a contact, maintained by Mailchimp for a specific marketing channel instance). This new API field is distinct from how contacts are displayed in the UI. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "properties": { + "value": { + "type": "string", + "title": "Effective Subscription Status", + "enum": [ + "subscribed", + "unsubscribed", + "nonsubscribed", + "pending" + ], + "readOnly": true + } + } + }, + "marketing_consent": { + "description": "A contact's current consent status for SMS marketing communications. See the [Audiences (BETA) documentation](https://mailchimp.com/developer/marketing/docs/audiences-intro) to learn about supported values.", + "type": "object", + "properties": { + "status": { + "type": "string", + "title": "Marketing Consent Status", + "enum": [ + "consented", + "confirmed", + "unknown" + ] + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + } + } + }, + "merge_fields": { + "type": "object", + "title": "Merge Fields", + "description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.", + "additionalProperties": { + "description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field." + } + }, + "tags": { + "type": "array", + "title": "Tags", + "description": "The tags assigned to this contact.", + "items": { + "type": "string", + "title": "Tag Name", + "description": "The name of the tag" + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source from which the parent's entity was created from.", + "properties": { + "name": { + "type": "string", + "title": "Entity source name", + "description": "The name of the entity's source" + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At", + "description": "The date that the contact was created.", + "readOnly": true + }, + "last_updated_at": { + "type": "string", + "format": "date-time", + "title": "Update At", + "description": "The date that the contact was last updated.", + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "audiences", + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "patch_audience_contact", + "methodNameCamel": "patchAudienceContact" + } + } + }, + "/audiences/{audience_id}/contacts/{contact_id}/actions/archive": { + "post": { + "summary": "Archive Contact", + "description": "Archives a Contact.", + "parameters": [ + { + "name": "audience_id", + "x-title": "Audience ID", + "in": "path", + "description": "The unique ID for the audience.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "contact_id", + "x-title": "Contact ID", + "type": "string", + "required": true, + "description": "The unique id for the contact." + } + ], + "responses": { + "204": { + "description": "Empty Response" + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "archive_contact", + "methodNameCamel": "archiveContact" + }, + "operationId": "postAudiencesContactsActionsArchive" + } + }, + "/audiences/{audience_id}/contacts/{contact_id}/actions/forget": { + "post": { + "summary": "Forget Contact", + "description": "Forgets a Contact.", + "parameters": [ + { + "name": "audience_id", + "x-title": "Audience ID", + "in": "path", + "description": "The unique ID for the audience.", + "required": true, + "type": "string" + }, + { + "in": "path", + "name": "contact_id", + "x-title": "Contact ID", + "type": "string", + "required": true, + "description": "The unique id for the contact." + } + ], + "responses": { + "204": { + "description": "Empty Response" + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "contacts" + ], + "x-custom-config": { + "methodNameSnake": "forget_contact", + "methodNameCamel": "forgetContact" + }, + "operationId": "postAudiencesContactsActionsForget" + } + }, "/authorized-apps": { "get": { "summary": "List authorized apps", @@ -139911,4 +142316,4 @@ "description": "Learn more with the full Mailchimp API documentation.", "url": "https://mailchimp.com/developer/marketing/" } -} \ No newline at end of file +}