From 7c96fc9aa559ba5e00b7337bc07c02d01464a40f Mon Sep 17 00:00:00 2001 From: Nate Ranson Date: Thu, 30 Apr 2026 12:21:13 -0400 Subject: [PATCH] Weekly deploy 4/30/26 -- adding SMS support. --- spec/marketing.json | 2594 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 2319 insertions(+), 275 deletions(-) diff --git a/spec/marketing.json b/spec/marketing.json index 9f8c4b5..8528aaa 100644 --- a/spec/marketing.json +++ b/spec/marketing.json @@ -142,6 +142,28 @@ "campaign-content" ] }, + "sms-campaigns": { + "title": "SMS Campaigns", + "description": "SMS Campaigns allow you to send text message marketing campaigns to your Mailchimp audience.", + "paths": [ + "/sms-campaigns", + "/sms-campaigns/{sms_campaign_id}", + "/sms-campaigns/{sms_campaign_id}/actions/cancel-send", + "/sms-campaigns/{sms_campaign_id}/actions/send", + "/sms-campaigns/{sms_campaign_id}/actions/schedule" + ], + "subResources": [ + "sms-campaign-content" + ] + }, + "sms-campaign-content": { + "title": "SMS Campaign Content", + "description": "Manage the content of an SMS campaign.", + "paths": [ + "/sms-campaigns/{sms_campaign_id}/content" + ], + "subResources": [] + }, "campaign-feedback": { "title": "Feedback", "description": "Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign.", @@ -2785,7 +2807,7 @@ "last_updated_at": { "type": "string", "format": "date-time", - "title": "Update At", + "title": "Updated At", "description": "The date that the contact was last updated.", "readOnly": true } @@ -3329,7 +3351,7 @@ "last_updated_at": { "type": "string", "format": "date-time", - "title": "Update At", + "title": "Updated At", "description": "The date that the contact was last updated.", "readOnly": true } @@ -3723,7 +3745,7 @@ "last_updated_at": { "type": "string", "format": "date-time", - "title": "Update At", + "title": "Updated At", "description": "The date that the contact was last updated.", "readOnly": true } @@ -4231,7 +4253,7 @@ "last_updated_at": { "type": "string", "format": "date-time", - "title": "Update At", + "title": "Updated At", "description": "The date that the contact was last updated.", "readOnly": true } @@ -22073,6 +22095,12 @@ ], "example": "POST" }, + "headers": { + "type": "object", + "title": "Request Headers", + "description": "Any HTTP headers to include with the request.", + "example": "{\"X-Data-Mode\":\"historical\"}" + }, "path": { "type": "string", "title": "Path", @@ -83107,6 +83135,20 @@ "description": "The ID that identifies this merge field's audience'.", "readOnly": true }, + "total_items": { + "type": "integer", + "title": "Total Merge Fields", + "description": "The total number of merge fields on the audience after this field was created. Returned on POST responses only.", + "readOnly": true, + "example": 28 + }, + "merge_field_limit": { + "type": "integer", + "title": "Merge Field Limit", + "description": "The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Returned on POST responses only. Subtract `total_items` from this value to derive the remaining capacity.", + "readOnly": true, + "example": 30 + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -83176,6 +83218,13 @@ "description": "The total number of items matching the query regardless of pagination.", "readOnly": true }, + "merge_field_limit": { + "type": "integer", + "title": "Merge Field Limit", + "description": "The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Subtract `total_items` from this value to derive the remaining capacity.", + "readOnly": true, + "example": 30 + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -83530,280 +83579,308 @@ "description": "The ID that identifies this merge field's audience'.", "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": [ - "lists" - ], - "x-custom-config": { - "methodNameSnake": "add_list_merge_field", - "methodNameCamel": "addListMergeField" - } - } - }, - "/lists/{list_id}/merge-fields/{merge_id}": { - "get": { - "summary": "Get merge field", - "description": "Get information about a specific merge field.", - "operationId": "getListsIdMergeFieldsId", - "parameters": [ - { - "name": "list_id", - "x-title": "List ID", - "in": "path", - "description": "The unique ID for the list.", - "required": true, - "type": "string" - }, - { - "name": "merge_id", - "x-title": "Merge ID", - "description": "The id for the merge field.", - "in": "path", - "required": true, - "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": "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" - } - } - ], - "responses": { - "200": { - "description": "", - "schema": { - "type": "object", - "title": "Merge Field", - "description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.", - "properties": { - "merge_id": { + "total_items": { "type": "integer", - "title": "Merge Field ID", - "description": "An unchanging id for the merge field.", - "readOnly": true - }, - "tag": { - "type": "string", - "title": "Merge Tag", - "description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)." - }, - "name": { - "type": "string", - "title": "Merge Field Name", - "description": "The name of the merge field (audience field)." - }, - "type": { - "type": "string", - "title": "Merge Field Type", - "description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.", - "enum": [ - "text", - "number", - "address", - "phone", - "date", - "url", - "imageurl", - "radio", - "dropdown", - "birthday", - "zip" - ], - "readOnly": true - }, - "required": { - "type": "boolean", - "title": "Required", - "description": "The boolean value if the merge field is required." - }, - "default_value": { - "type": "string", - "title": "Default Value", - "description": "The default value for the merge field if `null`." - }, - "public": { - "type": "boolean", - "title": "Merge Field Public Status", - "description": "Whether the merge field is displayed on the signup form." + "title": "Total Merge Fields", + "description": "The total number of merge fields on the audience after this field was created. Returned on POST responses only.", + "readOnly": true, + "example": 28 }, - "display_order": { + "merge_field_limit": { "type": "integer", - "title": "Display Order", - "description": "The order that the merge field displays on the list signup form." - }, - "options": { - "type": "object", - "title": "Merge Field Options", - "description": "Extra options for some merge field types.", - "properties": { - "default_country": { - "type": "integer", - "title": "Default Country", - "description": "In an address field, the default country code if none supplied." - }, - "phone_format": { - "type": "string", - "title": "Phone Type", - "description": "In a phone field, the phone number type: US or International." - }, - "date_format": { - "type": "string", - "title": "Date Type", - "description": "In a date or birthday field, the format of the date." - }, - "choices": { - "type": "array", - "title": "Choices", - "description": "In a radio or dropdown non-group field, the available options for contacts to pick from.", - "items": { - "type": "string" - }, - "example": [ - "First Choice", - "Second Choice", - "Third Choice" - ] - }, - "size": { - "type": "integer", - "title": "Text Field Size", - "description": "In a text field, the default length of the text field.", - "readOnly": true - } - } - }, - "help_text": { - "type": "string", - "title": "Merge Field Help Text", - "description": "Extra text to help the subscriber fill out the form." - }, - "list_id": { - "type": "string", - "title": "List ID", - "description": "The ID that identifies this merge field's audience'.", - "readOnly": true + "title": "Merge Field Limit", + "description": "The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Returned on POST responses only. Subtract `total_items` from this value to derive the remaining capacity.", + "readOnly": true, + "example": 30 + }, + "_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": [ + "lists" + ], + "x-custom-config": { + "methodNameSnake": "add_list_merge_field", + "methodNameCamel": "addListMergeField" + } + } + }, + "/lists/{list_id}/merge-fields/{merge_id}": { + "get": { + "summary": "Get merge field", + "description": "Get information about a specific merge field.", + "operationId": "getListsIdMergeFieldsId", + "parameters": [ + { + "name": "list_id", + "x-title": "List ID", + "in": "path", + "description": "The unique ID for the list.", + "required": true, + "type": "string" + }, + { + "name": "merge_id", + "x-title": "Merge ID", + "description": "The id for the merge field.", + "in": "path", + "required": true, + "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": "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" + } + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "Merge Field", + "description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience.", + "properties": { + "merge_id": { + "type": "integer", + "title": "Merge Field ID", + "description": "An unchanging id for the merge field.", + "readOnly": true + }, + "tag": { + "type": "string", + "title": "Merge Tag", + "description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)." + }, + "name": { + "type": "string", + "title": "Merge Field Name", + "description": "The name of the merge field (audience field)." + }, + "type": { + "type": "string", + "title": "Merge Field Type", + "description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field.", + "enum": [ + "text", + "number", + "address", + "phone", + "date", + "url", + "imageurl", + "radio", + "dropdown", + "birthday", + "zip" + ], + "readOnly": true + }, + "required": { + "type": "boolean", + "title": "Required", + "description": "The boolean value if the merge field is required." + }, + "default_value": { + "type": "string", + "title": "Default Value", + "description": "The default value for the merge field if `null`." + }, + "public": { + "type": "boolean", + "title": "Merge Field Public Status", + "description": "Whether the merge field is displayed on the signup form." + }, + "display_order": { + "type": "integer", + "title": "Display Order", + "description": "The order that the merge field displays on the list signup form." + }, + "options": { + "type": "object", + "title": "Merge Field Options", + "description": "Extra options for some merge field types.", + "properties": { + "default_country": { + "type": "integer", + "title": "Default Country", + "description": "In an address field, the default country code if none supplied." + }, + "phone_format": { + "type": "string", + "title": "Phone Type", + "description": "In a phone field, the phone number type: US or International." + }, + "date_format": { + "type": "string", + "title": "Date Type", + "description": "In a date or birthday field, the format of the date." + }, + "choices": { + "type": "array", + "title": "Choices", + "description": "In a radio or dropdown non-group field, the available options for contacts to pick from.", + "items": { + "type": "string" + }, + "example": [ + "First Choice", + "Second Choice", + "Third Choice" + ] + }, + "size": { + "type": "integer", + "title": "Text Field Size", + "description": "In a text field, the default length of the text field.", + "readOnly": true + } + } + }, + "help_text": { + "type": "string", + "title": "Merge Field Help Text", + "description": "Extra text to help the subscriber fill out the form." + }, + "list_id": { + "type": "string", + "title": "List ID", + "description": "The ID that identifies this merge field's audience'.", + "readOnly": true + }, + "total_items": { + "type": "integer", + "title": "Total Merge Fields", + "description": "The total number of merge fields on the audience after this field was created. Returned on POST responses only.", + "readOnly": true, + "example": 28 + }, + "merge_field_limit": { + "type": "integer", + "title": "Merge Field Limit", + "description": "The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Returned on POST responses only. Subtract `total_items` from this value to derive the remaining capacity.", + "readOnly": true, + "example": 30 }, "_links": { "title": "Links", @@ -84140,6 +84217,20 @@ "description": "The ID that identifies this merge field's audience'.", "readOnly": true }, + "total_items": { + "type": "integer", + "title": "Total Merge Fields", + "description": "The total number of merge fields on the audience after this field was created. Returned on POST responses only.", + "readOnly": true, + "example": 28 + }, + "merge_field_limit": { + "type": "integer", + "title": "Merge Field Limit", + "description": "The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Returned on POST responses only. Subtract `total_items` from this value to derive the remaining capacity.", + "readOnly": true, + "example": 30 + }, "_links": { "title": "Links", "description": "A list of link types and descriptions for the API schema documents.", @@ -127129,6 +127220,1959 @@ } } }, + "/sms-campaigns": { + "get": { + "summary": "List SMS campaigns", + "description": "Get all SMS campaigns in an account.", + "operationId": "getSmsCampaigns", + "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", + "title": "SMS Campaigns", + "description": "A collection of SMS campaigns.", + "properties": { + "sms_campaigns": { + "type": "array", + "title": "SMS Campaigns", + "description": "An array of SMS campaigns.", + "items": { + "type": "object", + "title": "SMS Campaign", + "description": "A single SMS campaign.", + "properties": { + "id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies this campaign.", + "readOnly": true + }, + "web_id": { + "type": "string", + "title": "Campaign Web ID", + "description": "The ID used in the Mailchimp web application.", + "readOnly": true + }, + "name": { + "type": "string", + "title": "Campaign Name", + "description": "The name of the campaign." + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "readOnly": true + }, + "channel": { + "type": "string", + "title": "Campaign Channel", + "description": "The channel for this campaign (sms or whatsapp).", + "readOnly": true + }, + "list_id": { + "type": "integer", + "title": "List ID", + "description": "The numeric ID of the list associated with this campaign.", + "readOnly": true + }, + "recipient_count": { + "type": "integer", + "title": "Recipient Count", + "description": "The number of recipients for this campaign.", + "readOnly": true + }, + "create_time": { + "type": "string", + "format": "date-time", + "title": "Create Time", + "description": "The date and time the campaign was created in ISO 8601 format.", + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time the campaign is scheduled to send.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At", + "description": "The date and time the campaign was last updated.", + "readOnly": true + }, + "expire_time": { + "type": "string", + "format": "date-time", + "title": "Expire Time", + "description": "The date and time the campaign will stop sending in ISO 8601 format.", + "readOnly": true + }, + "is_send_now": { + "type": "boolean", + "title": "Is Send Now", + "description": "Whether the campaign is configured to send immediately.", + "readOnly": true + }, + "folder_id": { + "type": "string", + "title": "Folder ID", + "description": "The ID of the folder this campaign is in." + }, + "segments": { + "type": "array", + "title": "Segments", + "description": "The segment IDs used to target recipients for this campaign.", + "items": { + "type": "integer" + } + }, + "excluded_segments": { + "type": "array", + "title": "Excluded Segments", + "description": "The segment IDs excluded from receiving this campaign.", + "items": { + "type": "integer" + } + }, + "_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 + } + } + } + }, + "total_items": { + "type": "integer", + "title": "Item Count", + "description": "The total number of items matching the query regardless of pagination.", + "readOnly": true + }, + "_links": { + "title": "Links", + "description": "A list of link types and descriptions for the API schema documents.", + "type": "array", + "items": { + "type": "object", + "title": "Resource Link", + "description": "This object represents a link from the resource where it is found to another resource or action that may be performed.", + "properties": { + "rel": { + "type": "string", + "title": "Rel", + "description": "As with an HTML 'rel' attribute, this describes the type of link.", + "readOnly": true + }, + "href": { + "type": "string", + "title": "Href", + "description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.", + "readOnly": true + }, + "method": { + "type": "string", + "title": "Method", + "description": "The HTTP method that should be used when accessing the URL defined in 'href'.", + "enum": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE", + "OPTIONS", + "HEAD" + ], + "readOnly": true + }, + "targetSchema": { + "type": "string", + "title": "Target Schema", + "description": "For GETs, this is a URL representing the schema that the response should conform to.", + "readOnly": true + }, + "schema": { + "type": "string", + "title": "Schema", + "description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.", + "readOnly": true + } + } + }, + "readOnly": true + } + } + } + }, + "default": { + "description": "An error generated by the Mailchimp API.", + "schema": { + "type": "object", + "title": "Problem Detail Document", + "description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'.", + "required": [ + "type", + "title", + "status", + "detail", + "instance" + ], + "properties": { + "type": { + "type": "string", + "title": "Problem Type", + "description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.", + "example": "https://mailchimp.com/developer/marketing/docs/errors/" + }, + "title": { + "type": "string", + "title": "Error Title", + "description": "A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization.", + "example": "Resource Not Found" + }, + "status": { + "type": "integer", + "title": "HTTP Status Code", + "description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.", + "example": 404 + }, + "detail": { + "type": "string", + "title": "Error Message", + "description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors).", + "example": "The requested resource could not be found." + }, + "instance": { + "type": "string", + "title": "Instance ID", + "description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.", + "example": "995c5cb0-3280-4a6e-808b-3b096d0bb219" + } + } + } + } + }, + "deprecated": false, + "tags": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "list", + "methodNameCamel": "list" + } + }, + "post": { + "summary": "Add SMS campaign", + "description": "Create a new SMS campaign.", + "operationId": "postSmsCampaigns", + "parameters": [ + { + "name": "body", + "in": "body", + "description": "", + "required": true, + "schema": { + "type": "object", + "title": "Create SMS Campaign", + "description": "The settings for creating a new SMS campaign.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "title": "Campaign Name", + "description": "The name of the campaign." + }, + "list_id": { + "type": "integer", + "title": "List ID", + "description": "The numeric ID of the list to send the campaign to." + }, + "folder_id": { + "type": "string", + "title": "Folder ID", + "description": "The ID of the folder to place this campaign in." + }, + "segments": { + "type": "array", + "title": "Segments", + "description": "The segment IDs to target for this campaign.", + "items": { + "type": "integer" + } + }, + "excluded_segments": { + "type": "array", + "title": "Excluded Segments", + "description": "The segment IDs to exclude from this campaign.", + "items": { + "type": "integer" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "SMS Campaign", + "description": "A single SMS campaign.", + "properties": { + "id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies this campaign.", + "readOnly": true + }, + "web_id": { + "type": "string", + "title": "Campaign Web ID", + "description": "The ID used in the Mailchimp web application.", + "readOnly": true + }, + "name": { + "type": "string", + "title": "Campaign Name", + "description": "The name of the campaign." + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "readOnly": true + }, + "channel": { + "type": "string", + "title": "Campaign Channel", + "description": "The channel for this campaign (sms or whatsapp).", + "readOnly": true + }, + "list_id": { + "type": "integer", + "title": "List ID", + "description": "The numeric ID of the list associated with this campaign.", + "readOnly": true + }, + "recipient_count": { + "type": "integer", + "title": "Recipient Count", + "description": "The number of recipients for this campaign.", + "readOnly": true + }, + "create_time": { + "type": "string", + "format": "date-time", + "title": "Create Time", + "description": "The date and time the campaign was created in ISO 8601 format.", + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time the campaign is scheduled to send.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At", + "description": "The date and time the campaign was last updated.", + "readOnly": true + }, + "expire_time": { + "type": "string", + "format": "date-time", + "title": "Expire Time", + "description": "The date and time the campaign will stop sending in ISO 8601 format.", + "readOnly": true + }, + "is_send_now": { + "type": "boolean", + "title": "Is Send Now", + "description": "Whether the campaign is configured to send immediately.", + "readOnly": true + }, + "folder_id": { + "type": "string", + "title": "Folder ID", + "description": "The ID of the folder this campaign is in." + }, + "segments": { + "type": "array", + "title": "Segments", + "description": "The segment IDs used to target recipients for this campaign.", + "items": { + "type": "integer" + } + }, + "excluded_segments": { + "type": "array", + "title": "Excluded Segments", + "description": "The segment IDs excluded from receiving this campaign.", + "items": { + "type": "integer" + } + }, + "_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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "create", + "methodNameCamel": "create" + } + } + }, + "/sms-campaigns/{sms_campaign_id}": { + "get": { + "summary": "Get SMS campaign info", + "description": "Get information about a specific SMS campaign.", + "operationId": "getSmsCampaignsId", + "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" + } + }, + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "SMS Campaign", + "description": "A single SMS campaign.", + "properties": { + "id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies this campaign.", + "readOnly": true + }, + "web_id": { + "type": "string", + "title": "Campaign Web ID", + "description": "The ID used in the Mailchimp web application.", + "readOnly": true + }, + "name": { + "type": "string", + "title": "Campaign Name", + "description": "The name of the campaign." + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "readOnly": true + }, + "channel": { + "type": "string", + "title": "Campaign Channel", + "description": "The channel for this campaign (sms or whatsapp).", + "readOnly": true + }, + "list_id": { + "type": "integer", + "title": "List ID", + "description": "The numeric ID of the list associated with this campaign.", + "readOnly": true + }, + "recipient_count": { + "type": "integer", + "title": "Recipient Count", + "description": "The number of recipients for this campaign.", + "readOnly": true + }, + "create_time": { + "type": "string", + "format": "date-time", + "title": "Create Time", + "description": "The date and time the campaign was created in ISO 8601 format.", + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time the campaign is scheduled to send.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At", + "description": "The date and time the campaign was last updated.", + "readOnly": true + }, + "expire_time": { + "type": "string", + "format": "date-time", + "title": "Expire Time", + "description": "The date and time the campaign will stop sending in ISO 8601 format.", + "readOnly": true + }, + "is_send_now": { + "type": "boolean", + "title": "Is Send Now", + "description": "Whether the campaign is configured to send immediately.", + "readOnly": true + }, + "folder_id": { + "type": "string", + "title": "Folder ID", + "description": "The ID of the folder this campaign is in." + }, + "segments": { + "type": "array", + "title": "Segments", + "description": "The segment IDs used to target recipients for this campaign.", + "items": { + "type": "integer" + } + }, + "excluded_segments": { + "type": "array", + "title": "Excluded Segments", + "description": "The segment IDs excluded from receiving this campaign.", + "items": { + "type": "integer" + } + }, + "_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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "get", + "methodNameCamel": "get" + } + }, + "patch": { + "summary": "Update SMS campaign settings", + "description": "Update some or all of the settings for a specific SMS campaign.", + "operationId": "patchSmsCampaignsId", + "parameters": [ + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + }, + { + "in": "body", + "name": "body", + "description": "", + "required": true, + "schema": { + "type": "object", + "title": "Update SMS Campaign", + "description": "The settings for updating an SMS campaign.", + "properties": { + "name": { + "type": "string", + "title": "Campaign Name", + "description": "The name of the campaign." + }, + "folder_id": { + "type": "string", + "title": "Folder ID", + "description": "The ID of the folder to place this campaign in." + }, + "segments": { + "type": "array", + "title": "Segments", + "description": "The segment IDs to target for this campaign.", + "items": { + "type": "integer" + } + }, + "excluded_segments": { + "type": "array", + "title": "Excluded Segments", + "description": "The segment IDs to exclude from this campaign.", + "items": { + "type": "integer" + } + } + } + } + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "SMS Campaign", + "description": "A single SMS campaign.", + "properties": { + "id": { + "type": "string", + "title": "Campaign ID", + "description": "A string that uniquely identifies this campaign.", + "readOnly": true + }, + "web_id": { + "type": "string", + "title": "Campaign Web ID", + "description": "The ID used in the Mailchimp web application.", + "readOnly": true + }, + "name": { + "type": "string", + "title": "Campaign Name", + "description": "The name of the campaign." + }, + "status": { + "type": "string", + "title": "Campaign Status", + "description": "The current status of the campaign.", + "readOnly": true + }, + "channel": { + "type": "string", + "title": "Campaign Channel", + "description": "The channel for this campaign (sms or whatsapp).", + "readOnly": true + }, + "list_id": { + "type": "integer", + "title": "List ID", + "description": "The numeric ID of the list associated with this campaign.", + "readOnly": true + }, + "recipient_count": { + "type": "integer", + "title": "Recipient Count", + "description": "The number of recipients for this campaign.", + "readOnly": true + }, + "create_time": { + "type": "string", + "format": "date-time", + "title": "Create Time", + "description": "The date and time the campaign was created in ISO 8601 format.", + "readOnly": true + }, + "send_time": { + "type": "string", + "format": "date-time", + "title": "Send Time", + "description": "The date and time the campaign is scheduled to send.", + "readOnly": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "title": "Updated At", + "description": "The date and time the campaign was last updated.", + "readOnly": true + }, + "expire_time": { + "type": "string", + "format": "date-time", + "title": "Expire Time", + "description": "The date and time the campaign will stop sending in ISO 8601 format.", + "readOnly": true + }, + "is_send_now": { + "type": "boolean", + "title": "Is Send Now", + "description": "Whether the campaign is configured to send immediately.", + "readOnly": true + }, + "folder_id": { + "type": "string", + "title": "Folder ID", + "description": "The ID of the folder this campaign is in." + }, + "segments": { + "type": "array", + "title": "Segments", + "description": "The segment IDs used to target recipients for this campaign.", + "items": { + "type": "integer" + } + }, + "excluded_segments": { + "type": "array", + "title": "Excluded Segments", + "description": "The segment IDs excluded from receiving this campaign.", + "items": { + "type": "integer" + } + }, + "_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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "update", + "methodNameCamel": "update" + } + }, + "delete": { + "summary": "Delete SMS campaign", + "description": "Remove an SMS campaign from your Mailchimp account.", + "operationId": "deleteSmsCampaignsId", + "parameters": [ + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + } + ], + "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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "remove", + "methodNameCamel": "remove" + } + } + }, + "/sms-campaigns/{sms_campaign_id}/actions/send": { + "post": { + "summary": "Send SMS campaign", + "description": "Send an SMS campaign.", + "operationId": "postSmsCampaignsIdActionsSend", + "parameters": [ + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + } + ], + "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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "send", + "methodNameCamel": "send" + } + } + }, + "/sms-campaigns/{sms_campaign_id}/actions/schedule": { + "post": { + "summary": "Schedule SMS campaign", + "description": "Schedule an SMS campaign to send at a specific time.", + "operationId": "postSmsCampaignsIdActionsSchedule", + "parameters": [ + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + }, + { + "in": "body", + "name": "body", + "description": "", + "required": true, + "schema": { + "type": "object", + "required": [ + "schedule_time" + ], + "properties": { + "schedule_time": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time to schedule the campaign to send." + } + } + } + } + ], + "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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "schedule", + "methodNameCamel": "schedule" + } + } + }, + "/sms-campaigns/{sms_campaign_id}/actions/cancel-send": { + "post": { + "summary": "Cancel SMS campaign send", + "description": "Cancel a scheduled or sending SMS campaign.", + "operationId": "postSmsCampaignsIdActionsCancelSend", + "parameters": [ + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + } + ], + "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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "cancel_send", + "methodNameCamel": "cancelSend" + } + } + }, + "/sms-campaigns/{sms_campaign_id}/content": { + "get": { + "summary": "Get SMS campaign content", + "description": "Get the content for an SMS campaign.", + "operationId": "getSmsCampaignsIdContent", + "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" + } + }, + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "SMS Campaign Content", + "description": "The content of an SMS campaign.", + "properties": { + "message_body": { + "type": "string", + "title": "Message Body", + "description": "The SMS message body." + }, + "estimated_segments": { + "type": "integer", + "title": "Estimated Segments", + "description": "The estimated number of message segments this content will use.", + "readOnly": true + }, + "merge_fields": { + "type": "array", + "title": "Merge Fields", + "description": "The merge fields used in the message body.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "media": { + "type": "array", + "title": "Media", + "description": "Attached images or files.", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string", + "title": "URL", + "description": "The URL of the media file." + }, + "mime_type": { + "type": "string", + "title": "MIME Type", + "description": "The MIME type of the media file." + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source that created or imported this content.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "title": "Type", + "description": "The type of source." + }, + "id": { + "type": "string", + "title": "ID", + "description": "The ID of the source." + } + } + }, + "properties": { + "type": "object", + "title": "Properties", + "description": "Additional content properties.", + "readOnly": true, + "properties": { + "content_type": { + "type": "string", + "title": "Content Type", + "description": "The content type of the message." + }, + "sender": { + "type": "string", + "title": "Sender", + "description": "The sender identifier for the message." + }, + "optout_message_language": { + "type": "string", + "title": "Opt-out Message Language", + "description": "The language of the opt-out message." + } + } + }, + "_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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "get_content", + "methodNameCamel": "getContent" + } + }, + "put": { + "summary": "Set SMS campaign content", + "description": "Set the content for an SMS campaign.", + "operationId": "putSmsCampaignsIdContent", + "parameters": [ + { + "in": "path", + "name": "sms_campaign_id", + "x-title": "SMS Campaign ID", + "type": "string", + "required": true, + "description": "The unique id for the SMS campaign." + }, + { + "in": "body", + "name": "body", + "description": "", + "required": true, + "schema": { + "type": "object", + "title": "Set SMS Campaign Content", + "description": "The settings for setting the content of an SMS campaign.", + "required": [ + "message_body" + ], + "properties": { + "message_body": { + "type": "string", + "title": "Message Body", + "description": "The SMS message body." + }, + "media": { + "type": "array", + "title": "Media", + "description": "Attached images or files.", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string", + "title": "URL", + "description": "The URL of the media file." + }, + "mime_type": { + "type": "string", + "title": "MIME Type", + "description": "The MIME type of the media file." + } + } + } + } + } + } + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "title": "SMS Campaign Content", + "description": "The content of an SMS campaign.", + "properties": { + "message_body": { + "type": "string", + "title": "Message Body", + "description": "The SMS message body." + }, + "estimated_segments": { + "type": "integer", + "title": "Estimated Segments", + "description": "The estimated number of message segments this content will use.", + "readOnly": true + }, + "merge_fields": { + "type": "array", + "title": "Merge Fields", + "description": "The merge fields used in the message body.", + "readOnly": true, + "items": { + "type": "string" + } + }, + "media": { + "type": "array", + "title": "Media", + "description": "Attached images or files.", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string", + "title": "URL", + "description": "The URL of the media file." + }, + "mime_type": { + "type": "string", + "title": "MIME Type", + "description": "The MIME type of the media file." + } + } + } + }, + "source": { + "type": "object", + "title": "Source", + "description": "The source that created or imported this content.", + "readOnly": true, + "properties": { + "type": { + "type": "string", + "title": "Type", + "description": "The type of source." + }, + "id": { + "type": "string", + "title": "ID", + "description": "The ID of the source." + } + } + }, + "properties": { + "type": "object", + "title": "Properties", + "description": "Additional content properties.", + "readOnly": true, + "properties": { + "content_type": { + "type": "string", + "title": "Content Type", + "description": "The content type of the message." + }, + "sender": { + "type": "string", + "title": "Sender", + "description": "The sender identifier for the message." + }, + "optout_message_language": { + "type": "string", + "title": "Opt-out Message Language", + "description": "The language of the opt-out message." + } + } + }, + "_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": [ + "sms-campaigns" + ], + "x-custom-config": { + "methodNameSnake": "set_content", + "methodNameCamel": "setContent" + } + } + }, "/search-members": { "get": { "summary": "Search members",