FacebookAdsListAdsdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerAddNewFolder200Response
{
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
}
FileManagerAddNewFolderRequest
{
"type": "object",
"title": "Gallery Folder",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
}
},
"description": "An individual folder listed in the File Manager."
}
FileManagerAddNewFolderResponse
{
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
}
FileManagerAddNewFolderdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerDeleteFolderByIdResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerDeleteFolderByIddefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerGetFile200Response
{
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerGetFileResponse
{
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerGetFiledefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerGetFolderInfo200Response
{
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
}
FileManagerGetFolderInfoResponse
{
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
}
FileManagerGetFolderInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerGetFolderList200Response
{
"type": "object",
"title": "File Manager Folders",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"folders": {
"type": "array",
"items": {
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
},
"title": "File Manager Folders",
"description": "A list of all folders in the File Manager."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of all folders in the File Manager."
}
FileManagerGetFolderListResponse
{
"type": "object",
"title": "File Manager Folders",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"folders": {
"type": "array",
"items": {
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
},
"title": "File Manager Folders",
"description": "A list of all folders in the File Manager."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list of all folders in the File Manager."
}
FileManagerGetFolderListdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerListStoredFiles200Response
{
"type": "object",
"title": "File Manager",
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
},
"title": "Files",
"description": " A list of files and images in an account."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"total_file_size": {
"type": "number",
"title": "Total File Size",
"readOnly": true,
"description": "The total size of all File Manager files in bytes."
}
},
"description": "A list of available images and files stored in the File Manager for the account."
}
FileManagerListStoredFilesResponse
{
"type": "object",
"title": "File Manager",
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
},
"title": "Files",
"description": " A list of files and images in an account."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"total_file_size": {
"type": "number",
"title": "Total File Size",
"readOnly": true,
"description": "The total size of all File Manager files in bytes."
}
},
"description": "A list of available images and files stored in the File Manager for the account."
}
FileManagerListStoredFilesdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerRemoveFileByIdResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerRemoveFileByIddefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerUpdateFile200Response
{
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerUpdateFileRequest
{
"type": "object",
"title": "Gallery File",
"properties": {
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder. Setting `folder_id` to `0` will remove a file from its current folder."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerUpdateFileResponse
{
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerUpdateFiledefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerUpdateSpecificFolder200Response
{
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
}
FileManagerUpdateSpecificFolderResponse
{
"type": "object",
"title": "Gallery Folder",
"properties": {
"id": {
"type": "integer",
"title": "Folder ID",
"readOnly": true,
"description": "The unique id for the folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that created the folder."
},
"file_count": {
"type": "integer",
"title": "File Count",
"readOnly": true,
"description": "The number of files in the folder."
}
},
"description": "An individual folder listed in the File Manager."
}
FileManagerUpdateSpecificFolderdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
FileManagerUploadFile200Response
{
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerUploadFileRequest
{
"type": "object",
"title": "Gallery File",
"required": [
"name",
"file_data"
],
"properties": {
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"file_data": {
"type": "string",
"title": "File Data",
"description": "The base64-encoded contents of the file."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerUploadFileResponse
{
"type": "object",
"title": "Gallery File",
"properties": {
"id": {
"type": "integer",
"title": "File ID",
"readOnly": true,
"description": "The unique id of the file."
},
"name": {
"type": "string",
"title": "File Name",
"description": "The name of the file."
},
"size": {
"type": "integer",
"title": "File Size",
"readOnly": true,
"description": "The size of the file in bytes."
},
"type": {
"enum": [
"image",
"file"
],
"type": "string",
"title": "File Type",
"readOnly": true,
"description": "The type of file in the File Manager."
},
"width": {
"type": "integer",
"title": "Image Width",
"readOnly": true,
"description": "The width of the image."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"height": {
"type": "integer",
"title": "Image Height",
"readOnly": true,
"description": "The height of an image."
},
"folder_id": {
"type": "integer",
"title": "Folder ID",
"description": "The id of the folder."
},
"created_at": {
"type": "string",
"title": "Created Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time a file was added to the File Manager in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The username of the profile that uploaded the file."
},
"full_size_url": {
"type": "string",
"title": "File URL",
"format": "uri",
"readOnly": true,
"description": "The url of the full-size file."
},
"thumbnail_url": {
"type": "string",
"title": "Thumbnail URL",
"format": "uri",
"readOnly": true,
"description": "The url of the thumbnail preview."
}
},
"description": "An individual file listed in the File Manager."
}
FileManagerUploadFiledefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesCreateNewMailchimpLandingPage200Response
{
"type": "object",
"title": "Landing Page",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "030092c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Published url",
"readOnly": true,
"description": "The url of the published landing page."
},
"name": {
"type": "string",
"title": "Landing Page Name",
"readOnly": false,
"description": "The name of this landing page."
},
"title": {
"type": "string",
"title": "Landing Page title",
"readOnly": false,
"description": "The title of this landing page seen in the browser's title bar."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"published",
"unpublished",
"draft"
],
"type": "string",
"title": "Landing Page status",
"readOnly": true,
"description": "The status of this landing page."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "Landing Page list id",
"example": "fde02ad86b",
"readOnly": false,
"description": "The list's ID associated with this landing page."
},
"store_id": {
"type": "string",
"title": "Store ID",
"readOnly": false,
"description": "The ID of the store associated with this landing page."
},
"tracking": {
"type": "object",
"title": "Tracking Settings",
"properties": {
"track_with_mailchimp": {
"type": "boolean",
"title": "Track with Mailchimp",
"description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."
},
"enable_restricted_data_processing": {
"type": "boolean",
"title": "Enable restricted data processing",
"description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)."
}
},
"description": "The tracking settings applied to this landing page."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was created."
},
"updated_at": {
"type": "string",
"title": "Updated_at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was updated at."
},
"description": {
"type": "string",
"title": "Landing Page description",
"readOnly": false,
"description": "The description of this landing page."
},
"template_id": {
"type": "integer",
"title": "Landing Page template_id",
"readOnly": true,
"description": "The template_id of this landing page."
},
"published_at": {
"type": "string",
"title": "Published at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"created_by_source": {
"type": "string",
"title": "Created By Source",
"readOnly": true,
"description": "Created by mobile or web"
}
},
"description": "A summary of an individual landing page's settings and content."
}
LandingPagesCreateNewMailchimpLandingPageRequest
{
"type": "object",
"title": "Landing Page",
"properties": {
"name": {
"type": "string",
"title": "Landing Page Name",
"description": "The name of this landing page."
},
"type": {
"enum": [
"signup",
"product"
],
"type": "string",
"title": "Landing Page Template Type",
"example": "signup",
"description": "The type of template the landing page has."
},
"title": {
"type": "string",
"title": "Landing Page title",
"description": "The title of this landing page seen in the browser's title bar."
},
"list_id": {
"type": "string",
"title": "Landing Page list id",
"description": "The list's ID associated with this landing page."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The ID of the store associated with this landing page."
},
"tracking": {
"type": "object",
"title": "Tracking Settings",
"properties": {
"track_with_mailchimp": {
"type": "boolean",
"title": "Track with Mailchimp",
"description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."
},
"enable_restricted_data_processing": {
"type": "boolean",
"title": "Enable restricted data processing",
"description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)."
}
},
"description": "The tracking settings applied to this landing page."
},
"description": {
"type": "string",
"title": "Landing Page description",
"description": "The description of this landing page."
},
"template_id": {
"type": "integer",
"title": "Landing Page template_id",
"example": 1001,
"description": "The template_id of this landing page."
}
},
"description": "A summary of an individual page's properties."
}
LandingPagesCreateNewMailchimpLandingPageResponse
{
"type": "object",
"title": "Landing Page",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "030092c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Published url",
"readOnly": true,
"description": "The url of the published landing page."
},
"name": {
"type": "string",
"title": "Landing Page Name",
"readOnly": false,
"description": "The name of this landing page."
},
"title": {
"type": "string",
"title": "Landing Page title",
"readOnly": false,
"description": "The title of this landing page seen in the browser's title bar."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"published",
"unpublished",
"draft"
],
"type": "string",
"title": "Landing Page status",
"readOnly": true,
"description": "The status of this landing page."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "Landing Page list id",
"example": "fde02ad86b",
"readOnly": false,
"description": "The list's ID associated with this landing page."
},
"store_id": {
"type": "string",
"title": "Store ID",
"readOnly": false,
"description": "The ID of the store associated with this landing page."
},
"tracking": {
"type": "object",
"title": "Tracking Settings",
"properties": {
"track_with_mailchimp": {
"type": "boolean",
"title": "Track with Mailchimp",
"description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."
},
"enable_restricted_data_processing": {
"type": "boolean",
"title": "Enable restricted data processing",
"description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)."
}
},
"description": "The tracking settings applied to this landing page."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was created."
},
"updated_at": {
"type": "string",
"title": "Updated_at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was updated at."
},
"description": {
"type": "string",
"title": "Landing Page description",
"readOnly": false,
"description": "The description of this landing page."
},
"template_id": {
"type": "integer",
"title": "Landing Page template_id",
"readOnly": true,
"description": "The template_id of this landing page."
},
"published_at": {
"type": "string",
"title": "Published at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"created_by_source": {
"type": "string",
"title": "Created By Source",
"readOnly": true,
"description": "Created by mobile or web"
}
},
"description": "A summary of an individual landing page's settings and content."
}
LandingPagesCreateNewMailchimpLandingPagedefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesDeletePageResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesDeletePagedefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesGetContent200Response
{
"type": "object",
"title": "Landing Page Content",
"properties": {
"html": {
"type": "string",
"title": "Landing Page HTML",
"description": "The raw HTML for the landing page."
},
"json": {
"type": "string",
"title": "Landing Page JSON",
"description": "The JSON Structure for the landing page"
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
}
},
"description": "The HTML content for a landing page."
}
LandingPagesGetContentResponse
{
"type": "object",
"title": "Landing Page Content",
"properties": {
"html": {
"type": "string",
"title": "Landing Page HTML",
"description": "The raw HTML for the landing page."
},
"json": {
"type": "string",
"title": "Landing Page JSON",
"description": "The JSON Structure for the landing page"
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
}
},
"description": "The HTML content for a landing page."
}
LandingPagesGetContentdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesGetPageInfo200Response
{
"type": "object",
"title": "Landing Page",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "030092c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Published url",
"readOnly": true,
"description": "The url of the published landing page."
},
"name": {
"type": "string",
"title": "Landing Page Name",
"readOnly": false,
"description": "The name of this landing page."
},
"title": {
"type": "string",
"title": "Landing Page title",
"readOnly": false,
"description": "The title of this landing page seen in the browser's title bar."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"published",
"unpublished",
"draft"
],
"type": "string",
"title": "Landing Page status",
"readOnly": true,
"description": "The status of this landing page."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "Landing Page list id",
"example": "fde02ad86b",
"readOnly": false,
"description": "The list's ID associated with this landing page."
},
"store_id": {
"type": "string",
"title": "Store ID",
"readOnly": false,
"description": "The ID of the store associated with this landing page."
},
"tracking": {
"type": "object",
"title": "Tracking Settings",
"properties": {
"track_with_mailchimp": {
"type": "boolean",
"title": "Track with Mailchimp",
"description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."
},
"enable_restricted_data_processing": {
"type": "boolean",
"title": "Enable restricted data processing",
"description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)."
}
},
"description": "The tracking settings applied to this landing page."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was created."
},
"updated_at": {
"type": "string",
"title": "Updated_at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was updated at."
},
"description": {
"type": "string",
"title": "Landing Page description",
"readOnly": false,
"description": "The description of this landing page."
},
"template_id": {
"type": "integer",
"title": "Landing Page template_id",
"readOnly": true,
"description": "The template_id of this landing page."
},
"published_at": {
"type": "string",
"title": "Published at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"created_by_source": {
"type": "string",
"title": "Created By Source",
"readOnly": true,
"description": "Created by mobile or web"
}
},
"description": "A summary of an individual landing page's settings and content."
}
LandingPagesGetPageInfoResponse
{
"type": "object",
"title": "Landing Page",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "030092c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Published url",
"readOnly": true,
"description": "The url of the published landing page."
},
"name": {
"type": "string",
"title": "Landing Page Name",
"readOnly": false,
"description": "The name of this landing page."
},
"title": {
"type": "string",
"title": "Landing Page title",
"readOnly": false,
"description": "The title of this landing page seen in the browser's title bar."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"published",
"unpublished",
"draft"
],
"type": "string",
"title": "Landing Page status",
"readOnly": true,
"description": "The status of this landing page."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "Landing Page list id",
"example": "fde02ad86b",
"readOnly": false,
"description": "The list's ID associated with this landing page."
},
"store_id": {
"type": "string",
"title": "Store ID",
"readOnly": false,
"description": "The ID of the store associated with this landing page."
},
"tracking": {
"type": "object",
"title": "Tracking Settings",
"properties": {
"track_with_mailchimp": {
"type": "boolean",
"title": "Track with Mailchimp",
"description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."
},
"enable_restricted_data_processing": {
"type": "boolean",
"title": "Enable restricted data processing",
"description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)."
}
},
"description": "The tracking settings applied to this landing page."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was created."
},
"updated_at": {
"type": "string",
"title": "Updated_at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was updated at."
},
"description": {
"type": "string",
"title": "Landing Page description",
"readOnly": false,
"description": "The description of this landing page."
},
"template_id": {
"type": "integer",
"title": "Landing Page template_id",
"readOnly": true,
"description": "The template_id of this landing page."
},
"published_at": {
"type": "string",
"title": "Published at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"created_by_source": {
"type": "string",
"title": "Created By Source",
"readOnly": true,
"description": "Created by mobile or web"
}
},
"description": "A summary of an individual landing page's settings and content."
}
LandingPagesGetPageInfodefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesList200Response
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"landing_pages": {
"type": "array",
"items": {
"type": "object",
"title": "Landing Page",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "030092c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Published url",
"readOnly": true,
"description": "The url of the published landing page."
},
"name": {
"type": "string",
"title": "Landing Page Name",
"readOnly": false,
"description": "The name of this landing page."
},
"title": {
"type": "string",
"title": "Landing Page title",
"readOnly": false,
"description": "The title of this landing page seen in the browser's title bar."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"published",
"unpublished",
"draft"
],
"type": "string",
"title": "Landing Page status",
"readOnly": true,
"description": "The status of this landing page."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "Landing Page list id",
"example": "fde02ad86b",
"readOnly": false,
"description": "The list's ID associated with this landing page."
},
"store_id": {
"type": "string",
"title": "Store ID",
"readOnly": false,
"description": "The ID of the store associated with this landing page."
},
"tracking": {
"type": "object",
"title": "Tracking Settings",
"properties": {
"track_with_mailchimp": {
"type": "boolean",
"title": "Track with Mailchimp",
"description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."
},
"enable_restricted_data_processing": {
"type": "boolean",
"title": "Enable restricted data processing",
"description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)."
}
},
"description": "The tracking settings applied to this landing page."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was created."
},
"updated_at": {
"type": "string",
"title": "Updated_at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was updated at."
},
"description": {
"type": "string",
"title": "Landing Page description",
"readOnly": false,
"description": "The description of this landing page."
},
"template_id": {
"type": "integer",
"title": "Landing Page template_id",
"readOnly": true,
"description": "The template_id of this landing page."
},
"published_at": {
"type": "string",
"title": "Published at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"created_by_source": {
"type": "string",
"title": "Created By Source",
"readOnly": true,
"description": "Created by mobile or web"
}
},
"description": "A summary of an individual landing page's settings and content."
},
"description": "The landing pages on the account"
}
},
"description": "A collection of landing pages."
}
LandingPagesListResponse
{
"type": "object",
"properties": {
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"landing_pages": {
"type": "array",
"items": {
"type": "object",
"title": "Landing Page",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "030092c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Published url",
"readOnly": true,
"description": "The url of the published landing page."
},
"name": {
"type": "string",
"title": "Landing Page Name",
"readOnly": false,
"description": "The name of this landing page."
},
"title": {
"type": "string",
"title": "Landing Page title",
"readOnly": false,
"description": "The title of this landing page seen in the browser's title bar."
},
"_links": {
"type": "array",
"items": {
"type": "object",
"title": "Resource Link",
"properties": {
"rel": {
"type": "string",
"title": "Rel",
"readOnly": true,
"description": "As with an HTML 'rel' attribute, this describes the type of link."
},
"href": {
"type": "string",
"title": "Href",
"readOnly": true,
"description": "This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"type": "string",
"title": "Method",
"readOnly": true,
"description": "The HTTP method that should be used when accessing the URL defined in 'href'."
},
"schema": {
"type": "string",
"title": "Schema",
"readOnly": true,
"description": "For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to."
},
"targetSchema": {
"type": "string",
"title": "Target Schema",
"readOnly": true,
"description": "For GETs, this is a URL representing the schema that the response should conform to."
}
},
"description": "This object represents a link from the resource where it is found to another resource or action that may be performed."
},
"title": "Links",
"readOnly": true,
"description": "A list of link types and descriptions for the API schema documents."
},
"status": {
"enum": [
"published",
"unpublished",
"draft"
],
"type": "string",
"title": "Landing Page status",
"readOnly": true,
"description": "The status of this landing page."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "Landing Page list id",
"example": "fde02ad86b",
"readOnly": false,
"description": "The list's ID associated with this landing page."
},
"store_id": {
"type": "string",
"title": "Store ID",
"readOnly": false,
"description": "The ID of the store associated with this landing page."
},
"tracking": {
"type": "object",
"title": "Tracking Settings",
"properties": {
"track_with_mailchimp": {
"type": "boolean",
"title": "Track with Mailchimp",
"description": "Use cookies to track unique visitors and calculate overall conversion rate. Learn more [here](https://mailchimp.com/help/use-track-mailchimp/)."
},
"enable_restricted_data_processing": {
"type": "boolean",
"title": "Enable restricted data processing",
"description": "Google offers restricted data processing in connection with the California Consumer Privacy Act (CCPA) to restrict how Google uses certain identifiers and other data processed in the provision of its services. You can learn more about Google's restricted data processing within Google Ads [here](https://privacy.google.com/businesses/rdp/)."
}
},
"description": "The tracking settings applied to this landing page."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was created."
},
"updated_at": {
"type": "string",
"title": "Updated_at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was updated at."
},
"description": {
"type": "string",
"title": "Landing Page description",
"readOnly": false,
"description": "The description of this landing page."
},
"template_id": {
"type": "integer",
"title": "Landing Page template_id",
"readOnly": true,
"description": "The template_id of this landing page."
},
"published_at": {
"type": "string",
"title": "Published at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished at",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"created_by_source": {
"type": "string",
"title": "Created By Source",
"readOnly": true,
"description": "Created by mobile or web"
}
},
"description": "A summary of an individual landing page's settings and content."
},
"description": "The landing pages on the account"
}
},
"description": "A collection of landing pages."
}
LandingPagesListdefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesPublishActionResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesPublishActiondefaultResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}
LandingPagesUnpublishActionResponse
{
"type": "object",
"title": "Problem Detail Document",
"required": [
"type",
"title",
"status",
"detail",
"instance"
],
"properties": {
"type": {
"type": "string",
"title": "Problem Type",
"example": "https://mailchimp.com/developer/marketing/docs/errors/",
"description": "An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type."
},
"title": {
"type": "string",
"title": "Error Title",
"example": "Resource Not Found",
"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."
},
"detail": {
"type": "string",
"title": "Error Message",
"example": "The requested resource could not be found.",
"description": "A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](https://mailchimp.com/developer/)."
},
"status": {
"type": "integer",
"title": "HTTP Status Code",
"example": 404,
"description": "The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem."
},
"instance": {
"type": "string",
"title": "Instance ID",
"example": "995c5cb0-3280-4a6e-808b-3b096d0bb219",
"description": "A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support."
}
},
"description": "An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'."
}