Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://server.api.mailchimp.com/3.0
/automations/{workflow_id}/emails/{workflow_email_id}
Update settings for a classic automation workflow email. Only works with workflows of type: abandonedBrowse, abandonedCart, emailFollowup, or singleWelcome.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| workflow_id | path | required | string | The unique id for the Automation workflow. |
| workflow_email_id | path | required | string | The unique id for the Automation workflow email. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutomationsUpdateWorkflowEmailRequest"
}
}
},
"required": true
}
PATCH /automations/{workflow_id}/emails/{workflow_email_id}
/batch-webhooks/{batch_webhook_id}
Update a webhook that will fire whenever any batch request completes processing.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| batch_webhook_id | path | required | string | The unique id for the batch webhook. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchWebhooksUpdateWebhookRequest"
}
}
},
"required": true
}
PATCH /batch-webhooks/{batch_webhook_id}
/campaign-folders/{folder_id}
Update a specific folder used to organize campaigns.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| folder_id | path | required | string | The unique id for the campaign folder. |
{
"$ref": "#/components/requestBodies/postCampaignFoldersBody"
}
PATCH /campaign-folders/{folder_id}
/campaigns/{campaign_id}
Update some or all of the settings for a specific campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| campaign_id | path | required | string | The unique id for the campaign. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignsUpdateSettingsRequest"
}
}
},
"required": true
}
PATCH /campaigns/{campaign_id}
/campaigns/{campaign_id}/feedback/{feedback_id}
Update a specific feedback message for a campaign.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| campaign_id | path | required | string | The unique id for the campaign. |
| feedback_id | path | required | string | The unique id for the feedback message. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignsUpdateFeedbackMessageRequest"
}
}
},
"required": true
}
PATCH /campaigns/{campaign_id}/feedback/{feedback_id}
/ecommerce/stores/{store_id}
Update a store.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateStoreRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}
/ecommerce/stores/{store_id}/carts/{cart_id}
Update a specific cart.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| cart_id | path | required | string | The id for the cart. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateCartByIdRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/carts/{cart_id}
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Update a specific cart line item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| cart_id | path | required | string | The id for the cart. |
| line_id | path | required | string | The id for the line item of a cart. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateCartLineItemRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
/ecommerce/stores/{store_id}/customers/{customer_id}
Update a customer.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| customer_id | path | required | string | The id for the customer of a store. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateCustomerRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/customers/{customer_id}
/ecommerce/stores/{store_id}/orders/{order_id}
Update a specific order.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| order_id | path | required | string | The id for the order in a store. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateSpecificOrderRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/orders/{order_id}
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Update a specific order line item.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| order_id | path | required | string | The id for the order in a store. |
| line_id | path | required | string | The id for the line item of an order. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateOrderLineRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
/ecommerce/stores/{store_id}/products/{product_id}
Update a specific product.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateProductRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/products/{product_id}
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Update a product image.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
| image_id | path | required | string | The id for the product image. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateProductImageRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Update a product variant.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| product_id | path | required | string | The id for the product of a store. |
| variant_id | path | required | string | The id for the product variant. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdateProductVariantRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
Update a promo rule.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| promo_rule_id | path | required | string | The id for the promo rule of a store. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdatePromoRuleRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Update a promo code.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| store_id | path | required | string | The store id. |
| promo_rule_id | path | required | string | The id for the promo rule of a store. |
| promo_code_id | path | required | string | The id for the promo code of a store. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EcommerceUpdatePromoCodeRequest"
}
}
},
"required": true
}
PATCH /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
/file-manager/files/{file_id}
Update a file in the File Manager.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| file_id | path | required | string | The unique id for the File Manager file. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileManagerUpdateFileRequest"
}
}
},
"required": true
}
PATCH /file-manager/files/{file_id}
/file-manager/folders/{folder_id}
Update a specific File Manager folder.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| folder_id | path | required | string | The unique id for the File Manager folder. |
{
"$ref": "#/components/requestBodies/postFileManagerFoldersBody"
}
PATCH /file-manager/folders/{folder_id}
/landing-pages/{page_id}
Update a landing page.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page_id | path | required | string | The unique id for the page. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LandingPagesUpdatePageByIdRequest"
}
}
},
"required": true
}
PATCH /landing-pages/{page_id}
/lists/{list_id}
Update the settings for a specific list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListsUpdateSettingsRequest"
}
}
},
"required": true
}
PATCH /lists/{list_id}
/lists/{list_id}/interest-categories/{interest_category_id}
Update a specific interest category.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| interest_category_id | path | required | string | The unique ID for the interest category. |
{
"$ref": "#/components/requestBodies/postListsIdInterestCategoriesBody"
}
PATCH /lists/{list_id}/interest-categories/{interest_category_id}
/lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
Update interests or 'group names' for a specific category.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| interest_category_id | path | required | string | The unique ID for the interest category. |
| interest_id | path | required | string | The specific interest or 'group name'. |
{
"$ref": "#/components/requestBodies/postListsIdInterestCategoriesIdInterestsBody"
}
PATCH /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id}
/lists/{list_id}/members/{subscriber_hash}
Update information for a specific list member.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. |
| skip_merge_validation | query | optional | boolean | If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListsUpdateMemberRequest"
}
}
},
"required": true
}
PATCH /lists/{list_id}/members/{subscriber_hash}
/lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
Update a specific note for a specific list member.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| subscriber_hash | path | required | string | The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id. |
| note_id | path | required | string | The id for the note. |
{
"$ref": "#/components/requestBodies/postListsIdMembersIdNotesBody"
}
PATCH /lists/{list_id}/members/{subscriber_hash}/notes/{note_id}
/lists/{list_id}/merge-fields/{merge_id}
Update a specific merge field.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| merge_id | path | required | string | The id for the merge field. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListsUpdateMergeFieldRequest"
}
}
},
"required": true
}
PATCH /lists/{list_id}/merge-fields/{merge_id}
/lists/{list_id}/segments/{segment_id}
Update a specific segment in a list.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| segment_id | path | required | string | The unique id for the segment. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListsUpdateSegmentByIdRequest"
}
}
},
"required": true
}
PATCH /lists/{list_id}/segments/{segment_id}
/lists/{list_id}/webhooks/{webhook_id}
Update the settings for an existing webhook.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| list_id | path | required | string | The unique ID for the list. |
| webhook_id | path | required | string | The webhook's id. |
{
"$ref": "#/components/requestBodies/postListsIdWebhooksBody"
}
PATCH /lists/{list_id}/webhooks/{webhook_id}
/template-folders/{folder_id}
Update a specific folder used to organize templates.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| folder_id | path | required | string | The unique id for the template folder. |
{
"$ref": "#/components/requestBodies/postTemplateFoldersBody"
}
PATCH /template-folders/{folder_id}
/templates/{template_id}
Update the name, HTML, or `folder_id` of an existing template.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| template_id | path | required | string | The unique id for the template. |
{
"$ref": "#/components/requestBodies/postTemplatesBody"
}
PATCH /templates/{template_id}
AccountExportInfo200Response
{
"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."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportInfoResponse
{
"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."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportInfodefaultResponse
{
"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'."
}
AccountExportsCreateNewExport200Response
{
"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."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportsCreateNewExportRequest
{
"type": "object",
"title": "Create an account export",
"required": [
"include_stages"
],
"properties": {
"include_stages": {
"type": "array",
"items": {
"enum": [
"audiences",
"campaigns",
"events",
"gallery_files",
"reports",
"templates"
],
"type": "string"
},
"title": "Include Stages",
"example": "[\"audiences\", \"gallery_files\"]",
"description": "The stages of an account export to include."
},
"since_timestamp": {
"type": "string",
"title": "Since Timestamp",
"format": "date-time",
"example": "2021-08-23T14:15:09Z",
"description": "An ISO 8601 date that will limit the export to only records created after a given time. For instance, the reports stage will contain any campaign sent after the given timestamp. Audiences, however, are excluded from this limit."
}
},
"description": "Creates an account export with the given parameters."
}
AccountExportsCreateNewExportResponse
{
"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."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
}
AccountExportsCreateNewExportdefaultResponse
{
"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'."
}
AccountExportsListForGivenAccount200Response
{
"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."
},
"exports": {
"type": "array",
"items": {
"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."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
},
"title": "Account Exports",
"description": "An array of objects, each representing an account export."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an account export."
}
AccountExportsListForGivenAccountResponse
{
"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."
},
"exports": {
"type": "array",
"items": {
"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."
},
"started": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "Start time for the export."
},
"finished": {
"type": "string",
"title": "Finish Time",
"format": "date-time",
"description": "If finished, the finish time for the export."
},
"export_id": {
"type": "integer",
"title": "Export ID",
"description": "The ID for the export."
},
"download_url": {
"type": "string",
"title": "Download URL",
"description": "If the export is finished, the download URL for an export. URLs are only valid for 90 days after the export completes."
},
"size_in_bytes": {
"type": "integer",
"title": "Export Size",
"description": "The size of the uncompressed export in bytes."
}
},
"description": "An account export."
},
"title": "Account Exports",
"description": "An array of objects, each representing an account export."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an account export."
}
AccountExportsListForGivenAccountdefaultResponse
{
"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'."
}
ActivityFeedGetLatestChimpChatter200Response
{
"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."
},
"chimp_chatter": {
"type": "array",
"items": {
"type": "object",
"title": "ChimpChatter",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://dev.mailchimp.com/reports/summary?id=1",
"readOnly": true,
"description": "URL to a report that includes this activity"
},
"type": {
"enum": [
"lists:new-subscriber",
"lists:unsubscribes",
"lists:profile-updates",
"campaigns:facebook-likes",
"campaigns:forward-to-friend",
"lists:imports"
],
"type": "string",
"title": "Type",
"example": "campaigns:forward-to-friend",
"readOnly": true,
"description": "The type of activity"
},
"title": {
"type": "string",
"title": "Title",
"example": "1 new subscriber to Your New Campaign!",
"readOnly": true
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, list ID for the associated list"
},
"message": {
"type": "string",
"title": "Message",
"example": "People are telling their friends about your campaign!",
"readOnly": true
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, campaign ID for the associated campaign"
},
"update_time": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time this activity was updated."
}
},
"description": "A Chimp Chatter message"
},
"readOnly": true,
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
},
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
ActivityFeedGetLatestChimpChatterResponse
{
"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."
},
"chimp_chatter": {
"type": "array",
"items": {
"type": "object",
"title": "ChimpChatter",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://dev.mailchimp.com/reports/summary?id=1",
"readOnly": true,
"description": "URL to a report that includes this activity"
},
"type": {
"enum": [
"lists:new-subscriber",
"lists:unsubscribes",
"lists:profile-updates",
"campaigns:facebook-likes",
"campaigns:forward-to-friend",
"lists:imports"
],
"type": "string",
"title": "Type",
"example": "campaigns:forward-to-friend",
"readOnly": true,
"description": "The type of activity"
},
"title": {
"type": "string",
"title": "Title",
"example": "1 new subscriber to Your New Campaign!",
"readOnly": true
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, list ID for the associated list"
},
"message": {
"type": "string",
"title": "Message",
"example": "People are telling their friends about your campaign!",
"readOnly": true
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "If it exists, campaign ID for the associated campaign"
},
"update_time": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time this activity was updated."
}
},
"description": "A Chimp Chatter message"
},
"readOnly": true,
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
},
"description": "An array of Chimp Chatter messages. There's a maximum of 200 messages present for an account."
}
ActivityFeedGetLatestChimpChatterdefaultResponse
{
"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'."
}
AuthorizedAppsGetInfo200Response
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_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": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
}
AuthorizedAppsGetInfoResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_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": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
}
AuthorizedAppsGetInfodefaultResponse
{
"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'."
}
AuthorizedAppsListConnectedApplications200Response
{
"type": "object",
"properties": {
"apps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_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": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
},
"title": "Authorized Applications",
"description": "An array of objects, each representing an authorized application."
},
"_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."
}
},
"description": "An array of objects, each representing an authorized application."
}
AuthorizedAppsListConnectedApplicationsResponse
{
"type": "object",
"properties": {
"apps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Client ID",
"description": "The ID for the application."
},
"name": {
"type": "string",
"title": "Application Name",
"description": "The name of the application."
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"title": "Application Users",
"description": "An array of usernames for users who have linked the app."
},
"_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": {
"type": "string",
"title": "Application Description",
"description": "A short description of the application."
}
},
"description": "An authorized app."
},
"title": "Authorized Applications",
"description": "An array of objects, each representing an authorized application."
},
"_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."
}
},
"description": "An array of objects, each representing an authorized application."
}
AuthorizedAppsListConnectedApplicationsdefaultResponse
{
"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'."
}
AutomationsAddSubscriberToWorkflowEmail200Response
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsAddSubscriberToWorkflowEmailRequest
{
"type": "object",
"title": "Subscriber in Automation Queue",
"required": [
"email_address"
],
"properties": {
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsAddSubscriberToWorkflowEmailResponse
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsAddSubscriberToWorkflowEmaildefaultResponse
{
"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'."
}
AutomationsArchiveActionResponse
{
"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'."
}
AutomationsArchiveActiondefaultResponse
{
"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'."
}
AutomationsClassicAutomationSubscriberInfo200Response
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsClassicAutomationSubscriberInfoResponse
{
"type": "object",
"title": "Subscriber in Automation Queue",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Information about subscribers in an Automation email queue."
}
AutomationsClassicAutomationSubscriberInfodefaultResponse
{
"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'."
}
AutomationsCreateClassic200Response
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsCreateClassicRequest
{
"type": "object",
"title": "Automation Workflow",
"required": [
"recipients",
"trigger_settings"
],
"properties": {
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
}
},
"description": "The settings for the Automation workflow."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69xxx",
"description": "The id of the List."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
}
},
"description": "List settings for the Automation."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"workflow_type": {
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow. Currently only supports 'abandonedCart'."
}
},
"description": "Trigger settings for the Automation."
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsCreateClassicResponse
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsCreateClassicdefaultResponse
{
"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'."
}
AutomationsDeleteWorkflowEmailResponse
{
"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'."
}
AutomationsDeleteWorkflowEmaildefaultResponse
{
"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'."
}
AutomationsGetClassicWorkflowEmails200Response
{
"type": "object",
"title": "Automation Emails",
"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."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
},
"title": "Emails",
"description": "An array of objects, each representing an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of the emails in an Automation workflow."
}
AutomationsGetClassicWorkflowEmailsResponse
{
"type": "object",
"title": "Automation Emails",
"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."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
},
"title": "Emails",
"description": "An array of objects, each representing an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of the emails in an Automation workflow."
}
AutomationsGetClassicWorkflowEmailsdefaultResponse
{
"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'."
}
AutomationsGetClassicWorkflowInfo200Response
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsGetClassicWorkflowInfoResponse
{
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
}
AutomationsGetClassicWorkflowInfodefaultResponse
{
"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'."
}
AutomationsGetEmailInfo200Response
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsGetEmailInfoResponse
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsGetEmailInfodefaultResponse
{
"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'."
}
AutomationsGetRemovedSubscriberInfo200Response
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsGetRemovedSubscriberInfoResponse
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsGetRemovedSubscriberInfodefaultResponse
{
"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'."
}
AutomationsGetRemovedSubscribers200Response
{
"type": "object",
"title": "Removed Subscribers",
"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."
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber who was removed from an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "A summary of the subscribers who were removed from an Automation workflow."
}
AutomationsGetRemovedSubscribersResponse
{
"type": "object",
"title": "Removed Subscribers",
"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."
},
"subscribers": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber who was removed from an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "A summary of the subscribers who were removed from an Automation workflow."
}
AutomationsGetRemovedSubscribersdefaultResponse
{
"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'."
}
AutomationsListQueueEmails200Response
{
"type": "object",
"properties": {
"queue": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber in Automation Queue",
"required": [
"email_address"
],
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in an Automation email queue."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber queue for an email in an Automation workflow."
},
"_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."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "An automation workflow"
}
AutomationsListQueueEmailsResponse
{
"type": "object",
"properties": {
"queue": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber in Automation Queue",
"required": [
"email_address"
],
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"next_send": {
"type": "string",
"title": "Next Send",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the next send for the workflow email in ISO 8601 format."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in an Automation email queue."
},
"title": "Trigger",
"readOnly": true,
"description": "An array of objects, each representing a subscriber queue for an email in an Automation workflow."
},
"_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."
},
"email_id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies an email in an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
}
},
"description": "An automation workflow"
}
AutomationsListQueueEmailsdefaultResponse
{
"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'."
}
AutomationsListSummary200Response
{
"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."
},
"automations": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
},
"title": "Automation Workflows",
"description": "An array of objects, each representing an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an Automation workflow."
}
AutomationsListSummaryResponse
{
"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."
},
"automations": {
"type": "array",
"items": {
"type": "object",
"title": "Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Automation Campaign ID",
"readOnly": true,
"description": "A string that identifies the Automation."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Automation Status",
"readOnly": true,
"description": "The current status of the Automation."
},
"settings": {
"type": "object",
"title": "Automation Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The Automation's custom 'To' name, typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Whether to automatically inline the CSS included with the Automation content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Whether to automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the Automation."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the Automation. Defaults to `true`."
},
"use_conversation": {
"type": "boolean",
"title": "Conversations",
"description": "Whether to use Mailchimp Conversation feature to manage replies"
}
},
"description": "The settings for the Automation workflow."
},
"tracking": {
"type": "object",
"title": "Automation Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the Automation. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the Automation. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for the Automation."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "1a2df69xxx",
"description": "The id of the store."
},
"list_name": {
"type": "string",
"title": "List Name",
"description": "List Name."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "List settings for the Automation."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was started in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the Automation was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for the Automation."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks, divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "A summary of opens and clicks for sent campaigns."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
}
},
"description": "A summary of an individual Automation workflow's settings and content."
},
"title": "Automation Workflows",
"description": "An array of objects, each representing an Automation workflow."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of objects, each representing an Automation workflow."
}
AutomationsListSummarydefaultResponse
{
"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'."
}
AutomationsPauseAutomatedEmailResponse
{
"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'."
}
AutomationsPauseAutomatedEmaildefaultResponse
{
"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'."
}
AutomationsPauseWorkflowEmailsResponse
{
"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'."
}
AutomationsPauseWorkflowEmailsdefaultResponse
{
"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'."
}
AutomationsRemoveSubscriberFromWorkflow200Response
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsRemoveSubscriberFromWorkflowResponse
{
"type": "object",
"title": "Subscriber Removed from Automation Workflow",
"properties": {
"id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies a list."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "A summary of a subscriber removed from an Automation workflow."
}
AutomationsRemoveSubscriberFromWorkflowdefaultResponse
{
"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'."
}
AutomationsStartAllEmailsResponse
{
"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'."
}
AutomationsStartAllEmailsdefaultResponse
{
"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'."
}
AutomationsStartAutomatedEmailResponse
{
"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'."
}
AutomationsStartAutomatedEmaildefaultResponse
{
"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'."
}
AutomationsUpdateWorkflowEmail200Response
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsUpdateWorkflowEmailRequest
{
"type": "object",
"title": "Update information about a specific workflow email",
"properties": {
"delay": {
"type": "object",
"title": "Automation Delay",
"required": [
"action"
],
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"example": "day",
"description": "The type of delay for an automation email."
},
"action": {
"enum": [
"signup",
"ecomm_abandoned_browse",
"ecomm_abandoned_cart"
],
"type": "string",
"title": "Delay Action",
"example": "signup",
"description": "The action that triggers the delay of an automation emails."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"example": 1,
"description": "The delay amount for an automation email."
},
"direction": {
"enum": [
"after"
],
"type": "string",
"title": "Delay Direction",
"example": "after",
"description": "Whether the delay settings describe before or after the delay action of an automation email."
}
},
"description": "The delay settings for an automation email."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Automation Title",
"description": "The title of the Automation."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the Automation."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name for the Automation (not an email address)."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
}
},
"description": "Update information about an individual Automation workflow email."
}
AutomationsUpdateWorkflowEmailResponse
{
"type": "object",
"title": "Automation Workflow Email",
"properties": {
"id": {
"type": "string",
"title": "Automation Email ID",
"readOnly": true,
"description": "A string that uniquely identifies the Automation email."
},
"delay": {
"type": "object",
"title": "Automation Delay",
"properties": {
"type": {
"enum": [
"now",
"day",
"hour",
"week"
],
"type": "string",
"title": "Delay Type",
"description": "The type of delay for an Automation email."
},
"action": {
"enum": [
"previous_campaign_sent",
"previous_campaign_opened",
"previous_campaign_not_opened",
"previous_campaign_clicked_any",
"previous_campaign_not_clicked_any",
"previous_campaign_specific_clicked",
"ecomm_bought_any",
"ecomm_bought_product",
"ecomm_bought_category",
"ecomm_not_bought_any",
"ecomm_abandoned_cart",
"campaign_sent",
"opened_email",
"not_opened_email",
"clicked_email",
"not_clicked_email",
"campaign_specific_clicked",
"manual",
"signup",
"merge_changed",
"group_add",
"group_remove",
"mandrill_sent",
"mandrill_opened",
"mandrill_clicked",
"mandrill_any",
"api",
"goal",
"annual",
"birthday",
"date",
"date_added",
"tag_add"
],
"type": "string",
"title": "Delay Action",
"description": "The action that triggers the delay of an Automation email."
},
"amount": {
"type": "integer",
"title": "Delay Amount",
"readOnly": true,
"description": "The delay amount for an Automation email."
},
"direction": {
"enum": [
"before",
"after"
],
"type": "string",
"title": "Delay Direction",
"description": "Whether the delay settings describe before or after the delay action of an Automation email."
},
"full_description": {
"type": "string",
"title": "Full Delay Description",
"example": "1 day after subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the delay and trigger action settings for an Automation email."
},
"action_description": {
"type": "string",
"title": "Delay Action Description",
"example": "subscribers purchase anything from your store",
"readOnly": true,
"description": "The user-friendly description of the action that triggers an Automation email."
}
},
"description": "The delay settings for an Automation email."
},
"_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": [
"save",
"paused",
"sending"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Automation Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this automation in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"position": {
"type": "integer",
"title": "Email Position",
"readOnly": true,
"description": "The position of an Automation email in a workflow."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
}
},
"description": "Settings for the campaign including the email subject, from name, and from email address."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [Click Tale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on a subscriber's email address."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": " The date and time a campaign was sent in ISO 8601 format"
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/getting-started-with-groups/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was started in ISO 8601 format."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"workflow_id": {
"type": "string",
"title": "Workflow ID",
"readOnly": true,
"description": "A string that uniquely identifies an Automation workflow."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"trigger_settings": {
"type": "object",
"title": "Automation Trigger",
"required": [
"workflow_type"
],
"properties": {
"runtime": {
"type": "object",
"title": "Automation Workflow Runtime Settings",
"properties": {
"days": {
"type": "array",
"items": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string"
},
"title": "Days",
"description": "The days an Automation workflow can send."
},
"hours": {
"type": "object",
"title": "Hours",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"send_asap",
"send_between",
"send_at"
],
"type": "string",
"title": "Email Send Time Settings",
"description": "When to send the Automation email."
}
},
"description": "The hours an Automation workflow can send."
}
},
"description": "A workflow's runtime settings for an Automation."
},
"workflow_type": {
"enum": [
"abandonedBrowse",
"abandonedCart",
"api",
"bestCustomers",
"categoryFollowup",
"dateAdded",
"emailFollowup",
"emailSeries",
"groupAdd",
"groupRemove",
"mandrill",
"productFollowup",
"purchaseFollowup",
"recurringEvent",
"specialEvent",
"visitUrl",
"welcomeSeries"
],
"type": "string",
"title": "Workflow Type",
"description": "The type of Automation workflow."
},
"workflow_title": {
"type": "string",
"title": "Workflow Title",
"readOnly": true,
"description": "The title of the workflow type."
},
"workflow_emails_count": {
"type": "integer",
"title": "Workflow Emails Count",
"readOnly": true,
"description": "The number of emails in the Automation workflow."
}
},
"description": "Available triggers for Automation workflows.",
"discriminator": {
"propertyName": "workflow_type"
}
},
"has_logo_merge_tag": {
"type": "boolean",
"title": "Has Logo Merge Tag",
"example": true,
"readOnly": true,
"description": "Determines if the campaign contains the *|BRAND:LOGO|* merge tag."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"example": true,
"readOnly": true,
"description": "Determines if the automation email needs its blocks refreshed by opening the web-based campaign editor."
}
},
"description": "A summary of an individual Automation workflow email."
}
AutomationsUpdateWorkflowEmaildefaultResponse
{
"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'."
}
BatchWebhooksAddWebhook200Response
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksAddWebhookRequest
{
"type": "object",
"title": "Batch Webhook",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"description": "A valid URL for the Webhook."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the webhook receives requests or not."
}
},
"description": "Add a new Batch Webook."
}
BatchWebhooksAddWebhookResponse
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksAddWebhookdefaultResponse
{
"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'."
}
BatchWebhooksGetInfo200Response
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksGetInfoResponse
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksGetInfodefaultResponse
{
"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'."
}
BatchWebhooksListWebhooks200Response
{
"type": "object",
"title": "Batch Webhooks",
"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."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
},
"title": "Webhooks",
"description": "An array of objects, each representing a Batch Webhook."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage webhooks for batch requests."
}
BatchWebhooksListWebhooksResponse
{
"type": "object",
"title": "Batch Webhooks",
"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."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
},
"title": "Webhooks",
"description": "An array of objects, each representing a Batch Webhook."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage webhooks for batch requests."
}
BatchWebhooksListWebhooksdefaultResponse
{
"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'."
}
BatchWebhooksRemoveWebhookResponse
{
"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'."
}
BatchWebhooksRemoveWebhookdefaultResponse
{
"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'."
}
BatchWebhooksUpdateWebhook200Response
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksUpdateWebhookRequest
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"description": "A valid URL for the Webhook."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the webhook receives requests or not."
}
},
"description": "Update an existing Batch Webook."
}
BatchWebhooksUpdateWebhookResponse
{
"type": "object",
"title": "Batch Webhook",
"properties": {
"id": {
"type": "string",
"title": "Batch Webhook ID",
"readOnly": true,
"description": "A string that uniquely identifies this Batch Webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": false,
"description": "A valid URL for the Webhook."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"readOnly": false,
"description": "Whether the webhook receives requests or not."
}
},
"description": "A webhook configured for batch status updates."
}
BatchWebhooksUpdateWebhookdefaultResponse
{
"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'."
}
BatchesGetOperationStatus200Response
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesGetOperationStatusResponse
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesGetOperationStatusdefaultResponse
{
"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'."
}
BatchesListRequestsSummary200Response
{
"type": "object",
"title": "Batch Operations",
"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."
},
"batches": {
"type": "array",
"items": {
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
},
"title": "Batches",
"description": "An array of objects representing batch calls."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of batch requests that have been made."
}
BatchesListRequestsSummaryResponse
{
"type": "object",
"title": "Batch Operations",
"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."
},
"batches": {
"type": "array",
"items": {
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
},
"title": "Batches",
"description": "An array of objects representing batch calls."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of batch requests that have been made."
}
BatchesListRequestsSummarydefaultResponse
{
"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'."
}
BatchesStartOperationProcess200Response
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesStartOperationProcessRequest
{
"type": "object",
"required": [
"operations"
],
"properties": {
"operations": {
"type": "array",
"items": {
"type": "object",
"title": "Operations",
"required": [
"method",
"path"
],
"properties": {
"body": {
"type": "string",
"title": "Body",
"example": "{\"title\":\"Test\"}",
"description": "A string containing the JSON body to use with the request."
},
"path": {
"type": "string",
"title": "Path",
"example": "/lists",
"description": "The relative path to use for the operation."
},
"method": {
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string",
"title": "HTTP Method",
"example": "POST",
"description": "The HTTP method to use for the operation."
},
"params": {
"type": "object",
"title": "Query Parameters",
"example": "{\"count\":10,\"offset\":0}",
"description": "Any request query parameters. Example parameters: {\"count\":10, \"offset\":0}"
},
"operation_id": {
"type": "string",
"title": "Operation ID",
"example": "my-id-123",
"description": "An optional client-supplied id returned with the operation results."
}
}
},
"title": "Operations List",
"description": "An array of objects that describes operations to perform."
}
}
}
BatchesStartOperationProcessResponse
{
"type": "object",
"title": "Batch",
"properties": {
"id": {
"type": "string",
"title": "Batch ID",
"readOnly": true,
"description": "A string that uniquely identifies this batch request."
},
"_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": [
"pending",
"preprocessing",
"started",
"finalizing",
"finished"
],
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the batch call. [Learn more](https://mailchimp.com/developer/marketing/guides/run-async-requests-batch-endpoint/#check-the-status-of-a-batch-operation) about the batch operation status."
},
"completed_at": {
"type": "string",
"title": "Completed At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when all operations in the batch request completed in ISO 8601 format."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the server received the batch request in ISO 8601 format."
},
"total_operations": {
"type": "integer",
"title": "Total Operations",
"readOnly": true,
"description": "The total number of operations to complete as part of this batch request. For GET requests requiring pagination, each page counts as a separate operation."
},
"response_body_url": {
"type": "string",
"title": "Response Body URL",
"readOnly": true,
"description": "The URL of the gzipped archive of the results of all the operations."
},
"errored_operations": {
"type": "integer",
"title": "Error Operations",
"readOnly": true,
"description": "The number of completed operations that returned an error."
},
"finished_operations": {
"type": "integer",
"title": "Finished Operations",
"readOnly": true,
"description": "The number of completed operations. This includes operations that returned an error."
}
},
"description": "The status of a batch request"
}
BatchesStartOperationProcessdefaultResponse
{
"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'."
}
BatchesStopRequestResponse
{
"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'."
}
BatchesStopRequestdefaultResponse
{
"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'."
}
CampaignFoldersAddNewFolder200Response
{
"type": "object",
"title": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersAddNewFolderRequest
{
"type": "object",
"title": "Campaign Folder",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Folder Name",
"description": "Name to associate with the folder."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersAddNewFolderResponse
{
"type": "object",
"title": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersAddNewFolderdefaultResponse
{
"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'."
}
CampaignFoldersDeleteFolderResponse
{
"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'."
}
CampaignFoldersDeleteFolderdefaultResponse
{
"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'."
}
CampaignFoldersGetFolderInfo200Response
{
"type": "object",
"title": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersGetFolderInfoResponse
{
"type": "object",
"title": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersGetFolderInfodefaultResponse
{
"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'."
}
CampaignFoldersListCampaignFolders200Response
{
"type": "object",
"title": "Campaign 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": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
},
"title": "Campaign Folders",
"description": "An array of objects representing campaign folders."
},
"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 campaign folders"
}
CampaignFoldersListCampaignFoldersResponse
{
"type": "object",
"title": "Campaign 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": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
},
"title": "Campaign Folders",
"description": "An array of objects representing campaign folders."
},
"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 campaign folders"
}
CampaignFoldersListCampaignFoldersdefaultResponse
{
"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'."
}
CampaignFoldersUpdateSpecificFolder200Response
{
"type": "object",
"title": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersUpdateSpecificFolderResponse
{
"type": "object",
"title": "Campaign Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this campaign folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in 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."
}
},
"description": "A folder used to organize campaigns."
}
CampaignFoldersUpdateSpecificFolderdefaultResponse
{
"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'."
}
CampaignsAddFeedback200Response
{
"type": "object",
"title": "Campaign Feedback",
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsAddFeedbackRequest
{
"type": "object",
"title": "Campaign Feedback",
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsAddFeedbackResponse
{
"type": "object",
"title": "Campaign Feedback",
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsAddFeedbackdefaultResponse
{
"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'."
}
CampaignsCancelSendActionResponse
{
"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'."
}
CampaignsCancelSendActiondefaultResponse
{
"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'."
}
CampaignsCreateNewMailchimpCampaign200Response
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsCreateNewMailchimpCampaignRequest
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options, specific to an RSS campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign. Note: while this field is not required for campaign creation, it is required for sending."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id of the template to use."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
}
},
"description": "List settings for the campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"multichannel"
],
"type": "string",
"title": "Content Type",
"example": "template",
"description": "How the campaign's content is put together. The old drag and drop editor uses 'template' while the new editor uses 'multichannel'. Defaults to template."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
}
},
"description": "The settings specific to A/B test campaigns."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsCreateNewMailchimpCampaignResponse
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsCreateNewMailchimpCampaigndefaultResponse
{
"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'."
}
CampaignsGetAll200Response
{
"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."
},
"campaigns": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
},
"title": "Campaigns",
"description": "An array of campaigns."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of campaigns."
}
CampaignsGetAllResponse
{
"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."
},
"campaigns": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
},
"title": "Campaigns",
"description": "An array of campaigns."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "An array of campaigns."
}
CampaignsGetAlldefaultResponse
{
"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'."
}
CampaignsGetContent200Response
{
"type": "object",
"title": "Campaign Content",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"_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."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"archive_html": {
"type": "string",
"title": "Campaign Archive HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>My Subject</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The Archive HTML for the campaign."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>*|MC:SUBJECT|*</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The raw HTML for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"example": "Green header",
"description": "Label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for multivariate campaigns."
}
},
"description": "The HTML and plain-text content for a campaign."
}
CampaignsGetContentResponse
{
"type": "object",
"title": "Campaign Content",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"_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."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"archive_html": {
"type": "string",
"title": "Campaign Archive HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>My Subject</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The Archive HTML for the campaign."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>*|MC:SUBJECT|*</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The raw HTML for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"example": "Green header",
"description": "Label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for multivariate campaigns."
}
},
"description": "The HTML and plain-text content for a campaign."
}
CampaignsGetContentdefaultResponse
{
"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'."
}
CampaignsGetFeedbackMessage200Response
{
"type": "object",
"title": "Campaign Feedback",
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsGetFeedbackMessageResponse
{
"type": "object",
"title": "Campaign Feedback",
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsGetFeedbackMessagedefaultResponse
{
"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'."
}
CampaignsGetInfo200Response
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsGetInfoResponse
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsGetInfodefaultResponse
{
"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'."
}
CampaignsGetSendChecklist200Response
{
"type": "object",
"title": "Send Checklist",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "ID",
"description": "The ID for the specific item."
},
"type": {
"enum": [
"success",
"warning",
"error"
],
"type": "string",
"title": "Type",
"description": "The item type."
},
"details": {
"type": "string",
"title": "Details",
"description": "Details about the specific feedback item."
},
"heading": {
"type": "string",
"title": "Heading",
"description": "The heading for the specific item."
}
}
},
"title": "Items",
"description": "A list of feedback items to review before sending your campaign."
},
"_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."
},
"is_ready": {
"type": "boolean",
"title": "Ready?",
"description": "Whether the campaign is ready to send."
}
},
"description": "The send checklist for the campaign."
}
CampaignsGetSendChecklistResponse
{
"type": "object",
"title": "Send Checklist",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "ID",
"description": "The ID for the specific item."
},
"type": {
"enum": [
"success",
"warning",
"error"
],
"type": "string",
"title": "Type",
"description": "The item type."
},
"details": {
"type": "string",
"title": "Details",
"description": "Details about the specific feedback item."
},
"heading": {
"type": "string",
"title": "Heading",
"description": "The heading for the specific item."
}
}
},
"title": "Items",
"description": "A list of feedback items to review before sending your campaign."
},
"_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."
},
"is_ready": {
"type": "boolean",
"title": "Ready?",
"description": "Whether the campaign is ready to send."
}
},
"description": "The send checklist for the campaign."
}
CampaignsGetSendChecklistdefaultResponse
{
"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'."
}
CampaignsListFeedback200Response
{
"type": "object",
"title": "Campaign Reports",
"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."
},
"feedback": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Feedback",
"required": [
"message"
],
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
},
"title": "Campaign Feedback",
"description": "A collection of feedback items for a campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of the comment feedback for a specific campaign."
}
CampaignsListFeedbackResponse
{
"type": "object",
"title": "Campaign Reports",
"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."
},
"feedback": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Feedback",
"required": [
"message"
],
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
},
"title": "Campaign Feedback",
"description": "A collection of feedback items for a campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of the comment feedback for a specific campaign."
}
CampaignsListFeedbackdefaultResponse
{
"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'."
}
CampaignsPauseRssCampaignResponse
{
"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'."
}
CampaignsPauseRssCampaigndefaultResponse
{
"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'."
}
CampaignsRemoveCampaignResponse
{
"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'."
}
CampaignsRemoveCampaigndefaultResponse
{
"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'."
}
CampaignsRemoveFeedbackMessageResponse
{
"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'."
}
CampaignsRemoveFeedbackMessagedefaultResponse
{
"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'."
}
CampaignsReplicateAction200Response
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsReplicateActionResponse
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsReplicateActiondefaultResponse
{
"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'."
}
CampaignsResendAction200Response
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsResendActionRequest
{
"type": "object",
"properties": {
"shortcut_type": {
"enum": [
"to_non_openers",
"to_new_subscribers",
"to_non_clickers"
],
"type": "string",
"title": "Resend Shortcut Type",
"description": "Which campaign resend shortcut to use. Default is `to_non_openers`."
}
}
}
CampaignsResendActionResponse
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsResendActiondefaultResponse
{
"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'."
}
CampaignsResumeRssCampaignResponse
{
"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'."
}
CampaignsResumeRssCampaigndefaultResponse
{
"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'."
}
CampaignsScheduleDeliveryRequest
{
"type": "object",
"required": [
"schedule_time"
],
"properties": {
"timewarp": {
"type": "boolean",
"title": "Timewarp",
"description": "Choose whether the campaign should use [Timewarp](https://mailchimp.com/help/use-timewarp/) when sending. Campaigns scheduled with Timewarp are localized based on the recipients' time zones. For example, a Timewarp campaign with a `schedule_time` of 13:00 will be sent to each recipient at 1:00pm in their local time. Cannot be set to `true` for campaigns using [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/)."
},
"schedule_time": {
"type": "string",
"title": "Schedule Time",
"format": "date-time",
"description": "The UTC date and time to schedule the campaign for delivery in ISO 8601 format. Campaigns may only be scheduled to send on the quarter-hour (:00, :15, :30, :45)."
},
"batch_delivery": {
"type": "object",
"title": "Batch Delivery",
"required": [
"batch_delay",
"batch_count"
],
"properties": {
"batch_count": {
"type": "integer",
"title": "Batch Count",
"description": "The number of batches for the campaign send."
},
"batch_delay": {
"type": "integer",
"title": "Batch Delay",
"description": "The delay, in minutes, between batches."
}
},
"description": "Choose whether the campaign should use [Batch Delivery](https://mailchimp.com/help/schedule-batch-delivery/). Cannot be set to `true` for campaigns using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
}
}
}
CampaignsScheduleDeliveryResponse
{
"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'."
}
CampaignsScheduleDeliverydefaultResponse
{
"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'."
}
CampaignsSendActionResponse
{
"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'."
}
CampaignsSendActiondefaultResponse
{
"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'."
}
CampaignsSendTestEmailRequest
{
"type": "object",
"required": [
"test_emails",
"send_type"
],
"properties": {
"send_type": {
"enum": [
"html",
"plaintext"
],
"type": "string",
"title": "Type of email to test",
"description": "Choose the type of test email to send."
},
"test_emails": {
"type": "array",
"items": {
"type": "string"
},
"title": "Test Emails",
"description": "An array of email addresses to send the test email to."
}
}
}
CampaignsSendTestEmailResponse
{
"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'."
}
CampaignsSendTestEmaildefaultResponse
{
"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'."
}
CampaignsSetContent200Response
{
"type": "object",
"title": "Campaign Content",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"_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."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"archive_html": {
"type": "string",
"title": "Campaign Archive HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>My Subject</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The Archive HTML for the campaign."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>*|MC:SUBJECT|*</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The raw HTML for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"example": "Green header",
"description": "Label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for multivariate campaigns."
}
},
"description": "The HTML and plain-text content for a campaign."
}
CampaignsSetContentRequest
{
"type": "object",
"title": "Campaign Content",
"properties": {
"url": {
"type": "string",
"title": "Campaign URL",
"description": "When importing a campaign, the URL where the HTML lives."
},
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"archive": {
"type": "object",
"title": "Upload Archive",
"required": [
"archive_content"
],
"properties": {
"archive_type": {
"enum": [
"zip",
"tar.gz",
"tar.bz2",
"tar",
"tgz",
"tbz"
],
"type": "string",
"title": "Archive Type",
"description": "The type of encoded file. Defaults to zip."
},
"archive_content": {
"type": "string",
"title": "Archive Content",
"description": "The base64-encoded representation of the archive file."
}
},
"description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/)."
},
"template": {
"type": "object",
"title": "Template Content",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"description": "The id of the template to use."
},
"sections": {
"type": "object",
"title": "Template Sections",
"description": "Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template."
}
},
"description": "Use this template to generate the HTML content of the campaign"
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"required": [
"content_label"
],
"properties": {
"url": {
"type": "string",
"title": "Campaign URL",
"description": "When importing a campaign, the URL for the HTML."
},
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"archive": {
"type": "object",
"title": "Upload Archive",
"required": [
"archive_content"
],
"properties": {
"archive_type": {
"enum": [
"zip",
"tar.gz",
"tar.bz2",
"tar",
"tgz",
"tbz"
],
"type": "string",
"title": "Archive Type",
"description": "The type of encoded file. Defaults to zip."
},
"archive_content": {
"type": "string",
"title": "Archive Content",
"description": "The base64-encoded representation of the archive file."
}
},
"description": "Available when uploading an archive to create campaign content. The archive should include all campaign content and images. [Learn more](https://mailchimp.com/help/import-a-custom-html-template/)."
},
"template": {
"type": "object",
"title": "Template Content",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"description": "The id of the template to use."
},
"sections": {
"type": "object",
"title": "Template Sections",
"description": "Content for the sections of the template. Each key should be the unique [mc:edit area](https://mailchimp.com/help/create-editable-content-areas-with-mailchimps-template-language/) name from the template."
}
},
"description": "Use this template to generate the HTML content for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"description": "The label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for [Multivariate Campaigns](https://mailchimp.com/help/about-multivariate-campaigns/). Each content option must provide HTML content and may optionally provide plain text. For campaigns not testing content, only one object should be provided."
}
},
"description": "The HTML and plain-text content for a campaign"
}
CampaignsSetContentResponse
{
"type": "object",
"title": "Campaign Content",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"description": "The raw HTML for the campaign."
},
"_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."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"archive_html": {
"type": "string",
"title": "Campaign Archive HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>My Subject</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The Archive HTML for the campaign."
},
"variate_contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"html": {
"type": "string",
"title": "Campaign HTML",
"example": "<!DOCTYPE html><html xmlns=http://www.w3.org/1999/xhtml><head><meta http-equiv=Content-Type content=\"text/html; charset=UTF-8\"><title>*|MC:SUBJECT|*</title><style type=text/css>body{background-color:#d0e4fe}</style><body leftmargin=0 marginwidth=0 topmargin=0 marginheight=0 offset=0>",
"description": "The raw HTML for the campaign."
},
"plain_text": {
"type": "string",
"title": "Plain Text",
"description": "The plain-text portion of the campaign. If left unspecified, we'll generate this automatically."
},
"content_label": {
"type": "string",
"title": "Content Label",
"example": "Green header",
"description": "Label used to identify the content option."
}
}
},
"title": "Variate Contents",
"description": "Content options for multivariate campaigns."
}
},
"description": "The HTML and plain-text content for a campaign."
}
CampaignsSetContentdefaultResponse
{
"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'."
}
CampaignsUnscheduleActionResponse
{
"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'."
}
CampaignsUnscheduleActiondefaultResponse
{
"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'."
}
CampaignsUpdateFeedbackMessage200Response
{
"type": "object",
"title": "Campaign Feedback",
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsUpdateFeedbackMessageRequest
{
"type": "object",
"title": "Campaign Feedback",
"properties": {
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsUpdateFeedbackMessageResponse
{
"type": "object",
"title": "Campaign Feedback",
"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."
},
"source": {
"enum": [
"api",
"email",
"sms",
"web",
"ios",
"android"
],
"type": "string",
"title": "Source",
"readOnly": true,
"description": "The source of the feedback."
},
"message": {
"type": "string",
"title": "Message",
"description": "The content of the feedback."
},
"block_id": {
"type": "integer",
"title": "Block ID",
"description": "The block id for the editable block that the feedback addresses."
},
"parent_id": {
"type": "integer",
"title": "Parent ID",
"readOnly": true,
"description": "If a reply, the id of the parent feedback item."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback item was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name of the user who created the feedback."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"readOnly": true,
"description": "The date and time the feedback was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"feedback_id": {
"type": "integer",
"title": "Feedback ID",
"readOnly": true,
"description": "The individual id for the feedback item."
},
"is_complete": {
"type": "boolean",
"title": "Complete",
"description": "The status of feedback."
}
},
"description": "A specific feedback message from a specific campaign."
}
CampaignsUpdateFeedbackMessagedefaultResponse
{
"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'."
}
CampaignsUpdateSettings200Response
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsUpdateSettingsRequest
{
"type": "object",
"title": "Campaign",
"required": [
"settings"
],
"properties": {
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"required": [
"subject_line",
"from_name",
"reply_to"
],
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"description": "The id of the template to use."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
}
},
"description": "List settings for the campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
}
},
"description": "The settings specific to A/B test campaigns."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsUpdateSettingsResponse
{
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
CampaignsUpdateSettingsdefaultResponse
{
"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'."
}
ConnectedSitesCreateNewMailchimpSite200Response
{
"type": "object",
"title": "Connected Site",
"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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesCreateNewMailchimpSiteRequest
{
"type": "object",
"title": "Connected Site",
"required": [
"foreign_id",
"domain"
],
"properties": {
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The connected site domain."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "MC001",
"description": "The unique identifier for the site."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesCreateNewMailchimpSiteResponse
{
"type": "object",
"title": "Connected Site",
"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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesCreateNewMailchimpSitedefaultResponse
{
"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'."
}
ConnectedSitesGetInfo200Response
{
"type": "object",
"title": "Connected Site",
"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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesGetInfoResponse
{
"type": "object",
"title": "Connected Site",
"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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
}
ConnectedSitesGetInfodefaultResponse
{
"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'."
}
ConnectedSitesListAll200Response
{
"type": "object",
"title": "Connected Sites",
"properties": {
"sites": {
"type": "array",
"items": {
"type": "object",
"title": "Connected Site",
"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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
},
"title": "Connected Sites",
"description": "An array of objects, each representing a connected site."
},
"_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."
}
},
"description": "A collection of connected sites in the account."
}
ConnectedSitesListAllResponse
{
"type": "object",
"title": "Connected Sites",
"properties": {
"sites": {
"type": "array",
"items": {
"type": "object",
"title": "Connected Site",
"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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.myshopify.com",
"readOnly": true,
"description": "The connected site domain."
},
"platform": {
"type": "string",
"title": "Connected Site Platform",
"example": "shopify, magento, bigcommerce, woocommerce",
"readOnly": true,
"description": "The platform of the connected site."
},
"store_id": {
"type": "string",
"title": "Store ID",
"example": "MC001",
"readOnly": true,
"description": "The unique identifier for the ecommerce store that's associated with the connected site (if any). The store_id for a specific connected site can't change."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was created in ISO 8601 format."
},
"foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the site."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:35:00+00:00",
"readOnly": true,
"description": "The date and time the connected site was last updated in ISO 8601 format."
},
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
}
},
"description": "Information about a specific connected site."
},
"title": "Connected Sites",
"description": "An array of objects, each representing a connected site."
},
"_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."
}
},
"description": "A collection of connected sites in the account."
}
ConnectedSitesListAlldefaultResponse
{
"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'."
}
ConnectedSitesRemoveSiteResponse
{
"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'."
}
ConnectedSitesRemoveSitedefaultResponse
{
"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'."
}
ConnectedSitesVerifyScriptInstallationResponse
{
"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'."
}
ConnectedSitesVerifyScriptInstallationdefaultResponse
{
"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'."
}
ConversationsGetAllConversations200Response
{
"type": "object",
"title": "Tracked Conversations",
"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."
},
"conversations": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversations",
"description": "A list of conversations."
}
},
"description": "A collection of this account's tracked conversations."
}
ConversationsGetAllConversationsResponse
{
"type": "object",
"title": "Tracked Conversations",
"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."
},
"conversations": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversations",
"description": "A list of conversations."
}
},
"description": "A collection of this account's tracked conversations."
}
ConversationsGetAllConversationsdefaultResponse
{
"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'."
}
ConversationsGetById200Response
{
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}
ConversationsGetByIdResponse
{
"type": "object",
"title": "Conversation",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this conversation."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique identifier of the list for this conversation."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of the message."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique identifier of the campaign for this conversation."
},
"last_message": {
"type": "object",
"title": "Last Message",
"properties": {
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read."
},
"message": {
"type": "string",
"title": "Message",
"readOnly": true,
"description": "The plain-text content of the message."
},
"subject": {
"type": "string",
"title": "Subject",
"readOnly": true,
"description": "The subject of this message."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"readOnly": true,
"description": "A label representing the email of the sender of this message."
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message."
}
},
"description": "The most recent message in the conversation."
},
"message_count": {
"type": "integer",
"title": "Message Count",
"readOnly": true,
"description": "The total number of messages in this conversation."
},
"unread_messages": {
"type": "integer",
"title": "Unread Messages",
"readOnly": true,
"description": "The number of unread messages in this conversation."
}
},
"description": "Details about an individual conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}
ConversationsGetByIddefaultResponse
{
"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'."
}
ConversationsGetMessageById200Response
{
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_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."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}
ConversationsGetMessageByIdResponse
{
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_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."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
}
ConversationsGetMessageByIddefaultResponse
{
"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'."
}
ConversationsListMessagesFromConversation200Response
{
"type": "object",
"title": "Collection of Conversation Messages",
"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."
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"description": "A string that identifies this conversation."
},
"conversation_messages": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_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."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversation Messages",
"description": "An array of objects, each representing a conversation messages resources."
}
},
"description": "Messages from a specific conversation."
}
ConversationsListMessagesFromConversationResponse
{
"type": "object",
"title": "Collection of Conversation Messages",
"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."
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"description": "A string that identifies this conversation."
},
"conversation_messages": {
"type": "array",
"items": {
"type": "object",
"title": "Conversation Message",
"properties": {
"id": {
"type": "string",
"title": "ID",
"readOnly": true,
"description": "A string that uniquely identifies this message"
},
"read": {
"type": "boolean",
"title": "Read",
"description": "Whether this message has been marked as read"
},
"_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."
},
"list_id": {
"type": "integer",
"title": "List ID",
"readOnly": true,
"description": "The list's web ID"
},
"message": {
"type": "string",
"title": "Message",
"description": "The plain-text content of the message"
},
"subject": {
"type": "string",
"title": "Subject",
"description": "The subject of this message"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the message was either sent or received in ISO 8601 format."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "A label representing the email of the sender of this message"
},
"from_label": {
"type": "string",
"title": "From Label",
"readOnly": true,
"description": "A label representing the sender of this message"
},
"conversation_id": {
"type": "string",
"title": "Conversation ID",
"readOnly": true,
"description": "A string that identifies this message's conversation"
}
},
"description": "An individual message in a conversation. Conversation tracking is a feature available to paid accounts that lets you view replies to your campaigns in your Mailchimp account."
},
"title": "Conversation Messages",
"description": "An array of objects, each representing a conversation messages resources."
}
},
"description": "Messages from a specific conversation."
}
ConversationsListMessagesFromConversationdefaultResponse
{
"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'."
}
CustomerJourneysTriggerStepAction204Response
{
"description": "Empty Response"
}
CustomerJourneysTriggerStepActionRequest
{
"type": "object",
"title": "Subscriber in Customer Journey's audience",
"required": [
"email_address"
],
"properties": {
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The list member's email address."
}
},
"description": "Information about subscribers in a Customer Journey's audience."
}
CustomerJourneysTriggerStepActionResponse
{
"type": "object",
"example": {},
"properties": {}
}
CustomerJourneysTriggerStepActiondefaultResponse
{
"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'."
}
EcommerceAddCartLineItem200Response
{
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceAddCartLineItemRequest
{
"type": "object",
"title": "E-commerce Cart Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceAddCartLineItemResponse
{
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceAddCartLineItemdefaultResponse
{
"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'."
}
EcommerceAddCartToStore200Response
{
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceAddCartToStoreRequest
{
"type": "object",
"title": "E-commerce Cart",
"required": [
"id",
"currency_code",
"customer",
"order_total",
"lines"
],
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign for a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceAddCartToStoreResponse
{
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceAddCartToStoredefaultResponse
{
"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'."
}
EcommerceAddCustomerToStore200Response
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceAddCustomerToStoreRequest
{
"type": "object",
"title": "E-commerce Customer",
"required": [
"id",
"email_address",
"opt_in_status"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceAddCustomerToStoreResponse
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceAddCustomerToStoredefaultResponse
{
"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'."
}
EcommerceAddOrUpdateCustomer200Response
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceAddOrUpdateCustomerRequest
{
"type": "object",
"title": "E-commerce Customer",
"required": [
"id",
"email_address",
"opt_in_status"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body."
}
EcommerceAddOrUpdateCustomerResponse
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceAddOrUpdateCustomerdefaultResponse
{
"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'."
}
EcommerceAddOrUpdateProductVariant200Response
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceAddOrUpdateProductVariantResponse
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceAddOrUpdateProductVariantdefaultResponse
{
"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'."
}
EcommerceAddOrderLineItem200Response
{
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceAddOrderLineItemRequest
{
"type": "object",
"title": "E-commerce Order Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"description": "A unique identifier for the order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of an order line item."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to this line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of an order line item."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with the order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceAddOrderLineItemResponse
{
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceAddOrderLineItemdefaultResponse
{
"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'."
}
EcommerceAddOrderToStore200Response
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceAddOrderToStoreRequest
{
"type": "object",
"title": "E-commerce Order",
"required": [
"id",
"customer",
"currency_code",
"order_total",
"lines"
],
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"required": [
"id",
"product_id",
"product_variant_id",
"quantity",
"price"
],
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"description": "A unique identifier for the order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of an order line item."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to this line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of an order line item."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with the order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"type",
"amount_discounted"
],
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"maxLength": 50,
"description": "A unique identifier for the customer. Limited to 50 characters."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer. For existing customers include only the `id` parameter in the `customer` object body."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total for the order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign for an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The total for the order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with the billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the shipping address."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being created."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceAddOrderToStoreResponse
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceAddOrderToStoredefaultResponse
{
"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'."
}
EcommerceAddProductImage200Response
{
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceAddProductImageRequest
{
"type": "object",
"title": "E-commerce Product Image",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceAddProductImageResponse
{
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceAddProductImagedefaultResponse
{
"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'."
}
EcommerceAddProductToStore200Response
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceAddProductToStoreRequest
{
"type": "object",
"title": "E-commerce Product",
"required": [
"id",
"title",
"variants"
],
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"required": [
"id",
"title"
],
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published."
}
},
"description": "Information about a specific product."
}
EcommerceAddProductToStoreResponse
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceAddProductToStoredefaultResponse
{
"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'."
}
EcommerceAddProductVariant200Response
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceAddProductVariantRequest
{
"type": "object",
"title": "E-commerce Product Variant",
"required": [
"id",
"title"
],
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceAddProductVariantResponse
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceAddProductVariantdefaultResponse
{
"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'."
}
EcommerceAddPromoCode200Response
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
}
EcommerceAddPromoCodeRequest
{
"type": "object",
"title": "E-commerce Promo Code",
"required": [
"id",
"code",
"redemption_url"
],
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"description": "A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code."
}
EcommerceAddPromoCodeResponse
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
}
EcommerceAddPromoCodedefaultResponse
{
"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'."
}
EcommerceAddPromoRule200Response
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceAddPromoRuleRequest
{
"type": "object",
"title": "E-commerce Promo Rule",
"required": [
"id",
"description",
"amount",
"type",
"target"
],
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule."
}
EcommerceAddPromoRuleResponse
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceAddPromoRuledefaultResponse
{
"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'."
}
EcommerceAddStoreToMailchimpAccount200Response
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceAddStoreToMailchimpAccountRequest
{
"type": "object",
"title": "E-commerce Store",
"required": [
"id",
"list_id",
"name",
"currency_code"
],
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. This parameter is required for Connected Sites and Google Ads."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"description": "The unique identifier for the list associated with the store. The `list_id` for a specific store cannot change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceAddStoreToMailchimpAccountResponse
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceAddStoreToMailchimpAccountdefaultResponse
{
"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'."
}
EcommerceDeleteCartLineItemResponse
{
"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'."
}
EcommerceDeleteCartLineItemdefaultResponse
{
"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'."
}
EcommerceDeleteOrderLineResponse
{
"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'."
}
EcommerceDeleteOrderLinedefaultResponse
{
"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'."
}
EcommerceDeleteOrderResponse
{
"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'."
}
EcommerceDeleteOrderdefaultResponse
{
"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'."
}
EcommerceDeleteProductImageResponse
{
"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'."
}
EcommerceDeleteProductImagedefaultResponse
{
"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'."
}
EcommerceDeleteProductResponse
{
"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'."
}
EcommerceDeleteProductVariantResponse
{
"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'."
}
EcommerceDeleteProductVariantdefaultResponse
{
"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'."
}
EcommerceDeleteProductdefaultResponse
{
"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'."
}
EcommerceDeletePromoCodeResponse
{
"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'."
}
EcommerceDeletePromoCodedefaultResponse
{
"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'."
}
EcommerceDeletePromoRuleResponse
{
"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'."
}
EcommerceDeletePromoRuledefaultResponse
{
"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'."
}
EcommerceDeleteStore204Response
{
"description": "Empty Response"
}
EcommerceDeleteStoreResponse
{
"type": "object",
"example": {},
"properties": {}
}
EcommerceDeleteStoredefaultResponse
{
"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'."
}
EcommerceGetCartInfo200Response
{
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceGetCartInfoResponse
{
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceGetCartInfodefaultResponse
{
"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'."
}
EcommerceGetCartLineItem200Response
{
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceGetCartLineItemResponse
{
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceGetCartLineItemdefaultResponse
{
"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'."
}
EcommerceGetCustomerInfo200Response
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceGetCustomerInfoResponse
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceGetCustomerInfodefaultResponse
{
"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'."
}
EcommerceGetOrderLineItem200Response
{
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceGetOrderLineItemResponse
{
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceGetOrderLineItemdefaultResponse
{
"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'."
}
EcommerceGetProductImageInfo200Response
{
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceGetProductImageInfoResponse
{
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceGetProductImageInfodefaultResponse
{
"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'."
}
EcommerceGetProductImages200Response
{
"type": "object",
"title": "Ecommerce Product Images",
"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."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Ecommerce Product Images",
"description": "An array of objects, each representing a product image resource."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"product_id": {
"type": "string",
"title": "Product ID",
"description": "The product id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a product's images."
}
EcommerceGetProductImagesResponse
{
"type": "object",
"title": "Ecommerce Product Images",
"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."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Ecommerce Product Images",
"description": "An array of objects, each representing a product image resource."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"product_id": {
"type": "string",
"title": "Product ID",
"description": "The product id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a product's images."
}
EcommerceGetProductImagesdefaultResponse
{
"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'."
}
EcommerceGetProductVariantInfo200Response
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceGetProductVariantInfoResponse
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceGetProductVariantInfodefaultResponse
{
"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'."
}
EcommerceGetPromoCode200Response
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
}
EcommerceGetPromoCodeResponse
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
}
EcommerceGetPromoCodedefaultResponse
{
"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'."
}
EcommerceGetStoreCarts200Response
{
"type": "object",
"title": "Carts",
"properties": {
"carts": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
},
"title": "E-commerce Store Carts",
"description": "An array of objects, each representing a cart."
},
"_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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's carts."
}
EcommerceGetStoreCartsResponse
{
"type": "object",
"title": "Carts",
"properties": {
"carts": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
},
"title": "E-commerce Store Carts",
"description": "An array of objects, each representing a cart."
},
"_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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's carts."
}
EcommerceGetStoreCartsdefaultResponse
{
"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'."
}
EcommerceGetStoreCustomers200Response
{
"type": "object",
"title": "Customers",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"customers": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"title": "Customers",
"description": "An array of objects, each representing a customer of a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's customers."
}
EcommerceGetStoreCustomersResponse
{
"type": "object",
"title": "Customers",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"customers": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"title": "Customers",
"description": "An array of objects, each representing a customer of a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's customers."
}
EcommerceGetStoreCustomersdefaultResponse
{
"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'."
}
EcommerceGetStoreInfo200Response
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceGetStoreInfoResponse
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceGetStoreInfodefaultResponse
{
"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'."
}
EcommerceGetStoreOrderInfo200Response
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceGetStoreOrderInfoResponse
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceGetStoreOrderInfodefaultResponse
{
"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'."
}
EcommerceGetStoreOrderLines200Response
{
"type": "object",
"title": "Order Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Ecommerce Order Lines",
"description": "An array of objects, each representing an order's line item."
},
"_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."
},
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The order id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of an order's line items."
}
EcommerceGetStoreOrderLinesResponse
{
"type": "object",
"title": "Order Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Ecommerce Order Lines",
"description": "An array of objects, each representing an order's line item."
},
"_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."
},
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The order id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of an order's line items."
}
EcommerceGetStoreOrderLinesdefaultResponse
{
"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'."
}
EcommerceGetStoreProductInfo200Response
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceGetStoreProductInfoResponse
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceGetStoreProductInfodefaultResponse
{
"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'."
}
EcommerceGetStoreProducts200Response
{
"type": "object",
"title": "Products",
"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."
},
"products": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
},
"title": "Products",
"description": "An array of objects, each representing a store product."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's products."
}
EcommerceGetStoreProductsResponse
{
"type": "object",
"title": "Products",
"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."
},
"products": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
},
"title": "Products",
"description": "An array of objects, each representing a store product."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a store's products."
}
EcommerceGetStoreProductsdefaultResponse
{
"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'."
}
EcommerceGetStorePromoCodes200Response
{
"type": "object",
"title": "Promo Codes",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_codes": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
},
"title": "Promo Codes",
"description": "An array of objects, each representing promo codes defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo codes."
}
EcommerceGetStorePromoCodesResponse
{
"type": "object",
"title": "Promo Codes",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_codes": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
},
"title": "Promo Codes",
"description": "An array of objects, each representing promo codes defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo codes."
}
EcommerceGetStorePromoCodesdefaultResponse
{
"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'."
}
EcommerceGetStorePromoRule200Response
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceGetStorePromoRuleResponse
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceGetStorePromoRuledefaultResponse
{
"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'."
}
EcommerceGetStorePromoRules200Response
{
"type": "object",
"title": "Promo Rules",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_rules": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
},
"title": "Promo Rules",
"description": "An array of objects, each representing promo rules defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo rules."
}
EcommerceGetStorePromoRulesResponse
{
"type": "object",
"title": "Promo Rules",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"promo_rules": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
},
"title": "Promo Rules",
"description": "An array of objects, each representing promo rules defined for a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of the store's promo rules."
}
EcommerceGetStorePromoRulesdefaultResponse
{
"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'."
}
EcommerceListAccountOrders200Response
{
"type": "object",
"title": "Orders",
"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."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order resource."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in an account."
}
EcommerceListAccountOrdersResponse
{
"type": "object",
"title": "Orders",
"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."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order resource."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in an account."
}
EcommerceListAccountOrdersdefaultResponse
{
"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'."
}
EcommerceListCartLines200Response
{
"type": "object",
"title": "Cart Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Ecommerce Cart Lines",
"description": "An array of objects, each representing a cart's line item."
},
"_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."
},
"cart_id": {
"type": "string",
"title": "Cart ID",
"description": "The cart id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a cart's line items."
}
EcommerceListCartLinesResponse
{
"type": "object",
"title": "Cart Lines",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Ecommerce Cart Lines",
"description": "An array of objects, each representing a cart's line item."
},
"_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."
},
"cart_id": {
"type": "string",
"title": "Cart ID",
"description": "The cart id."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a cart's line items."
}
EcommerceListCartLinesdefaultResponse
{
"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'."
}
EcommerceListProductVariants200Response
{
"type": "object",
"title": "Ecommerce Product Variants",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Ecommerce Product Variants",
"description": "An array of objects, each representing a product's variants."
},
"product_id": {
"type": "string",
"title": "Product ID",
"description": "The product id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a product's variants."
}
EcommerceListProductVariantsResponse
{
"type": "object",
"title": "Ecommerce Product Variants",
"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."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The store id."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Ecommerce Product Variants",
"description": "An array of objects, each representing a product's variants."
},
"product_id": {
"type": "string",
"title": "Product ID",
"description": "The product id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of a product's variants."
}
EcommerceListProductVariantsdefaultResponse
{
"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'."
}
EcommerceListStoreOrders200Response
{
"type": "object",
"title": "Orders",
"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."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order in a store."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The unique identifier for the store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in a store."
}
EcommerceListStoreOrdersResponse
{
"type": "object",
"title": "Orders",
"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."
},
"orders": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
},
"title": "Orders",
"description": "An array of objects, each representing an order in a store."
},
"store_id": {
"type": "string",
"title": "Store ID",
"description": "The unique identifier for the store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of orders in a store."
}
EcommerceListStoreOrdersdefaultResponse
{
"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'."
}
EcommerceListStores200Response
{
"type": "object",
"title": "E-commerce Stores",
"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."
},
"stores": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
},
"title": "Stores",
"description": "An array of objects, each representing a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of stores in the account."
}
EcommerceListStoresResponse
{
"type": "object",
"title": "E-commerce Stores",
"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."
},
"stores": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
},
"title": "Stores",
"description": "An array of objects, each representing a store."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of stores in the account."
}
EcommerceListStoresdefaultResponse
{
"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'."
}
EcommerceRemoveCartResponse
{
"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'."
}
EcommerceRemoveCartdefaultResponse
{
"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'."
}
EcommerceRemoveCustomerResponse
{
"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'."
}
EcommerceRemoveCustomerdefaultResponse
{
"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'."
}
EcommerceUpdateCartById200Response
{
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceUpdateCartByIdRequest
{
"type": "object",
"title": "E-commerce Cart",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceUpdateCartByIdResponse
{
"type": "object",
"title": "E-commerce Cart",
"properties": {
"id": {
"type": "string",
"title": "Cart Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
},
"title": "Cart Line Items",
"description": "An array of the cart's line items."
},
"_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."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The total tax for the cart."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the cart was last updated in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with a cart."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total for the cart."
},
"checkout_url": {
"type": "string",
"title": "Checkout URL",
"description": "The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the cart uses."
}
},
"description": "Information about a specific cart."
}
EcommerceUpdateCartByIddefaultResponse
{
"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'."
}
EcommerceUpdateCartLineItem200Response
{
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceUpdateCartLineItemRequest
{
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceUpdateCartLineItemResponse
{
"type": "object",
"title": "E-commerce Cart Line Item",
"properties": {
"id": {
"type": "string",
"title": "Cart Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for the cart line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a cart line item."
},
"_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."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of a cart line item."
},
"product_id": {
"type": "string",
"title": "Cart Line Product Foreign ID",
"description": "A unique identifier for the product associated with the cart line item."
},
"product_title": {
"type": "string",
"title": "Cart Line Product Title",
"readOnly": true,
"description": "The name of the product for the cart line item."
},
"product_variant_id": {
"type": "string",
"title": "Cart Line Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the cart line item."
},
"product_variant_title": {
"type": "string",
"title": "Cart Line Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for the cart line item."
}
},
"description": "Information about a specific cart line item."
}
EcommerceUpdateCartLineItemdefaultResponse
{
"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'."
}
EcommerceUpdateCustomer200Response
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceUpdateCustomerRequest
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body."
}
EcommerceUpdateCustomerResponse
{
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
}
EcommerceUpdateCustomerdefaultResponse
{
"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'."
}
EcommerceUpdateOrderLine200Response
{
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceUpdateOrderLineRequest
{
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"price": {
"type": "number",
"title": "Price",
"description": "The price of an order line item."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to this line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of an order line item."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with the order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceUpdateOrderLineResponse
{
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
}
EcommerceUpdateOrderLinedefaultResponse
{
"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'."
}
EcommerceUpdateProduct200Response
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceUpdateProductImage200Response
{
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceUpdateProductImageRequest
{
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceUpdateProductImageResponse
{
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
}
EcommerceUpdateProductImagedefaultResponse
{
"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'."
}
EcommerceUpdateProductRequest
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product image."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceUpdateProductResponse
{
"type": "object",
"title": "E-commerce Product",
"properties": {
"id": {
"type": "string",
"title": "Product Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product."
},
"url": {
"type": "string",
"title": "Product URL",
"description": "The URL for a product."
},
"type": {
"type": "string",
"title": "Type",
"example": "Accessories",
"description": "The type of product."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product."
},
"_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."
},
"handle": {
"type": "string",
"title": "Handle",
"example": "cat-hat",
"description": "The handle of a product."
},
"images": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Image",
"properties": {
"id": {
"type": "string",
"title": "Image Foreign ID",
"description": "A unique identifier for the product image."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product 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."
},
"variant_ids": {
"type": "array",
"items": {
"type": "string"
},
"title": "Product Variants",
"description": "The list of product variants using the image."
}
},
"description": "Information about a specific product image."
},
"title": "Product Images",
"description": "An array of the product's images."
},
"vendor": {
"type": "string",
"title": "Vendor",
"description": "The vendor for a product."
},
"variants": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
},
"title": "Product Variants",
"description": "Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/)."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"description": "The image URL for a product."
},
"description": {
"type": "string",
"title": "Description",
"example": "This is a cat hat.",
"description": "The description of a product."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"readOnly": true,
"description": "The currency code"
},
"published_at_foreign": {
"type": "string",
"title": "Foreign Publish Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the product was published in ISO 8601 format."
}
},
"description": "Information about a specific product."
}
EcommerceUpdateProductVariant200Response
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceUpdateProductVariantRequest
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceUpdateProductVariantResponse
{
"type": "object",
"title": "E-commerce Product Variant",
"properties": {
"id": {
"type": "string",
"title": "Product Variant Foreign ID",
"readOnly": true,
"description": "A unique identifier for the product variant."
},
"sku": {
"type": "string",
"title": "SKU",
"description": "The stock keeping unit (SKU) of a product variant."
},
"url": {
"type": "string",
"title": "URL",
"description": "The URL for a product variant."
},
"price": {
"type": "number",
"title": "Price",
"description": "The price of a product variant."
},
"title": {
"type": "string",
"title": "Title",
"example": "Cat Hat",
"description": "The title of a product variant."
},
"_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."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The image URL for a product variant."
},
"backorders": {
"type": "string",
"title": "Backorders",
"description": "The backorders of a product variant."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the product was last updated in ISO 8601 format."
},
"visibility": {
"type": "string",
"title": "Visibility",
"description": "The visibility of a product variant."
},
"inventory_quantity": {
"type": "integer",
"title": "Inventory Quantity",
"description": "The inventory quantity of a product variant."
}
},
"description": "Information about a specific product variant."
}
EcommerceUpdateProductVariantdefaultResponse
{
"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'."
}
EcommerceUpdateProductdefaultResponse
{
"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'."
}
EcommerceUpdatePromoCode200Response
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
}
EcommerceUpdatePromoCodeRequest
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code."
}
EcommerceUpdatePromoCodeResponse
{
"type": "object",
"title": "E-commerce Promo Code",
"properties": {
"id": {
"type": "string",
"title": "Promo Code Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo Code."
},
"code": {
"type": "string",
"title": "Promo Code",
"example": "summersale",
"description": "The discount code. Restricted to UTF-8 characters with max length 50."
},
"_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."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo code is currently enabled."
},
"usage_count": {
"type": "integer",
"title": "Promo Code Usage Count",
"description": "Number of times promo code has been used."
},
"redemption_url": {
"type": "string",
"title": "Redemption Url",
"example": "A url that applies promo code directly at checkout or a url that points to sale page or store url",
"description": "The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Code"
}
EcommerceUpdatePromoCodedefaultResponse
{
"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'."
}
EcommerceUpdatePromoRule200Response
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceUpdatePromoRuleRequest
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule."
}
EcommerceUpdatePromoRuleResponse
{
"type": "object",
"title": "E-commerce Promo Rule",
"properties": {
"id": {
"type": "string",
"title": "Promo Rule Foreign ID",
"readOnly": true,
"description": "A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50."
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed."
},
"title": {
"type": "string",
"title": "Title",
"example": "50% off Total Order",
"description": "The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes."
},
"_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."
},
"amount": {
"type": "number",
"title": "Amount",
"format": "float",
"example": 0.5,
"description": "The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive."
},
"target": {
"enum": [
"per_item",
"total",
"shipping"
],
"type": "string",
"title": "Target",
"description": "The target that the discount applies to."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"example": true,
"description": "Whether the promo rule is currently enabled."
},
"ends_at": {
"type": "string",
"title": "End Time",
"format": "Promo date-time",
"description": "The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format."
},
"starts_at": {
"type": "string",
"title": "Promo Start Time",
"format": "date-time",
"description": "The date and time when the promotion is in effect in ISO 8601 format."
},
"description": {
"type": "string",
"title": "Description",
"example": "Save BIG during our summer sale!",
"description": "The description of a promotion restricted to UTF-8 characters with max length 255."
},
"created_at_foreign": {
"type": "string",
"title": "Foreign Create Time",
"format": "date-time",
"description": "The date and time the promotion was created in ISO 8601 format."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"description": "The date and time the promotion was updated in ISO 8601 format."
}
},
"description": "Information about an Ecommerce Store's specific Promo Rule"
}
EcommerceUpdatePromoRuledefaultResponse
{
"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'."
}
EcommerceUpdateSpecificOrder200Response
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceUpdateSpecificOrderRequest
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"price": {
"type": "number",
"title": "Price",
"description": "The price of an order line item."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to this line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of an order line item."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with the order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with the order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"type",
"amount_discounted"
],
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order. Note: Patch will completely replace the value of promos with the new one provided."
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format. Note: passing a value for this parameter will cancel the order being edited."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceUpdateSpecificOrderResponse
{
"type": "object",
"title": "E-commerce Order",
"properties": {
"id": {
"type": "string",
"title": "Order Foreign ID",
"readOnly": true,
"description": "A unique identifier for the order."
},
"lines": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Line Items",
"description": "An array of the order's line items."
},
"_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."
},
"promos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Code",
"description": "The Promo Code"
},
"type": {
"enum": [
"fixed",
"percentage"
],
"type": "string",
"title": "Type",
"description": "Type of discount. For free shipping set type to fixed"
},
"amount_discounted": {
"type": "number",
"title": "Amount Discounted",
"description": "The amount of discount applied on the total price. For example if the total cost was $100 and the customer paid $95.5, amount_discounted will be 4.5 For free shipping set amount_discounted to 0"
}
}
},
"title": "Promos",
"description": "The promo codes applied on the order"
},
"customer": {
"type": "object",
"title": "E-commerce Customer",
"properties": {
"id": {
"type": "string",
"title": "Customer Foreign ID",
"readOnly": true,
"description": "A unique identifier for the customer."
},
"_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."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the customer is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The customer's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The mailing address of the customer."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the customer's mailing address."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The customer's state name or normalized province."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The customer's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the customer's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the customer's province or state."
}
},
"description": "The customer's address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The customer's company."
},
"last_name": {
"type": "string",
"title": "Last Name",
"description": "The customer's last name."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was created in ISO 8601 format."
},
"first_name": {
"type": "string",
"title": "First Name",
"description": "The customer's first name."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the customer was last updated in ISO 8601 format."
},
"total_spent": {
"type": "number",
"title": "Total Spent",
"example": 100,
"readOnly": true,
"description": "The total amount the customer has spent."
},
"orders_count": {
"type": "integer",
"title": "Orders Count",
"example": 4,
"readOnly": true,
"description": "The customer's total order count."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "The customer's email address."
},
"opt_in_status": {
"type": "boolean",
"title": "Opt-in Status",
"description": "The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers)."
}
},
"description": "Information about a specific customer."
},
"outreach": {
"type": "object",
"title": "Outreach",
"properties": {
"id": {
"type": "string",
"title": "Outreach ID",
"example": "839488a60b",
"description": "A unique identifier for the outreach. Can be an email campaign ID."
},
"name": {
"type": "string",
"title": "Outreach name",
"example": "Freddie's Jokes",
"readOnly": true,
"description": "The name for the outreach."
},
"type": {
"type": "string",
"title": "Outreach type",
"example": "regular",
"readOnly": true,
"description": "The type of the outreach."
},
"published_time": {
"type": "string",
"title": "Outreach published time",
"format": "date-time",
"example": "2017-06-06T13:56:12+00:00",
"readOnly": true,
"description": "The date and time the Outreach was published in ISO 8601 format."
}
},
"description": "The outreach associated with this order. For example, an email campaign or Facebook ad."
},
"store_id": {
"type": "string",
"title": "Store Foreign ID",
"readOnly": true,
"description": "The unique identifier for the store."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The URL for the order."
},
"tax_total": {
"type": "number",
"title": "Tax Total",
"description": "The tax total associated with an order."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"example": "839488a60b",
"description": "A string that uniquely identifies the campaign associated with an order."
},
"order_total": {
"type": "number",
"title": "Order Total",
"description": "The order total associated with an order."
},
"landing_site": {
"type": "string",
"title": "Landing Site",
"example": "http://www.example.com?source=abc",
"description": "The URL for the page where the buyer landed when entering the shop."
},
"tracking_url": {
"type": "string",
"title": "Tracking URL",
"description": "The tracking URL associated with the order."
},
"currency_code": {
"type": "string",
"title": "Currency Code",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"tracking_code": {
"enum": [
"prec"
],
"type": "string",
"title": "Tracking Code",
"description": "The Mailchimp tracking code for the order. Uses the 'mc_tc' parameter in E-Commerce tracking URLs."
},
"discount_total": {
"type": "number",
"title": "Discount Total",
"description": "The total amount of the discounts to be applied to the price of the order."
},
"shipping_total": {
"type": "number",
"title": "Shipping Total",
"description": "The shipping total for the order."
},
"billing_address": {
"type": "object",
"title": "Billing Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the billing address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's billing address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the billing address."
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with the billing address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the billing address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The billing address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the billing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the billing address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the billing address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the billing address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the billing address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the billing address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state in the billing address."
}
},
"description": "The billing address for the order."
},
"tracking_number": {
"type": "string",
"title": "Tracking number",
"description": "The tracking number associated with the order."
},
"financial_status": {
"type": "string",
"title": "Financial Status",
"description": "The order status. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"shipping_address": {
"type": "object",
"title": "Shipping Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city in the order's shipping address."
},
"name": {
"type": "string",
"title": "Name",
"example": "Freddie Chimpenheimer",
"description": "The name associated with an order's shipping address."
},
"phone": {
"type": "string",
"title": "Phone Number",
"example": "8675309",
"description": "The phone number for the order's shipping address"
},
"company": {
"type": "string",
"title": "Company",
"description": "The company associated with an order's shipping address."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The country in the order's shipping address."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The shipping address for the order."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the shipping address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude for the shipping address location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The state or normalized province in the order's shipping address."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude for the shipping address location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The postal or zip code in the order's shipping address."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for the country in the shipping address."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the province or state the order's shipping address is located in."
}
},
"description": "The shipping address for the order."
},
"tracking_carrier": {
"type": "string",
"title": "Tracking carrier",
"description": "The tracking carrier associated with the order."
},
"fulfillment_status": {
"type": "string",
"title": "Fulfillment Status",
"description": "The fulfillment status for the order. Use this parameter to trigger [Order Notifications](https://mailchimp.com/developer/marketing/docs/e-commerce/#order-notifications)."
},
"updated_at_foreign": {
"type": "string",
"title": "Foreign Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was updated in ISO 8601 format."
},
"cancelled_at_foreign": {
"type": "string",
"title": "Foreign Cancel Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was cancelled in ISO 8601 format."
},
"processed_at_foreign": {
"type": "string",
"title": "Foreign Processed Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"description": "The date and time the order was processed in ISO 8601 format."
}
},
"description": "Information about a specific order."
}
EcommerceUpdateSpecificOrderdefaultResponse
{
"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'."
}
EcommerceUpdateStore200Response
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceUpdateStoreRequest
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceUpdateStoreResponse
{
"type": "object",
"title": "E-commerce Store",
"properties": {
"id": {
"type": "string",
"title": "Store Foreign ID",
"example": "example_store",
"readOnly": true,
"description": "The unique identifier for the store."
},
"name": {
"type": "string",
"title": "Store Name",
"example": "Freddie's Cat Hat Emporium",
"description": "The name of the store."
},
"phone": {
"type": "string",
"title": "Phone",
"example": "404-444-4444",
"description": "The store phone number."
},
"_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."
},
"domain": {
"type": "string",
"title": "Domain",
"example": "example.com",
"description": "The store domain. The store domain must be unique within a user account."
},
"address": {
"type": "object",
"title": "Address",
"properties": {
"city": {
"type": "string",
"title": "City ",
"example": "Atlanta",
"description": "The city the store is located in."
},
"country": {
"type": "string",
"title": "Country Code",
"example": "United States",
"description": "The store's country."
},
"address1": {
"type": "string",
"title": "Address Field 1",
"example": "675 Ponce de Leon Ave NE",
"description": "The store's mailing address."
},
"address2": {
"type": "string",
"title": "Address Field 2",
"example": "Suite 5000",
"description": "An additional field for the store's mailing address."
},
"latitude": {
"type": "number",
"title": "Latitude",
"example": 45.427408,
"description": "The latitude of the store location."
},
"province": {
"type": "string",
"title": "Province",
"example": "Georgia",
"description": "The store's state name or normalized province."
},
"longitude": {
"type": "number",
"title": "Longitude",
"example": -75.68903,
"description": "The longitude of the store location."
},
"postal_code": {
"type": "string",
"title": "Postal Code",
"example": "30308",
"description": "The store's postal or zip code."
},
"country_code": {
"type": "string",
"title": "Country Code",
"example": "US",
"description": "The two-letter code for to the store's country."
},
"province_code": {
"type": "string",
"title": "Province Code",
"example": "GA",
"description": "The two-letter code for the store's province or state."
}
},
"description": "The store address."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "1a2df69511",
"readOnly": true,
"description": "The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change."
},
"platform": {
"type": "string",
"title": "Platform",
"description": "The e-commerce platform of the store."
},
"timezone": {
"type": "string",
"title": "Timezone",
"example": "Eastern",
"description": "The timezone for the store."
},
"created_at": {
"type": "string",
"title": "Creation Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was created in ISO 8601 format."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations)."
},
"updated_at": {
"type": "string",
"title": "Update Time",
"format": "date-time",
"example": "2015-07-15T19:28:00+00:00",
"readOnly": true,
"description": "The date and time the store was last updated in ISO 8601 format."
},
"automations": {
"type": "object",
"title": "Automations",
"readOnly": true,
"properties": {
"abandoned_cart": {
"type": "object",
"title": "Abandoned Cart Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedCart automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedCart automation."
}
},
"description": "abandonedCart automation details."
},
"abandoned_browse": {
"type": "object",
"title": "Abandoned Browse Automation",
"readOnly": true,
"properties": {
"id": {
"type": "string",
"title": "ID",
"example": "355a72bfc3",
"readOnly": true,
"description": "Unique ID of automation parent campaign."
},
"status": {
"enum": [
"save",
"sending",
"paused"
],
"type": "string",
"title": "Status",
"example": "sending",
"readOnly": true,
"description": "Status of the abandonedBrowse automation."
},
"is_supported": {
"type": "boolean",
"title": "Is Supported",
"example": false,
"readOnly": true,
"description": "Whether this store supports the abandonedBrowse automation."
}
},
"description": "abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web."
}
},
"description": "Details for the automations attached to this store."
},
"money_format": {
"type": "string",
"title": "Money Format",
"example": "$",
"description": "The currency format for the store. For example: `$`, `£`, etc."
},
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"email_address": {
"type": "string",
"title": "Email Address",
"example": "freddie@mailchimp.com",
"description": "The email address for the store."
},
"connected_site": {
"type": "object",
"title": "Connected Site",
"readOnly": true,
"properties": {
"site_script": {
"type": "object",
"title": "Script",
"readOnly": true,
"properties": {
"url": {
"type": "string",
"title": "Script URL",
"example": "https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js",
"readOnly": true,
"description": "The URL used for any integrations that offer built-in support for connected sites."
},
"fragment": {
"type": "string",
"title": "Script Fragment",
"example": "<script id=\"mcjs\">!function(c,h,i,m,p){m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js\");</script>",
"readOnly": true,
"description": "A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp."
}
},
"description": "The script used to connect your site with Mailchimp."
},
"site_foreign_id": {
"type": "string",
"title": "Connected Site Foreign ID",
"example": "a180c384d7db88b if created in-app, MC001 if created via API",
"readOnly": true,
"description": "The unique identifier for the connected site."
}
},
"description": "The Connected Site associated with the store."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list connected to the store, namely if it's deleted or disabled."
},
"primary_locale": {
"type": "string",
"title": "Primary Locale",
"example": "fr",
"description": "The primary locale for the store. For example: `en`, `de`, etc."
}
},
"description": "An individual store in an account."
}
EcommerceUpdateStoredefaultResponse
{
"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'."
}
FacebookAdsGetInfo200Response
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 43,
"description": "The ID of this connected site."
},
"url": {
"type": "string",
"example": "www.example.com",
"description": "The URL for this connected site."
},
"name": {
"type": "string",
"example": "My Connected Site",
"description": "The name of the connected site"
}
},
"description": "Connected Site"
},
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"content": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
}
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"feedback": {
"type": "object",
"properties": {
"budget": {
"type": "string",
"description": "Feedback regarding the budget of this Ad."
},
"content": {
"type": "string",
"description": "Feedback regarding the content of this Ad."
},
"audience": {
"type": "string",
"description": "Feedback regarding the audience of this Ad."
},
"compliance": {
"type": "string",
"description": "Feedback regarding the compliance of this Ad."
}
},
"description": "Check if this ad is connected to a facebook page"
},
"has_content": {
"type": "boolean",
"description": "Check if this ad has content"
},
"has_audience": {
"type": "boolean",
"description": "Check if this ad has audience setup"
},
"is_connected": {
"type": "boolean",
"description": "Check if this ad is connected to a facebook page"
}
},
"description": "A facebook ad."
},
{
"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."
}
}
}
]
}
FacebookAdsGetInfoResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 43,
"description": "The ID of this connected site."
},
"url": {
"type": "string",
"example": "www.example.com",
"description": "The URL for this connected site."
},
"name": {
"type": "string",
"example": "My Connected Site",
"description": "The name of the connected site"
}
},
"description": "Connected Site"
},
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"content": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
}
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"feedback": {
"type": "object",
"properties": {
"budget": {
"type": "string",
"description": "Feedback regarding the budget of this Ad."
},
"content": {
"type": "string",
"description": "Feedback regarding the content of this Ad."
},
"audience": {
"type": "string",
"description": "Feedback regarding the audience of this Ad."
},
"compliance": {
"type": "string",
"description": "Feedback regarding the compliance of this Ad."
}
},
"description": "Check if this ad is connected to a facebook page"
},
"has_content": {
"type": "boolean",
"description": "Check if this ad has content"
},
"has_audience": {
"type": "boolean",
"description": "Check if this ad has audience setup"
},
"is_connected": {
"type": "boolean",
"description": "Check if this ad is connected to a facebook page"
}
},
"description": "A facebook ad."
},
{
"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."
}
}
}
]
}
FacebookAdsGetInfodefaultResponse
{
"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'."
}
FacebookAdsListAds200Response
{
"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."
},
"facebook_ads": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 43,
"description": "The ID of this connected site."
},
"url": {
"type": "string",
"example": "www.example.com",
"description": "The URL for this connected site."
},
"name": {
"type": "string",
"example": "My Connected Site",
"description": "The name of the connected site"
}
},
"description": "Connected Site"
},
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"content": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
}
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"feedback": {
"type": "object",
"properties": {
"budget": {
"type": "string",
"description": "Feedback regarding the budget of this Ad."
},
"content": {
"type": "string",
"description": "Feedback regarding the content of this Ad."
},
"audience": {
"type": "string",
"description": "Feedback regarding the audience of this Ad."
},
"compliance": {
"type": "string",
"description": "Feedback regarding the compliance of this Ad."
}
},
"description": "Check if this ad is connected to a facebook page"
},
"has_content": {
"type": "boolean",
"description": "Check if this ad has content"
},
"has_audience": {
"type": "boolean",
"description": "Check if this ad has audience setup"
},
"is_connected": {
"type": "boolean",
"description": "Check if this ad is connected to a facebook page"
}
},
"description": "A facebook ad."
},
{
"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."
}
}
}
]
}
}
},
"description": "Contains an array of facebook ads."
}
FacebookAdsListAdsResponse
{
"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."
},
"facebook_ads": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"site": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 43,
"description": "The ID of this connected site."
},
"url": {
"type": "string",
"example": "www.example.com",
"description": "The URL for this connected site."
},
"name": {
"type": "string",
"example": "My Connected Site",
"description": "The name of the connected site"
}
},
"description": "Connected Site"
},
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"content": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"message": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"link_url": {
"type": "string"
},
"image_url": {
"type": "string"
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
}
},
"description": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"feedback": {
"type": "object",
"properties": {
"budget": {
"type": "string",
"description": "Feedback regarding the budget of this Ad."
},
"content": {
"type": "string",
"description": "Feedback regarding the content of this Ad."
},
"audience": {
"type": "string",
"description": "Feedback regarding the audience of this Ad."
},
"compliance": {
"type": "string",
"description": "Feedback regarding the compliance of this Ad."
}
},
"description": "Check if this ad is connected to a facebook page"
},
"has_content": {
"type": "boolean",
"description": "Check if this ad has content"
},
"has_audience": {
"type": "boolean",
"description": "Check if this ad has audience setup"
},
"is_connected": {
"type": "boolean",
"description": "Check if this ad is connected to a facebook page"
}
},
"description": "A facebook ad."
},
{
"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."
}
}
}
]
}
}
},
"description": "Contains an array of facebook ads."
}
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'."
}
LandingPagesUnpublishActiondefaultResponse
{
"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'."
}
LandingPagesUpdatePageById200Response
{
"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."
}
LandingPagesUpdatePageByIdRequest
{
"type": "object",
"title": "Landing Page",
"properties": {
"name": {
"type": "string",
"title": "Landing Page Name",
"description": "The name of this landing page."
},
"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."
}
},
"description": "A summary of an individual page's properties."
}
LandingPagesUpdatePageByIdResponse
{
"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."
}
LandingPagesUpdatePageByIddefaultResponse
{
"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'."
}
ListsAddInterestCategory200Response
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsAddInterestCategoryRequest
{
"type": "object",
"title": "Interest Category",
"required": [
"title",
"type"
],
"properties": {
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsAddInterestCategoryResponse
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsAddInterestCategorydefaultResponse
{
"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'."
}
ListsAddInterestInCategory200Response
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsAddInterestInCategoryRequest
{
"type": "object",
"title": "Interest",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsAddInterestInCategoryResponse
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsAddInterestInCategorydefaultResponse
{
"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'."
}
ListsAddMemberEventRequest
{
"type": "object",
"title": "Events",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Event Name",
"description": "The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length"
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "Events created with the is_syncing value set to `true` will not trigger automations."
},
"properties": {
"type": "object",
"title": "Properties",
"description": "An optional list of properties",
"additionalProperties": {
"type": "string"
}
},
"occurred_at": {
"type": "string",
"title": "Occurred Time",
"format": "date-time",
"description": "The date and time the event occurred in ISO 8601 format."
}
},
"description": "A new event for a specific list member"
}
ListsAddMemberEventResponse
{
"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'."
}
ListsAddMemberEventdefaultResponse
{
"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'."
}
ListsAddMemberNote200Response
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsAddMemberNoteRequest
{
"type": "object",
"title": "Member Notes",
"properties": {
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note. Note length is limited to 1,000 characters."
}
},
"description": "A specific note for a specific member."
}
ListsAddMemberNoteResponse
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsAddMemberNotedefaultResponse
{
"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'."
}
ListsAddMemberTagsRequest
{
"type": "object",
"title": "Member Tags",
"required": [
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"title": "Member Tag",
"required": [
"name",
"status"
],
"properties": {
"name": {
"type": "string",
"title": "Tag Name",
"description": "The name of the tag."
},
"status": {
"enum": [
"inactive",
"active"
],
"type": "string",
"title": "Status",
"description": "The status for the tag on the member, pass in active to add a tag or inactive to remove it."
}
},
"description": "Add or remove tags on a member by declaring a tag either active or inactive on a member."
},
"title": "Tags",
"description": "A list of tags assigned to the list member."
},
"is_syncing": {
"type": "boolean",
"title": "Is Syncing",
"description": "When is_syncing is true, automations based on the tags in the request will not fire"
}
},
"description": "A list of tags assigned to a list member."
}
ListsAddMemberTagsResponse
{
"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'."
}
ListsAddMemberTagsdefaultResponse
{
"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'."
}
ListsAddMemberToList200Response
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddMemberToListRequest
{
"type": "object",
"title": "Add List Members",
"required": [
"email_address",
"status"
],
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"description": "The name of the tag that will be associated with this member."
},
"title": "Tags on a member",
"description": "The tags that are associated with a member."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"description": "IP address the subscriber signed up from."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddMemberToListResponse
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddMemberToListdefaultResponse
{
"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'."
}
ListsAddMemberToSegment200Response
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddMemberToSegmentRequest
{
"type": "object",
"required": [
"email_address"
],
"properties": {
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
}
}
}
ListsAddMemberToSegmentResponse
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddMemberToSegmentdefaultResponse
{
"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'."
}
ListsAddMergeField200Response
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsAddMergeFieldRequest
{
"type": "object",
"title": "Merge Field",
"required": [
"name",
"type"
],
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"items": {
"type": "string"
},
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "Whether the merge field is required to import a contact."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsAddMergeFieldResponse
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsAddMergeFielddefaultResponse
{
"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'."
}
ListsAddNewSegment200Response
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsAddNewSegmentRequest
{
"type": "object",
"title": "List",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions."
},
"static_segment": {
"type": "array",
"items": {
"type": "string"
},
"title": "Static Segment",
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array will create a static segment without any subscribers. This field cannot be provided with the options field."
}
},
"description": "Information about a specific list segment."
}
ListsAddNewSegmentResponse
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsAddNewSegmentdefaultResponse
{
"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'."
}
ListsAddOrUpdateMember200Response
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddOrUpdateMemberRequest
{
"type": "object",
"title": "Add List Members",
"required": [
"email_address",
"status_if_new"
],
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"description": "IP address the subscriber signed up from."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber. This value is required only if the email address is not already present on the list."
},
"status_if_new": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "New Member Status",
"description": "Subscriber's status. This value is required only if the email address is not already present on the list."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddOrUpdateMemberResponse
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsAddOrUpdateMemberdefaultResponse
{
"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'."
}
ListsArchiveMemberResponse
{
"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'."
}
ListsArchiveMemberdefaultResponse
{
"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'."
}
ListsBatchAddRemoveMembers200Response
{
"type": "object",
"title": "Batch add/remove List members to/from static segment",
"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."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"type": "string",
"title": "Error message",
"description": "The error message indicating why the email addresses could not be added or updated."
},
"email_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Email addresses added to the static segment or removed",
"description": "Email addresses added to the static segment or removed"
}
}
},
"title": "Errors",
"description": "An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details."
},
"error_count": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"total_added": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"members_added": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members Added",
"description": "An array of objects, each representing a new member that was added to the static segment."
},
"total_removed": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"members_removed": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members Removed",
"description": "An array of objects, each representing an existing list member that got deleted from the static segment."
}
},
"description": "Batch add/remove List members to/from static segment"
}
ListsBatchAddRemoveMembersRequest
{
"type": "object",
"title": "Members to add/remove to/from a static segment",
"properties": {
"members_to_add": {
"type": "array",
"items": {
"type": "string"
},
"title": "Members to add to the static segment",
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent."
},
"members_to_remove": {
"type": "array",
"items": {
"type": "string"
},
"title": "Members to remove from the static segment",
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent."
}
},
"description": "Members to add/remove to/from a static segment"
}
ListsBatchAddRemoveMembersResponse
{
"type": "object",
"title": "Batch add/remove List members to/from static segment",
"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."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"type": "string",
"title": "Error message",
"description": "The error message indicating why the email addresses could not be added or updated."
},
"email_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Email addresses added to the static segment or removed",
"description": "Email addresses added to the static segment or removed"
}
}
},
"title": "Errors",
"description": "An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details."
},
"error_count": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"total_added": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"members_added": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members Added",
"description": "An array of objects, each representing a new member that was added to the static segment."
},
"total_removed": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"members_removed": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members Removed",
"description": "An array of objects, each representing an existing list member that got deleted from the static segment."
}
},
"description": "Batch add/remove List members to/from static segment"
}
ListsBatchAddRemoveMembersdefaultResponse
{
"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'."
}
ListsBatchSubscribeOrUnsubscribe200Response
{
"type": "object",
"title": "Batch update List members",
"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."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"type": "string",
"title": "Error message",
"description": "The error message indicating why the email address could not be added or updated."
},
"field": {
"type": "string",
"title": "Field",
"description": "If the error is field-related, information about which field is at issue."
},
"error_code": {
"enum": [
"ERROR_CONTACT_EXISTS",
"ERROR_GENERIC"
],
"type": "string",
"title": "Error code",
"description": "A unique code that identifies this specifc error."
},
"email_address": {
"type": "string",
"title": "Member Email address",
"description": "The email address that could not be added or updated."
},
"field_message": {
"type": "string",
"title": "Field message",
"description": "Message indicating how to resolve a field-related error."
}
}
},
"title": "Errors",
"description": "An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details."
},
"error_count": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"new_members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "New members",
"description": "An array of objects, each representing a new member that was added to the list."
},
"total_created": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"total_updated": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"updated_members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Updated Members",
"description": "An array of objects, each representing an existing list member whose subscription status was updated."
}
},
"description": "Batch update list members."
}
ListsBatchSubscribeOrUnsubscribeRequest
{
"type": "object",
"title": "Members to Subscribe/Unsubscribe to/from a List in batch",
"required": [
"members"
],
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Add List Members",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"description": "IP address the subscriber signed up from."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "List Members",
"description": "An array of objects, each representing an email address and the subscription status for a specific list. Up to 500 members may be added or updated with each API call."
},
"sync_tags": {
"type": "boolean",
"title": "Sync Tags",
"description": "Whether this batch operation will replace all existing tags with tags in request."
},
"update_existing": {
"type": "boolean",
"title": "Update Existing Members",
"description": "Whether this batch operation will change existing members' subscription status."
}
},
"description": "Members to subscribe to or unsubscribe from a list."
}
ListsBatchSubscribeOrUnsubscribeResponse
{
"type": "object",
"title": "Batch update List members",
"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."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"error": {
"type": "string",
"title": "Error message",
"description": "The error message indicating why the email address could not be added or updated."
},
"field": {
"type": "string",
"title": "Field",
"description": "If the error is field-related, information about which field is at issue."
},
"error_code": {
"enum": [
"ERROR_CONTACT_EXISTS",
"ERROR_GENERIC"
],
"type": "string",
"title": "Error code",
"description": "A unique code that identifies this specifc error."
},
"email_address": {
"type": "string",
"title": "Member Email address",
"description": "The email address that could not be added or updated."
},
"field_message": {
"type": "string",
"title": "Field message",
"description": "Message indicating how to resolve a field-related error."
}
}
},
"title": "Errors",
"description": "An array of objects, each representing an email address that could not be added to the list or updated and an error message providing more details."
},
"error_count": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"new_members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "New members",
"description": "An array of objects, each representing a new member that was added to the list."
},
"total_created": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"total_updated": {
"type": "integer",
"title": "Item Count",
"example": 42,
"description": "The total number of items matching the query, irrespective of pagination."
},
"updated_members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "The tags applied to this member."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Member Merge Var",
"description": "An individual merge var and value for a member.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Updated Members",
"description": "An array of objects, each representing an existing list member whose subscription status was updated."
}
},
"description": "Batch update list members."
}
ListsBatchSubscribeOrUnsubscribedefaultResponse
{
"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'."
}
ListsCreateNewList200Response
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsCreateNewListRequest
{
"type": "object",
"title": "Subscriber List",
"required": [
"name",
"permission_reminder",
"email_type_option",
"contact",
"campaign_defaults"
],
"properties": {
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"contact": {
"type": "object",
"title": "List Contact",
"required": [
"company",
"address1",
"city",
"country"
],
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"required": [
"from_name",
"from_email",
"subject",
"language"
],
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsCreateNewListResponse
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsCreateNewListdefaultResponse
{
"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'."
}
ListsCreateWebhook200Response
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsCreateWebhookRequest
{
"type": "object",
"title": "Add Webhook",
"properties": {
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"description": "A valid URL for the Webhook."
},
"events": {
"type": "object",
"title": "Events",
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"sources": {
"type": "object",
"title": "Sources",
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Configure a webhook for the given list."
}
ListsCreateWebhookResponse
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsCreateWebhookdefaultResponse
{
"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'."
}
ListsCustomizeSignupForm200Response
{
"type": "object",
"title": "Signup Form",
"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."
},
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The signup form's list id."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
},
"signup_form_url": {
"type": "string",
"title": "Signup form URL",
"description": "Signup form URL."
}
},
"description": "List signup form."
}
ListsCustomizeSignupFormRequest
{
"type": "object",
"title": "Signup Form",
"properties": {
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
}
},
"description": "List signup form."
}
ListsCustomizeSignupFormResponse
{
"type": "object",
"title": "Signup Form",
"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."
},
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The signup form's list id."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
},
"signup_form_url": {
"type": "string",
"title": "Signup form URL",
"description": "Signup form URL."
}
},
"description": "List signup form."
}
ListsCustomizeSignupFormdefaultResponse
{
"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'."
}
ListsDeleteInterestCategoryResponse
{
"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'."
}
ListsDeleteInterestCategorydefaultResponse
{
"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'."
}
ListsDeleteInterestInCategoryResponse
{
"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'."
}
ListsDeleteInterestInCategorydefaultResponse
{
"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'."
}
ListsDeleteListResponse
{
"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'."
}
ListsDeleteListdefaultResponse
{
"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'."
}
ListsDeleteMergeFieldResponse
{
"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'."
}
ListsDeleteMergeFielddefaultResponse
{
"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'."
}
ListsDeleteNoteResponse
{
"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'."
}
ListsDeleteNotedefaultResponse
{
"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'."
}
ListsDeleteSegmentResponse
{
"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'."
}
ListsDeleteSegmentdefaultResponse
{
"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'."
}
ListsDeleteWebhookResponse
{
"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'."
}
ListsDeleteWebhookdefaultResponse
{
"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'."
}
ListsGetAbuseReport200Response
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAbuseReportResponse
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAbuseReportdefaultResponse
{
"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'."
}
ListsGetAllAbuseReports200Response
{
"type": "object",
"title": "Abuse Complaints",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id for the abuse report."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAllAbuseReportsResponse
{
"type": "object",
"title": "Abuse Complaints",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id for the abuse report."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A collection of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ListsGetAllAbuseReportsdefaultResponse
{
"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'."
}
ListsGetAllInfo200Response
{
"type": "object",
"title": "Subscriber Lists",
"required": [
"lists"
],
"properties": {
"lists": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
},
"title": "Lists",
"description": "An array of objects, each representing a list."
},
"_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."
},
"constraints": {
"type": "object",
"title": "Collection Authorization",
"required": [
"may_create",
"max_instances"
],
"properties": {
"may_create": {
"type": "boolean",
"title": "Resource creation authorization",
"description": "May the user create additional instances of this resource?"
},
"max_instances": {
"type": "integer",
"title": "Max instances",
"description": "How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited."
},
"current_total_instances": {
"type": "integer",
"title": "Current total instances",
"description": "How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited."
}
},
"description": "Do particular authorization constraints around this collection limit creation of new instances?"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization."
}
ListsGetAllInfoResponse
{
"type": "object",
"title": "Subscriber Lists",
"required": [
"lists"
],
"properties": {
"lists": {
"type": "array",
"items": {
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
},
"title": "Lists",
"description": "An array of objects, each representing a list."
},
"_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."
},
"constraints": {
"type": "object",
"title": "Collection Authorization",
"required": [
"may_create",
"max_instances"
],
"properties": {
"may_create": {
"type": "boolean",
"title": "Resource creation authorization",
"description": "May the user create additional instances of this resource?"
},
"max_instances": {
"type": "integer",
"title": "Max instances",
"description": "How many total instances of this resource are allowed? This is independent of any filter conditions applied to the query. As a special case, -1 indicates unlimited."
},
"current_total_instances": {
"type": "integer",
"title": "Current total instances",
"description": "How many total instances of this resource are already in use? This is independent of any filter conditions applied to the query. Value may be larger than max_instances. As a special case, -1 is returned when access is unlimited."
}
},
"description": "Do particular authorization constraints around this collection limit creation of new instances?"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of subscriber lists for this account. Lists contain subscribers who have opted-in to receive correspondence from you or your organization."
}
ListsGetAllInfodefaultResponse
{
"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'."
}
ListsGetGrowthHistoryByMonth200Response
{
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
}
ListsGetGrowthHistoryByMonthResponse
{
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
}
ListsGetGrowthHistoryByMonthdefaultResponse
{
"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'."
}
ListsGetGrowthHistoryData200Response
{
"type": "object",
"title": "Growth History",
"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."
},
"history": {
"type": "array",
"items": {
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
},
"title": "Members",
"description": "An array of objects, each representing a monthly growth report for a list."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A month-by-month summary of a specific list's growth activity."
}
ListsGetGrowthHistoryDataResponse
{
"type": "object",
"title": "Growth History",
"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."
},
"history": {
"type": "array",
"items": {
"type": "object",
"title": "Growth History",
"properties": {
"month": {
"type": "string",
"title": "Month",
"readOnly": true,
"description": "The month that the growth history is describing."
},
"_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."
},
"optins": {
"type": "integer",
"title": "Opt-in",
"readOnly": true,
"description": "(deprecated)"
},
"cleaned": {
"type": "integer",
"title": "Cleaned",
"readOnly": true,
"description": "Newly cleaned (hard-bounced) members on the list for a specific month."
},
"deleted": {
"type": "integer",
"title": "Deleted",
"readOnly": true,
"description": "Newly deleted members on the list for a specific month."
},
"imports": {
"type": "integer",
"title": "Imports",
"readOnly": true,
"description": "(deprecated)"
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id for the growth activity report."
},
"pending": {
"type": "integer",
"title": "Pending",
"readOnly": true,
"description": "Pending members on the list for a specific month."
},
"existing": {
"type": "integer",
"title": "Existing",
"readOnly": true,
"description": "(deprecated)"
},
"reconfirm": {
"type": "integer",
"title": "Reconfirm",
"readOnly": true,
"description": "Newly reconfirmed members on the list for a specific month."
},
"subscribed": {
"type": "integer",
"title": "Subscribed",
"readOnly": true,
"description": "Total subscribed members on the list at the end of the month."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribed",
"readOnly": true,
"description": "Newly unsubscribed members on the list for a specific month."
},
"transactional": {
"type": "integer",
"title": "Transactional",
"readOnly": true,
"description": "Subscribers that have been sent transactional emails via Mandrill."
}
},
"description": "A summary of a specific list's growth activity for a specific month and year."
},
"title": "Members",
"description": "An array of objects, each representing a monthly growth report for a list."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A month-by-month summary of a specific list's growth activity."
}
ListsGetGrowthHistoryDatadefaultResponse
{
"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'."
}
ListsGetInterestCategoryInfo200Response
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsGetInterestCategoryInfoResponse
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsGetInterestCategoryInfodefaultResponse
{
"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'."
}
ListsGetInterestInCategory200Response
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsGetInterestInCategoryResponse
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsGetInterestInCategorydefaultResponse
{
"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'."
}
ListsGetListInfo200Response
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsGetListInfoResponse
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsGetListInfodefaultResponse
{
"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'."
}
ListsGetLocations200Response
{
"type": "object",
"title": "List Locations",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique id for the list."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"title": "List Location",
"properties": {
"cc": {
"type": "string",
"title": "cc",
"readOnly": true,
"description": "The ISO 3166 2 digit country code."
},
"total": {
"type": "integer",
"title": "total",
"readOnly": true,
"description": "The total number of subscribers in the country."
},
"country": {
"type": "string",
"title": "Country Name",
"readOnly": true,
"description": "The name of the country."
},
"percent": {
"type": "number",
"title": "percent",
"readOnly": true,
"description": "The percent of subscribers in the country."
}
}
},
"title": "Locations",
"description": "An array of objects, each representing a list's top subscriber locations."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of List's locations."
}
ListsGetLocationsResponse
{
"type": "object",
"title": "List Locations",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique id for the list."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"title": "List Location",
"properties": {
"cc": {
"type": "string",
"title": "cc",
"readOnly": true,
"description": "The ISO 3166 2 digit country code."
},
"total": {
"type": "integer",
"title": "total",
"readOnly": true,
"description": "The total number of subscribers in the country."
},
"country": {
"type": "string",
"title": "Country Name",
"readOnly": true,
"description": "The name of the country."
},
"percent": {
"type": "number",
"title": "percent",
"readOnly": true,
"description": "The percent of subscribers in the country."
}
}
},
"title": "Locations",
"description": "An array of objects, each representing a list's top subscriber locations."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of List's locations."
}
ListsGetLocationsdefaultResponse
{
"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'."
}
ListsGetMemberEvents200Response
{
"type": "object",
"title": "Collection of Events",
"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."
},
"events": {
"type": "array",
"items": {
"type": "object",
"title": "Event",
"properties": {
"name": {
"type": "string",
"title": "Event Name",
"description": "The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length"
},
"properties": {
"type": "object",
"title": "Properties",
"description": "An optional list of properties",
"additionalProperties": {
"type": "string"
}
},
"occurred_at": {
"type": "string",
"title": "Occurred Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the event occurred in ISO 8601 format."
}
},
"description": "A specific event for a contact."
},
"title": "Events",
"description": "An array of objects, each representing an event."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of events for a given contact"
}
ListsGetMemberEventsResponse
{
"type": "object",
"title": "Collection of Events",
"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."
},
"events": {
"type": "array",
"items": {
"type": "object",
"title": "Event",
"properties": {
"name": {
"type": "string",
"title": "Event Name",
"description": "The name for this type of event ('purchased', 'visited', etc). Must be 2-30 characters in length"
},
"properties": {
"type": "object",
"title": "Properties",
"description": "An optional list of properties",
"additionalProperties": {
"type": "string"
}
},
"occurred_at": {
"type": "string",
"title": "Occurred Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the event occurred in ISO 8601 format."
}
},
"description": "A specific event for a contact."
},
"title": "Events",
"description": "An array of objects, each representing an event."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of events for a given contact"
}
ListsGetMemberEventsdefaultResponse
{
"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'."
}
ListsGetMemberGoals200Response
{
"type": "object",
"title": "Collection of Member Activity Events",
"properties": {
"goals": {
"type": "array",
"items": {
"type": "object",
"title": "Goal",
"properties": {
"data": {
"type": "string",
"title": "Additional Data",
"description": "Any extra data passed with the Goal event."
},
"event": {
"type": "string",
"title": "Event Name",
"description": "The name/type of Goal event triggered."
},
"goal_id": {
"type": "integer",
"title": "Goal ID",
"description": "The id for a Goal event."
},
"last_visited_at": {
"type": "string",
"title": "Last Visit Date",
"format": "date-time",
"description": "The date and time the user last triggered the Goal event in ISO 8601 format."
}
},
"description": "A single instance of a goal activity."
},
"title": "Goal Activity",
"description": "The last 50 Goal events triggered by a member."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 50 Goal events for a member on a specific list."
}
ListsGetMemberGoalsResponse
{
"type": "object",
"title": "Collection of Member Activity Events",
"properties": {
"goals": {
"type": "array",
"items": {
"type": "object",
"title": "Goal",
"properties": {
"data": {
"type": "string",
"title": "Additional Data",
"description": "Any extra data passed with the Goal event."
},
"event": {
"type": "string",
"title": "Event Name",
"description": "The name/type of Goal event triggered."
},
"goal_id": {
"type": "integer",
"title": "Goal ID",
"description": "The id for a Goal event."
},
"last_visited_at": {
"type": "string",
"title": "Last Visit Date",
"format": "date-time",
"description": "The date and time the user last triggered the Goal event in ISO 8601 format."
}
},
"description": "A single instance of a goal activity."
},
"title": "Goal Activity",
"description": "The last 50 Goal events triggered by a member."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 50 Goal events for a member on a specific list."
}
ListsGetMemberGoalsdefaultResponse
{
"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'."
}
ListsGetMemberInfo200Response
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsGetMemberInfoResponse
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsGetMemberInfodefaultResponse
{
"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'."
}
ListsGetMemberNote200Response
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsGetMemberNoteResponse
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsGetMemberNotedefaultResponse
{
"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'."
}
ListsGetMemberNotes200Response
{
"type": "object",
"title": "Collection of Notes",
"properties": {
"notes": {
"type": "array",
"items": {
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
},
"title": "Notes",
"description": "An array of objects, each representing a note resource."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 10 notes for a specific list member, based on date created."
}
ListsGetMemberNotesResponse
{
"type": "object",
"title": "Collection of Notes",
"properties": {
"notes": {
"type": "array",
"items": {
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
},
"title": "Notes",
"description": "An array of objects, each representing a note resource."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 10 notes for a specific list member, based on date created."
}
ListsGetMemberNotesdefaultResponse
{
"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'."
}
ListsGetMemberTags200Response
{
"type": "object",
"title": "Collection of Tags",
"properties": {
"tags": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"name": {
"type": "string",
"title": "Tag Name",
"description": "The name of the tag."
},
"date_added": {
"type": "string",
"title": "Date Added",
"format": "date-time",
"readOnly": true,
"description": "The date and time the tag was added to the list member in ISO 8601 format."
}
}
},
"title": "Tags",
"readOnly": false,
"description": "A list of tags assigned to the list member."
},
"_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."
}
},
"description": "A list of tags assigned to a list member."
}
ListsGetMemberTagsResponse
{
"type": "object",
"title": "Collection of Tags",
"properties": {
"tags": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"name": {
"type": "string",
"title": "Tag Name",
"description": "The name of the tag."
},
"date_added": {
"type": "string",
"title": "Date Added",
"format": "date-time",
"readOnly": true,
"description": "The date and time the tag was added to the list member in ISO 8601 format."
}
}
},
"title": "Tags",
"readOnly": false,
"description": "A list of tags assigned to the list member."
},
"_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."
}
},
"description": "A list of tags assigned to a list member."
}
ListsGetMemberTagsdefaultResponse
{
"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'."
}
ListsGetMembersInfo200Response
{
"type": "object",
"title": "List Members",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members."
}
ListsGetMembersInfoResponse
{
"type": "object",
"title": "List Members",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members."
}
ListsGetMembersInfodefaultResponse
{
"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'."
}
ListsGetMergeFieldInfo200Response
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsGetMergeFieldInfoResponse
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsGetMergeFieldInfodefaultResponse
{
"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'."
}
ListsGetRecentActivityStats200Response
{
"type": "object",
"title": "List Activity",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Daily List Activity",
"properties": {
"day": {
"type": "string",
"title": "Day",
"readOnly": true,
"description": "The date for the activity summary."
},
"subs": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes."
},
"_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."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"readOnly": true,
"description": "The number of unsubscribes."
},
"other_adds": {
"type": "integer",
"title": "Other Adds",
"readOnly": true,
"description": "The number of subscribers who may have been added outside of the [double opt-in process](https://mailchimp.com/help/about-double-opt-in/), such as imports or API activity."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent on the date for the activity summary."
},
"hard_bounce": {
"type": "integer",
"title": "Hard Bounces",
"readOnly": true,
"description": "The number of hard bounces."
},
"soft_bounce": {
"type": "integer",
"title": "Soft Bounces",
"readOnly": true,
"description": "The number of soft bounces"
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"other_removes": {
"type": "integer",
"title": "Other Removes",
"readOnly": true,
"description": "The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers)."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"readOnly": true,
"description": "The number of clicks."
}
},
"description": "One day's worth of list activity. Doesn't include Automation activity."
},
"title": "List Activity",
"description": "Recent list activity."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity."
}
ListsGetRecentActivityStatsResponse
{
"type": "object",
"title": "List Activity",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Daily List Activity",
"properties": {
"day": {
"type": "string",
"title": "Day",
"readOnly": true,
"description": "The date for the activity summary."
},
"subs": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes."
},
"_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."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"readOnly": true,
"description": "The number of unsubscribes."
},
"other_adds": {
"type": "integer",
"title": "Other Adds",
"readOnly": true,
"description": "The number of subscribers who may have been added outside of the [double opt-in process](https://mailchimp.com/help/about-double-opt-in/), such as imports or API activity."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent on the date for the activity summary."
},
"hard_bounce": {
"type": "integer",
"title": "Hard Bounces",
"readOnly": true,
"description": "The number of hard bounces."
},
"soft_bounce": {
"type": "integer",
"title": "Soft Bounces",
"readOnly": true,
"description": "The number of soft bounces"
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"other_removes": {
"type": "integer",
"title": "Other Removes",
"readOnly": true,
"description": "The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers)."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"readOnly": true,
"description": "The number of clicks."
}
},
"description": "One day's worth of list activity. Doesn't include Automation activity."
},
"title": "List Activity",
"description": "Recent list activity."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Up to the previous 180 days of daily detailed aggregated activity stats for a specific list. Does not include AutoResponder or Automation activity."
}
ListsGetRecentActivityStatsdefaultResponse
{
"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'."
}
ListsGetSegmentInfo200Response
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsGetSegmentInfoResponse
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsGetSegmentInfodefaultResponse
{
"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'."
}
ListsGetSegmentMembers200Response
{
"type": "object",
"title": "Segment Members",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "View members in a specific list segment."
}
ListsGetSegmentMembersResponse
{
"type": "object",
"title": "Segment Members",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "View members in a specific list segment."
}
ListsGetSegmentMembersdefaultResponse
{
"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'."
}
ListsGetSegmentsInfo200Response
{
"type": "object",
"title": "Collection of Segments",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"segments": {
"type": "array",
"items": {
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
},
"title": "Lists",
"description": "An array of objects, each representing a list segment."
},
"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 available segments."
}
ListsGetSegmentsInfoResponse
{
"type": "object",
"title": "Collection of Segments",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"segments": {
"type": "array",
"items": {
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
},
"title": "Lists",
"description": "An array of objects, each representing a list segment."
},
"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 available segments."
}
ListsGetSegmentsInfodefaultResponse
{
"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'."
}
ListsGetSignupForms200Response
{
"type": "object",
"title": "List Signup Forms",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"signup_forms": {
"type": "array",
"items": {
"type": "object",
"title": "Signup Form",
"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."
},
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The signup form's list id."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
},
"signup_form_url": {
"type": "string",
"title": "Signup form URL",
"description": "Signup form URL."
}
},
"description": "List signup form."
},
"title": "List Signup Form",
"description": "List signup form."
}
},
"description": "List Signup Forms."
}
ListsGetSignupFormsResponse
{
"type": "object",
"title": "List Signup Forms",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"signup_forms": {
"type": "array",
"items": {
"type": "object",
"title": "Signup Form",
"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."
},
"header": {
"type": "object",
"title": "Signup form header options",
"properties": {
"text": {
"type": "string",
"title": "Header Text",
"example": "Header Text goes here",
"description": "Header text."
},
"image_alt": {
"type": "string",
"title": "Image Alt",
"example": "This is an image",
"description": "Alt text for the image."
},
"image_url": {
"type": "string",
"title": "Header Image URL",
"example": "http://gallery.mailchimp.com/332310cb9a420a9e7fea2858a/images/2491208c-9458-4834-a708-fef4ee736472.png",
"description": "Header image URL."
},
"image_link": {
"type": "string",
"title": "Image Link",
"example": "gotothisimage.com",
"description": "The URL that the header image will link to."
},
"image_align": {
"enum": [
"none",
"left",
"center",
"right"
],
"type": "string",
"title": "Image align",
"example": "center",
"description": "Image alignment."
},
"image_width": {
"type": "string",
"title": "Image width",
"example": "800",
"description": "Image width, in pixels."
},
"image_height": {
"type": "string",
"title": "Image height",
"example": "200",
"description": "Image height, in pixels."
},
"image_target": {
"enum": [
"_blank",
"null"
],
"type": "string",
"title": "Image target",
"example": "_blank",
"description": "Image link target."
},
"image_border_color": {
"type": "string",
"title": "Image border color",
"example": "#896d6d",
"description": "Image border color."
},
"image_border_style": {
"enum": [
"none",
"solid",
"dotted",
"dashed",
"double",
"groove",
"outset",
"inset",
"ridge"
],
"type": "string",
"title": "Image border style",
"example": "solid",
"description": "Image border style."
},
"image_border_width": {
"type": "string",
"title": "Image border width",
"example": "2",
"description": "Image border width."
}
},
"description": "Options for customizing your signup form header."
},
"styles": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Element style for List Signup Forms",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"title": "An option for Signup Form Styles",
"properties": {
"value": {
"type": "string",
"title": "Value",
"example": "#111111",
"description": "A string that identifies value of the property."
},
"property": {
"type": "string",
"title": "Property",
"example": "background-color",
"description": "A string that identifies the property."
}
},
"description": "An option for Signup Form Styles."
},
"title": "Options",
"description": "A collection of options for a selector."
},
"selector": {
"enum": [
"page_background",
"page_header",
"page_outer_wrapper",
"body_background",
"body_link_style",
"forms_buttons",
"forms_buttons_hovered",
"forms_field_label",
"forms_field_text",
"forms_required",
"forms_required_legend",
"forms_help_text",
"forms_errors",
"monkey_rewards_badge"
],
"type": "string",
"title": "Selector",
"example": "page_background",
"description": "A string that identifies the element selector."
}
},
"description": "Collection of Element style for List Signup Forms."
},
"title": "Signup Form element style",
"description": "An array of objects, each representing an element style for the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The signup form's list id."
},
"contents": {
"type": "array",
"items": {
"type": "object",
"title": "Collection of Content for List Signup Forms",
"properties": {
"value": {
"type": "string",
"title": "Content Section Value",
"example": "Signup message goes here",
"description": "The content section text."
},
"section": {
"enum": [
"signup_message",
"unsub_message",
"signup_thank_you_title"
],
"type": "string",
"title": "Content Section Name",
"example": "signup_message",
"description": "The content section name."
}
},
"description": "Collection of Content for List Signup Forms."
},
"title": "Signup form body content",
"description": "The signup form body content."
},
"signup_form_url": {
"type": "string",
"title": "Signup form URL",
"description": "Signup form URL."
}
},
"description": "List signup form."
},
"title": "List Signup Form",
"description": "List signup form."
}
},
"description": "List Signup Forms."
}
ListsGetSignupFormsdefaultResponse
{
"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'."
}
ListsGetSurveyDetailsResponse
{
"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'."
}
ListsGetSurveyDetailsdefaultResponse
{
"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'."
}
ListsGetSurveysInfoResponse
{
"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'."
}
ListsGetSurveysInfodefaultResponse
{
"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'."
}
ListsGetWebhookInfo200Response
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsGetWebhookInfoResponse
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsGetWebhookInfodefaultResponse
{
"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'."
}
ListsGetWebhooksInfo200Response
{
"type": "object",
"title": "List Webhooks",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
},
"title": "Webhooks",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage webhooks for a specific list."
}
ListsGetWebhooksInfoResponse
{
"type": "object",
"title": "List Webhooks",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The list id."
},
"webhooks": {
"type": "array",
"items": {
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
},
"title": "Webhooks",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Manage webhooks for a specific list."
}
ListsGetWebhooksInfodefaultResponse
{
"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'."
}
ListsListCategoryInterests200Response
{
"type": "object",
"title": "Interests",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id that the interests belong to."
},
"interests": {
"type": "array",
"items": {
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
},
"title": "Interests",
"description": "An array of this category's interests"
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"description": "The id for the interest category."
},
"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 this category's interests"
}
ListsListCategoryInterestsResponse
{
"type": "object",
"title": "Interests",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id that the interests belong to."
},
"interests": {
"type": "array",
"items": {
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
},
"title": "Interests",
"description": "An array of this category's interests"
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"description": "The id for the interest category."
},
"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 this category's interests"
}
ListsListCategoryInterestsdefaultResponse
{
"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'."
}
ListsListInterestCategories200Response
{
"type": "object",
"title": "Interest Groupings",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this category belongs to."
},
"categories": {
"type": "array",
"items": {
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
},
"title": "Interest Categories",
"description": "This array contains individual interest categories."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Information about this list's interest categories."
}
ListsListInterestCategoriesResponse
{
"type": "object",
"title": "Interest Groupings",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this category belongs to."
},
"categories": {
"type": "array",
"items": {
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
},
"title": "Interest Categories",
"description": "This array contains individual interest categories."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Information about this list's interest categories."
}
ListsListInterestCategoriesdefaultResponse
{
"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'."
}
ListsListMergeFields200Response
{
"type": "object",
"title": "Collection of Merge Fields",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"merge_fields": {
"type": "array",
"items": {
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"title": "Merge Fields",
"description": "An array of objects, each representing a merge field resource."
}
},
"description": "The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsListMergeFieldsResponse
{
"type": "object",
"title": "Collection of Merge Fields",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"merge_fields": {
"type": "array",
"items": {
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"title": "Merge Fields",
"description": "An array of objects, each representing a merge field resource."
}
},
"description": "The [merge fields](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsListMergeFieldsdefaultResponse
{
"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'."
}
ListsListTopEmailClients200Response
{
"type": "object",
"title": "Email Clients",
"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."
},
"clients": {
"type": "array",
"items": {
"type": "object",
"title": "Email Client",
"properties": {
"client": {
"type": "string",
"title": "Client",
"readOnly": true,
"description": "The name of the email client."
},
"members": {
"type": "integer",
"title": "Members",
"readOnly": true,
"description": "The number of subscribed members who used this email client."
}
},
"description": "The email client."
},
"title": "Email Clients",
"description": "An array of top email clients."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The top email clients based on user-agent strings."
}
ListsListTopEmailClientsResponse
{
"type": "object",
"title": "Email Clients",
"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."
},
"clients": {
"type": "array",
"items": {
"type": "object",
"title": "Email Client",
"properties": {
"client": {
"type": "string",
"title": "Client",
"readOnly": true,
"description": "The name of the email client."
},
"members": {
"type": "integer",
"title": "Members",
"readOnly": true,
"description": "The number of subscribed members who used this email client."
}
},
"description": "The email client."
},
"title": "Email Clients",
"description": "An array of top email clients."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The top email clients based on user-agent strings."
}
ListsListTopEmailClientsdefaultResponse
{
"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'."
}
ListsRemoveMemberFromSegmentResponse
{
"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'."
}
ListsRemoveMemberFromSegmentdefaultResponse
{
"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'."
}
ListsRemoveMemberPermanentResponse
{
"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'."
}
ListsRemoveMemberPermanentdefaultResponse
{
"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'."
}
ListsSearchTagsByName200Response
{
"type": "object",
"title": "Tag search results",
"properties": {
"tags": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"name": {
"type": "string",
"title": "Tag Name",
"description": "The name of the tag."
}
}
},
"title": "Tags",
"readOnly": true,
"description": "A list of matching tags."
},
"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 tags matching the input query."
}
ListsSearchTagsByNameResponse
{
"type": "object",
"title": "Tag search results",
"properties": {
"tags": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"name": {
"type": "string",
"title": "Tag Name",
"description": "The name of the tag."
}
}
},
"title": "Tags",
"readOnly": true,
"description": "A list of matching tags."
},
"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 tags matching the input query."
}
ListsSearchTagsByNamedefaultResponse
{
"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'."
}
ListsUpdateInterestCategory200Response
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsUpdateInterestCategoryInterest200Response
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsUpdateInterestCategoryInterestResponse
{
"type": "object",
"title": "Interest",
"properties": {
"id": {
"type": "string",
"title": "Interest ID",
"readOnly": true,
"description": "The ID for the interest."
},
"name": {
"type": "string",
"title": "Interest Name",
"description": "The name of the interest. This can be shown publicly on a subscription form."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID for the list that this interest belongs to."
},
"category_id": {
"type": "string",
"title": "Interest Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The display order for interests."
},
"subscriber_count": {
"type": "string",
"title": "Subscriber Count",
"readOnly": true,
"description": "The number of subscribers associated with this interest."
}
},
"description": "Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application."
}
ListsUpdateInterestCategoryInterestdefaultResponse
{
"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'."
}
ListsUpdateInterestCategoryResponse
{
"type": "object",
"title": "Interest Category",
"properties": {
"id": {
"type": "string",
"title": "Category ID",
"readOnly": true,
"description": "The id for the interest category."
},
"type": {
"enum": [
"checkboxes",
"dropdown",
"radio",
"hidden"
],
"type": "string",
"title": "Display Type",
"description": "Determines how this category’s interests appear on signup forms."
},
"title": {
"type": "string",
"title": "Name",
"description": "The text description of this category. This field appears on signup forms and is often phrased as a question."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id for the category."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the categories are displayed in the list. Lower numbers display first."
}
},
"description": "Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to Group Titles the application."
}
ListsUpdateInterestCategorydefaultResponse
{
"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'."
}
ListsUpdateMember200Response
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsUpdateMemberRequest
{
"type": "object",
"title": "Add List Members",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
}
},
"description": "Subscriber location information."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"description": "IP address the subscriber signed up from."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsUpdateMemberResponse
{
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
}
ListsUpdateMemberdefaultResponse
{
"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'."
}
ListsUpdateMergeField200Response
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsUpdateMergeFieldRequest
{
"type": "object",
"title": "Merge Field",
"required": [
"name"
],
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for members to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "Whether the merge field is required to import a contact."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsUpdateMergeFieldResponse
{
"type": "object",
"title": "Merge Field",
"properties": {
"tag": {
"type": "string",
"title": "Merge Tag",
"description": "The merge tag used for Mailchimp campaigns and [adding contact information](https://mailchimp.com/developer/marketing/docs/merge-fields/#add-merge-data-to-contacts)."
},
"name": {
"type": "string",
"title": "Merge Field Name",
"description": "The name of the merge field (audience field)."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"_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."
},
"public": {
"type": "boolean",
"title": "Merge Field Public Status",
"description": "Whether the merge field is displayed on the signup form."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID that identifies this merge field's audience'."
},
"options": {
"type": "object",
"title": "Merge Field Options",
"properties": {
"size": {
"type": "integer",
"title": "Text Field Size",
"readOnly": true,
"description": "In a text field, the default length of the text field."
},
"choices": {
"type": "array",
"items": {
"type": "string"
},
"title": "Choices",
"example": [
"First Choice",
"Second Choice",
"Third Choice"
],
"description": "In a radio or dropdown non-group field, the available options for contacts to pick from."
},
"date_format": {
"type": "string",
"title": "Date Type",
"description": "In a date or birthday field, the format of the date."
},
"phone_format": {
"type": "string",
"title": "Phone Type",
"description": "In a phone field, the phone number type: US or International."
},
"default_country": {
"type": "integer",
"title": "Default Country",
"description": "In an address field, the default country code if none supplied."
}
},
"description": "Extra options for some merge field types."
},
"merge_id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "The boolean value if the merge field is required."
},
"help_text": {
"type": "string",
"title": "Merge Field Help Text",
"description": "Extra text to help the subscriber fill out the form."
},
"default_value": {
"type": "string",
"title": "Default Value",
"description": "The default value for the merge field if `null`."
},
"display_order": {
"type": "integer",
"title": "Display Order",
"description": "The order that the merge field displays on the list signup form."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
}
ListsUpdateMergeFielddefaultResponse
{
"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'."
}
ListsUpdateNoteSpecificListMember200Response
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsUpdateNoteSpecificListMemberResponse
{
"type": "object",
"title": "Member Notes",
"properties": {
"id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"note": {
"type": "string",
"title": "Note",
"description": "The content of the note."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
},
"updated_at": {
"type": "string",
"title": "Updated Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was last updated in ISO 8601 format."
}
},
"description": "A specific note for a specific member."
}
ListsUpdateNoteSpecificListMemberdefaultResponse
{
"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'."
}
ListsUpdateSegmentById200Response
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsUpdateSegmentByIdRequest
{
"type": "object",
"title": "List",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"title": "Segment Conditions",
"description": "An array of segment conditions."
}
},
"description": "The [conditions of the segment](https://mailchimp.com/help/save-and-manage-segments/). Static and fuzzy segments don't have conditions."
},
"static_segment": {
"type": "array",
"items": {
"type": "string"
},
"title": "Static Segment",
"description": "An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. Passing an empty array for an existing static segment will reset that segment and remove all members. This field cannot be provided with the `options` field."
}
},
"description": "Information about a specific list segment."
}
ListsUpdateSegmentByIdResponse
{
"type": "object",
"title": "List",
"properties": {
"id": {
"type": "integer",
"title": "Segment ID",
"readOnly": true,
"description": "The unique id for the segment."
},
"name": {
"type": "string",
"title": "Segment Name",
"description": "The name of the segment."
},
"type": {
"enum": [
"saved",
"static",
"fuzzy"
],
"type": "string",
"title": "Type",
"readOnly": true,
"description": "The type of segment. Static segments are now known as tags. Learn more about [tags](https://mailchimp.com/help/getting-started-tags?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs)."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"options": {
"type": "object",
"title": "Conditions",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match",
"description": "Match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
}
},
"description": "The conditions of the segment. Static segments (tags) and fuzzy segments don't have conditions."
},
"created_at": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Date Updated",
"format": "date-time",
"readOnly": true,
"description": "The date and time the segment was last updated in ISO 8601 format."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active subscribers currently included in the segment."
}
},
"description": "Information about a specific segment."
}
ListsUpdateSegmentByIddefaultResponse
{
"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'."
}
ListsUpdateSettings200Response
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsUpdateSettingsRequest
{
"type": "object",
"title": "Subscriber List",
"required": [
"name",
"permission_reminder",
"email_type_option",
"contact",
"campaign_defaults"
],
"properties": {
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"contact": {
"type": "object",
"title": "List Contact",
"required": [
"company",
"address1",
"city",
"state",
"zip",
"country"
],
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"required": [
"from_name",
"from_email",
"subject",
"language"
],
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsUpdateSettingsResponse
{
"type": "object",
"title": "Subscriber List",
"properties": {
"id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "A string that uniquely identifies this list."
},
"name": {
"type": "string",
"title": "List Name",
"description": "The name of the list."
},
"stats": {
"type": "object",
"title": "Statistics",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list (not returned if we haven't calculated it yet)."
},
"avg_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"member_count": {
"type": "integer",
"title": "Member Count",
"readOnly": true,
"description": "The number of active members in the list."
},
"cleaned_count": {
"type": "integer",
"title": "Cleaned Count",
"readOnly": true,
"description": "The number of members cleaned from the list."
},
"last_sub_date": {
"type": "string",
"title": "Date of Last List Subscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone subscribed to this list in ISO 8601 format."
},
"avg_unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list (not returned if we haven't calculated it yet)."
},
"campaign_count": {
"type": "integer",
"title": "Campaign Count",
"readOnly": true,
"description": "The number of campaigns in any status that use this list."
},
"total_contacts": {
"type": "integer",
"title": "Total Contacts",
"readOnly": true,
"description": "The number of contacts in the list, including subscribed, unsubscribed, pending, cleaned, deleted, transactional, and those that need to be reconfirmed. Requires include_total_contacts query parameter to be included."
},
"last_unsub_date": {
"type": "string",
"title": "Date of Last List Unsubscribe",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last time someone unsubscribed from this list in ISO 8601 format."
},
"target_sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The target number of subscriptions per month for the list to keep it growing (not returned if we haven't calculated it yet)."
},
"merge_field_count": {
"type": "integer",
"title": "Merge Field Count",
"readOnly": true,
"description": "The number of merge fields ([audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)) for this list (doesn't include EMAIL)."
},
"unsubscribe_count": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The number of members who have unsubscribed from the list."
},
"campaign_last_sent": {
"type": "string",
"title": "Campaign Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date and time the last campaign was sent to this list in ISO 8601 format. This is updated when a campaign is sent to 10 or more recipients."
},
"member_count_since_send": {
"type": "integer",
"title": "Member Count Since Send",
"readOnly": true,
"description": "The number of active members in the list since the last campaign was sent."
},
"cleaned_count_since_send": {
"type": "integer",
"title": "Cleaned Count Since Send",
"readOnly": true,
"description": "The number of members cleaned from the list since the last campaign was sent."
},
"unsubscribe_count_since_send": {
"type": "integer",
"title": "Unsubscribe Count Since Send",
"readOnly": true,
"description": "The number of members who have unsubscribed since the last campaign was sent."
}
},
"description": "Stats for the list. Many of these are cached for at least five minutes."
},
"_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."
},
"web_id": {
"type": "integer",
"title": "List Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this list in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/?id={web_id}`."
},
"contact": {
"type": "object",
"title": "List Contact",
"properties": {
"zip": {
"type": "string",
"title": "Postal Code",
"description": "The postal or zip code for the list contact."
},
"city": {
"type": "string",
"title": "City",
"description": "The city for the list contact."
},
"phone": {
"type": "string",
"title": "Phone Number",
"description": "The phone number for the list contact."
},
"state": {
"type": "string",
"title": "State",
"description": "The state for the list contact."
},
"company": {
"type": "string",
"title": "Company Name",
"description": "The company name for the list."
},
"country": {
"type": "string",
"title": "Country Code",
"description": "A two-character ISO3166 country code. Defaults to US if invalid."
},
"address1": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
},
"address2": {
"type": "string",
"title": "Address",
"description": "The street address for the list contact."
}
},
"description": "[Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply with international spam laws."
},
"modules": {
"type": "array",
"items": {
"type": "string"
},
"title": "Modules",
"readOnly": true,
"description": "Any list-specific modules installed for this list."
},
"visibility": {
"enum": [
"pub",
"prv"
],
"type": "string",
"title": "Visibility",
"description": "Legacy - visibility settings are no longer used"
},
"has_welcome": {
"type": "boolean",
"title": "Has Welcome",
"default": false,
"example": false,
"description": "Whether or not this list has a welcome automation connected. Welcome Automations: welcomeSeries, singleWelcome, emailFollowup."
},
"list_rating": {
"type": "integer",
"title": "List Rating",
"readOnly": true,
"description": "An auto-generated activity score for the list (0-5)."
},
"date_created": {
"type": "string",
"title": "Creation Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time that this list was created in ISO 8601 format."
},
"double_optin": {
"type": "boolean",
"title": "Double Opt In",
"default": false,
"description": "Whether or not to require the subscriber to confirm subscription via email."
},
"beamer_address": {
"type": "string",
"title": "Beamer Address",
"readOnly": true,
"description": "The list's [Email Beamer](https://mailchimp.com/help/use-email-beamer-to-create-a-campaign/) address."
},
"use_archive_bar": {
"type": "boolean",
"title": "Use Archive Bar",
"default": false,
"description": "Whether campaigns for this list use the [Archive Bar](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) in archives by default."
},
"campaign_defaults": {
"type": "object",
"title": "Campaign Defaults",
"properties": {
"subject": {
"type": "string",
"title": "Subject",
"description": "The default subject line for campaigns sent to this list."
},
"language": {
"type": "string",
"title": "Language",
"description": "The default language for this lists's forms."
},
"from_name": {
"type": "string",
"title": "Sender's Name",
"description": "The default from name for campaigns sent to this list."
},
"from_email": {
"type": "string",
"title": "Sender's Email Address",
"description": "The default from email for campaigns sent to this list."
}
},
"description": "[Default values for campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/) created for this list."
},
"email_type_option": {
"type": "boolean",
"title": "Email Type Option",
"description": "Whether the list supports [multiple formats for emails](https://mailchimp.com/help/change-audience-name-defaults/). When set to `true`, subscribers can choose whether they want to receive HTML or plain-text emails. When set to `false`, subscribers will receive HTML emails, with a plain-text alternative backup."
},
"subscribe_url_long": {
"type": "string",
"title": "Subscribe URL Long",
"readOnly": true,
"description": "The full version of this list's subscribe form (host will vary)."
},
"notify_on_subscribe": {
"type": "string",
"title": "Notify on Subscribe",
"default": false,
"description": "The email address to send [subscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
},
"permission_reminder": {
"type": "string",
"title": "Permission Reminder",
"description": "The [permission reminder](https://mailchimp.com/help/edit-the-permission-reminder/) for the list."
},
"subscribe_url_short": {
"type": "string",
"title": "Subscribe URL Short",
"readOnly": true,
"description": "Our [url shortened](https://mailchimp.com/help/share-your-signup-form/) version of this list's subscribe form."
},
"marketing_permissions": {
"type": "boolean",
"title": "Marketing Permissions",
"default": false,
"description": "Whether or not the list has marketing permissions (eg. GDPR) enabled."
},
"notify_on_unsubscribe": {
"type": "string",
"title": "Notify on Unsubscribe",
"default": false,
"description": "The email address to send [unsubscribe notifications](https://mailchimp.com/help/change-subscribe-and-unsubscribe-notifications/) to."
}
},
"description": "Information about a specific list."
}
ListsUpdateSettingsdefaultResponse
{
"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'."
}
ListsUpdateWebhookSettings200Response
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsUpdateWebhookSettingsResponse
{
"type": "object",
"title": "List Webhooks",
"properties": {
"id": {
"type": "string",
"title": "Unique ID",
"example": "5d9a5e3f7b",
"readOnly": true,
"description": "An string that uniquely identifies this webhook."
},
"url": {
"type": "string",
"title": "URL",
"example": "http://yourdomain.com/webhook",
"readOnly": true,
"description": "A valid URL for the Webhook."
},
"_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."
},
"events": {
"type": "object",
"title": "Events",
"readOnly": true,
"properties": {
"cleaned": {
"type": "boolean",
"title": "Cleaned",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is cleaned from the list."
},
"profile": {
"type": "boolean",
"title": "Profile Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's profile is updated."
},
"upemail": {
"type": "boolean",
"title": "Email Address Updated",
"example": true,
"description": "Whether the webhook is triggered when a subscriber's email address is changed."
},
"campaign": {
"type": "boolean",
"title": "Campaign Sent",
"example": true,
"description": "Whether the webhook is triggered when a campaign is sent or cancelled."
},
"subscribe": {
"type": "boolean",
"title": "Subscribed",
"example": true,
"description": "Whether the webhook is triggered when a list subscriber is added."
},
"unsubscribe": {
"type": "boolean",
"title": "Unsubscribed",
"example": true,
"description": "Whether the webhook is triggered when a list member unsubscribes."
}
},
"description": "The events that can trigger the webhook and whether they are enabled."
},
"list_id": {
"type": "string",
"title": "List ID",
"example": "4ca5becb8d",
"readOnly": true,
"description": "The unique id for the list."
},
"sources": {
"type": "object",
"title": "Sources",
"readOnly": true,
"properties": {
"api": {
"type": "boolean",
"title": "API",
"example": true,
"description": "Whether the webhook is triggered by actions initiated via the API."
},
"user": {
"type": "boolean",
"title": "User",
"example": true,
"description": "Whether the webhook is triggered by subscriber-initiated actions."
},
"admin": {
"type": "boolean",
"title": "Admin",
"example": true,
"description": "Whether the webhook is triggered by admin-initiated actions in the web interface."
}
},
"description": "The possible sources of any events that can trigger the webhook and whether they are enabled."
}
},
"description": "Webhook configured for the given list."
}
ListsUpdateWebhookSettingsdefaultResponse
{
"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'."
}
ListsViewRecentActivity200Response
{
"type": "object",
"title": "Member Activity Events",
"x-hidden": false,
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Email Opens",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"open"
],
"type": "string",
"x-value": "open",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing opening an email."
},
{
"type": "object",
"title": "Email Clicks",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"link_clicked": {
"type": "string",
"title": "Link Clicked",
"description": "The URL of the link that was clicked."
},
"activity_type": {
"enum": [
"click"
],
"type": "string",
"x-value": "click",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having a link clicked by a contact."
},
{
"type": "object",
"title": "Email Bounced",
"properties": {
"bounce_type": {
"enum": [
"hard",
"soft"
],
"type": "string",
"title": "Bounce Type",
"description": "The type of bounce."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"bounce"
],
"type": "string",
"x-value": "bounce",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"bounce_has_open_activity": {
"type": "boolean",
"title": "Bounce Has Open Activity",
"description": "Indicates if the email associated with this bounce also has open activity on the same campaign."
}
},
"description": "Activity feed item representing an email to this contact bouncing."
},
{
"type": "object",
"title": "List Unsubscribed",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"unsub"
],
"type": "string",
"x-value": "unsub",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Text",
"description": "The title of the campaign."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "Indicates the reason that the contact was unsubscribed."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"is_admin_unsubscribed": {
"type": "boolean",
"title": "Is Admin Unsubscribed",
"description": "Indicates if an admin unsubscribed a contact."
}
},
"description": "Activity feed item representing this contact unsubscribing from a list."
},
{
"type": "object",
"title": "Email Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sent"
],
"type": "string",
"x-value": "sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having an email sent to the contact."
},
{
"type": "object",
"title": "Email Conversation",
"properties": {
"is_user": {
"type": "boolean",
"title": "Is User",
"description": "Indicates that the message created by a user (as opposed to a contact)."
},
"has_read": {
"type": "boolean",
"title": "Has Read",
"description": "Indicates that the message has been read."
},
"thread_id": {
"type": "string",
"title": "Thread ID",
"description": "The thread's unique id of the conversation referenced in this event."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The gravatar URL of the contact who sent the reply."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The username of the person who created this event."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "The email of the contact who sent the reply."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"message_text": {
"type": "string",
"title": "Message Text",
"description": "The body of the message in this conversation."
},
"activity_type": {
"enum": [
"conversation"
],
"type": "string",
"x-value": "conversation",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an individual reply in a conversation."
},
{
"type": "object",
"title": "Note",
"properties": {
"note_id": {
"type": "string",
"title": "Note ID",
"description": "The note's unique id."
},
"note_text": {
"type": "string",
"title": "Note Text",
"description": "The note's text."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The URL of the contact's profile gravatar image."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The person who created the note."
},
"activity_type": {
"enum": [
"note"
],
"type": "string",
"x-value": "note",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"updated_at_timestamp": {
"type": "string",
"title": "Updated At Timestamp",
"format": "date-time",
"description": "The updated at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a note on the contact record."
},
{
"type": "object",
"title": "Marketing Permission",
"properties": {
"updated_by": {
"type": "string",
"title": "Updated By",
"description": "The name of the contact who updated this permission."
},
"activity_type": {
"enum": [
"marketing_permission"
],
"type": "string",
"x-value": "marketing_permission",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"marketing_permisson_text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text describing this marketing permission."
},
"marketing_permission_opted_in": {
"type": "boolean",
"title": "Marketing Permission Opted In",
"description": "Indicates if the marketing permission is enabled or not."
}
},
"description": "Activity feed item indicating if a marketing permission was added or updated."
},
{
"type": "object",
"title": "Postcard Sent",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"postcard_sent"
],
"type": "string",
"x-value": "postcard_sent",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a time when a contact was sent a particular postcard."
},
{
"type": "object",
"title": "Squatter Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"squatter_signup"
],
"type": "string",
"x-value": "squatter_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the audience from a squatter page."
},
{
"type": "object",
"title": "Website Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"website_signup"
],
"type": "string",
"x-value": "website_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the contact through a website page."
},
{
"type": "object",
"title": "Landing Page Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"landing_page_signup"
],
"type": "string",
"x-value": "landing_page_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a landing page."
},
{
"type": "object",
"title": "Ecommerce Signup",
"properties": {
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store."
},
"activity_type": {
"enum": [
"ecommerce_signup"
],
"type": "string",
"x-value": "ecommerce_signup",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a ecommerce store."
},
{
"type": "object",
"title": "Generic Signup",
"properties": {
"activity_type": {
"enum": [
"generic_signup"
],
"type": "string",
"x-value": "generic_signup",
"description": "The type of event activity."
},
"signup_category": {
"type": "string",
"title": "Signup Category",
"description": "How was this user added to the list."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to)."
},
{
"type": "object",
"title": "Ecommerce Order",
"properties": {
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The unique order id."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The order URL."
},
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store for an order."
},
"order_items": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Items",
"description": "An array of items that have been ordered."
},
"order_total": {
"type": "string",
"title": "Order Total",
"description": "The order total formatted as a string."
},
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"order"
],
"type": "string",
"x-value": "order",
"description": "The type of event activity."
},
"outreach_type": {
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach that triggered the event."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"type": "string",
"title": "Integration Platform",
"description": "The name of the integration platform this order originated through."
}
},
"description": "Activity feed item that represents an order."
},
{
"type": "object",
"title": "Contact Activity Event",
"properties": {
"event_name": {
"type": "string",
"title": "Event Name",
"description": "The name of the event."
},
"activity_type": {
"enum": [
"event"
],
"type": "string",
"x-value": "event",
"description": "The type of event activity."
},
"event_properties": {
"type": "array",
"items": {
"type": "string",
"x-skip-validation": true
},
"title": "Event Properties",
"description": "An arbitrary datastore containing properties for the given event."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a generic event."
},
{
"type": "object",
"title": "Survey response",
"properties": {
"survey_id": {
"type": "string",
"title": "Survey ID",
"description": "The survey's unique id."
},
"survey_title": {
"type": "string",
"title": "Survey Title",
"description": "The title of the survey."
},
"activity_type": {
"enum": [
"survey_response"
],
"type": "string",
"x-value": "survey_response",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Represents when a contact completes and submits a survey"
},
{
"type": "object",
"title": "SMS Bulk Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sms_bulk_sent"
],
"type": "string",
"x-value": "sms_bulk_sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the SMS campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an SMS campaign sent to the contact."
},
{
"type": "object",
"title": "Inbox Thread",
"properties": {
"id": {
"type": "string",
"title": "Thread ID",
"description": "The ID of the thread."
},
"thread_url": {
"type": "string",
"title": "Thread URL",
"description": "The url of the thread."
},
"activity_type": {
"enum": [
"inbox_thread"
],
"type": "string",
"x-value": "inbox_thread",
"description": "The type of event activity."
},
"thread_author": {
"type": "string",
"title": "Thread Author",
"description": "The author of the thread."
},
"thread_subject": {
"type": "string",
"title": "Thread Subject",
"description": "The subject of the thread."
},
"thread_direction": {
"enum": [
"INBOUND",
"OUTBOUND"
],
"type": "string",
"title": "Thread Direction",
"description": "The direction of the message noting if it is outbound or inbound."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a thread located in Inbox."
},
{
"type": "object",
"title": "QBO Payment Link",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The QuickBooks payment link id."
},
"activity_type": {
"enum": [
"qbo_payment_link"
],
"type": "string",
"x-value": "qbo_payment_link",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"enum": [
"quickbooks"
],
"type": "string",
"title": "Integration Platform",
"description": "The platform Mailchimp is integrated with."
},
"qbo_payment_external_id": {
"type": "string",
"title": "QBO Payment External ID",
"description": "The external QuickBooks payment id."
}
},
"description": "Activity feed item representing a payment link from QBO."
},
{
"type": "object",
"title": "Video Call Transcripts",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The id for video call transcripts."
},
"activity_type": {
"enum": [
"video_call_transcripts"
],
"type": "string",
"x-value": "video_call_transcripts",
"description": "The type of event activity."
},
"expire_at_timestamp": {
"type": "string",
"title": "Expire At Timestamp",
"format": "date-time",
"description": "The Expire At timestamp in ISO8601."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"scheduled_meeting_start_timestamp": {
"type": "string",
"title": "Scheduled Meeting Start Timestamp",
"format": "date-time",
"description": "The Scheduled Meeting Start timestamp in ISO8601."
}
},
"description": "Activity feed item representing a video call transcript."
}
],
"discriminator": {
"type": "string",
"propertyName": "activity_type"
}
},
"title": "Activity",
"readOnly": true,
"description": "An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas)."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"description": "The member activity events for a given member."
}
ListsViewRecentActivityEvents200Response
{
"type": "object",
"title": "Member Activity Events",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"url": {
"type": "string",
"title": "URL",
"description": "For clicks, the URL the subscriber clicked on."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign that was sent."
},
"title": {
"type": "string",
"title": "Campaign Title",
"description": "If set, the campaign's title."
},
"action": {
"type": "string",
"title": "Action Type",
"description": "The type of action recorded for the subscriber."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The web-based ID for the campaign."
},
"parent_campaign": {
"type": "string",
"title": "Parent Campaign ID",
"description": "The ID of the parent campaign."
}
},
"description": "Member activity events."
},
"title": "Activity",
"description": "An array of objects, each representing a member event."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 50 member events for a list."
}
ListsViewRecentActivityEventsResponse
{
"type": "object",
"title": "Member Activity Events",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"url": {
"type": "string",
"title": "URL",
"description": "For clicks, the URL the subscriber clicked on."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign that was sent."
},
"title": {
"type": "string",
"title": "Campaign Title",
"description": "If set, the campaign's title."
},
"action": {
"type": "string",
"title": "Action Type",
"description": "The type of action recorded for the subscriber."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The web-based ID for the campaign."
},
"parent_campaign": {
"type": "string",
"title": "Parent Campaign ID",
"description": "The ID of the parent campaign."
}
},
"description": "Member activity events."
},
"title": "Activity",
"description": "An array of objects, each representing a member event."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `email_id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The last 50 member events for a list."
}
ListsViewRecentActivityEventsdefaultResponse
{
"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'."
}
ListsViewRecentActivityResponse
{
"type": "object",
"title": "Member Activity Events",
"x-hidden": false,
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"activity": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Email Opens",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"open"
],
"type": "string",
"x-value": "open",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing opening an email."
},
{
"type": "object",
"title": "Email Clicks",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"link_clicked": {
"type": "string",
"title": "Link Clicked",
"description": "The URL of the link that was clicked."
},
"activity_type": {
"enum": [
"click"
],
"type": "string",
"x-value": "click",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having a link clicked by a contact."
},
{
"type": "object",
"title": "Email Bounced",
"properties": {
"bounce_type": {
"enum": [
"hard",
"soft"
],
"type": "string",
"title": "Bounce Type",
"description": "The type of bounce."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"bounce"
],
"type": "string",
"x-value": "bounce",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"bounce_has_open_activity": {
"type": "boolean",
"title": "Bounce Has Open Activity",
"description": "Indicates if the email associated with this bounce also has open activity on the same campaign."
}
},
"description": "Activity feed item representing an email to this contact bouncing."
},
{
"type": "object",
"title": "List Unsubscribed",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"unsub"
],
"type": "string",
"x-value": "unsub",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Text",
"description": "The title of the campaign."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "Indicates the reason that the contact was unsubscribed."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"is_admin_unsubscribed": {
"type": "boolean",
"title": "Is Admin Unsubscribed",
"description": "Indicates if an admin unsubscribed a contact."
}
},
"description": "Activity feed item representing this contact unsubscribing from a list."
},
{
"type": "object",
"title": "Email Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sent"
],
"type": "string",
"x-value": "sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing having an email sent to the contact."
},
{
"type": "object",
"title": "Email Conversation",
"properties": {
"is_user": {
"type": "boolean",
"title": "Is User",
"description": "Indicates that the message created by a user (as opposed to a contact)."
},
"has_read": {
"type": "boolean",
"title": "Has Read",
"description": "Indicates that the message has been read."
},
"thread_id": {
"type": "string",
"title": "Thread ID",
"description": "The thread's unique id of the conversation referenced in this event."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The gravatar URL of the contact who sent the reply."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The username of the person who created this event."
},
"from_email": {
"type": "string",
"title": "From Email",
"description": "The email of the contact who sent the reply."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"message_text": {
"type": "string",
"title": "Message Text",
"description": "The body of the message in this conversation."
},
"activity_type": {
"enum": [
"conversation"
],
"type": "string",
"x-value": "conversation",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an individual reply in a conversation."
},
{
"type": "object",
"title": "Note",
"properties": {
"note_id": {
"type": "string",
"title": "Note ID",
"description": "The note's unique id."
},
"note_text": {
"type": "string",
"title": "Note Text",
"description": "The note's text."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"description": "The URL of the contact's profile gravatar image."
},
"created_by": {
"type": "string",
"title": "Created By",
"description": "The person who created the note."
},
"activity_type": {
"enum": [
"note"
],
"type": "string",
"x-value": "note",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"updated_at_timestamp": {
"type": "string",
"title": "Updated At Timestamp",
"format": "date-time",
"description": "The updated at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a note on the contact record."
},
{
"type": "object",
"title": "Marketing Permission",
"properties": {
"updated_by": {
"type": "string",
"title": "Updated By",
"description": "The name of the contact who updated this permission."
},
"activity_type": {
"enum": [
"marketing_permission"
],
"type": "string",
"x-value": "marketing_permission",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"marketing_permisson_text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text describing this marketing permission."
},
"marketing_permission_opted_in": {
"type": "boolean",
"title": "Marketing Permission Opted In",
"description": "Indicates if the marketing permission is enabled or not."
}
},
"description": "Activity feed item indicating if a marketing permission was added or updated."
},
{
"type": "object",
"title": "Postcard Sent",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"postcard_sent"
],
"type": "string",
"x-value": "postcard_sent",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a time when a contact was sent a particular postcard."
},
{
"type": "object",
"title": "Squatter Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"squatter_signup"
],
"type": "string",
"x-value": "squatter_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the audience from a squatter page."
},
{
"type": "object",
"title": "Website Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"website_signup"
],
"type": "string",
"x-value": "website_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the contact through a website page."
},
{
"type": "object",
"title": "Landing Page Signup",
"properties": {
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"landing_page_signup"
],
"type": "string",
"x-value": "landing_page_signup",
"description": "The type of event activity."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a landing page."
},
{
"type": "object",
"title": "Ecommerce Signup",
"properties": {
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store."
},
"activity_type": {
"enum": [
"ecommerce_signup"
],
"type": "string",
"x-value": "ecommerce_signup",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item to representing a contact signing up for the list via a ecommerce store."
},
{
"type": "object",
"title": "Generic Signup",
"properties": {
"activity_type": {
"enum": [
"generic_signup"
],
"type": "string",
"x-value": "generic_signup",
"description": "The type of event activity."
},
"signup_category": {
"type": "string",
"title": "Signup Category",
"description": "How was this user added to the list."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a contact signing up for the audience via a generic some generic method (specifically, one we can't link to)."
},
{
"type": "object",
"title": "Ecommerce Order",
"properties": {
"order_id": {
"type": "string",
"title": "Order ID",
"description": "The unique order id."
},
"order_url": {
"type": "string",
"title": "Order URL",
"description": "The order URL."
},
"store_name": {
"type": "string",
"title": "Store Name",
"description": "The name of the store for an order."
},
"order_items": {
"type": "array",
"items": {
"type": "object",
"title": "E-commerce Order Line Item",
"properties": {
"id": {
"type": "string",
"title": "Order Line Item Foreign ID",
"readOnly": true,
"description": "A unique identifier for an order line item."
},
"price": {
"type": "number",
"title": "Price",
"description": "The order line item price."
},
"_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."
},
"discount": {
"type": "number",
"title": "Discount",
"description": "The total discount amount applied to a line item."
},
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The order line item quantity."
},
"image_url": {
"type": "string",
"title": "Product Image URL",
"readOnly": true,
"description": "The image URL for a product."
},
"product_id": {
"type": "string",
"title": "Order Line Item Product Foreign ID",
"description": "A unique identifier for the product associated with an order line item."
},
"product_title": {
"type": "string",
"title": "Order Line Item Product Title",
"readOnly": true,
"description": "The name of the product for an order line item."
},
"product_variant_id": {
"type": "string",
"title": "Order Line Item Product Variant Foreign ID",
"description": "A unique identifier for the product variant associated with an order line item."
},
"product_variant_title": {
"type": "string",
"title": "Order Line Item Product Variant Title",
"readOnly": true,
"description": "The name of the product variant for an order line item."
}
},
"description": "Information about a specific order line."
},
"title": "Order Items",
"description": "An array of items that have been ordered."
},
"order_total": {
"type": "string",
"title": "Order Total",
"description": "The order total formatted as a string."
},
"outreach_id": {
"type": "string",
"title": "Outreach ID",
"description": "The outreach's unique id."
},
"activity_type": {
"enum": [
"order"
],
"type": "string",
"x-value": "order",
"description": "The type of event activity."
},
"outreach_type": {
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach that triggered the event."
},
"outreach_title": {
"type": "string",
"title": "Outreach Title",
"description": "The title of the outreach."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"type": "string",
"title": "Integration Platform",
"description": "The name of the integration platform this order originated through."
}
},
"description": "Activity feed item that represents an order."
},
{
"type": "object",
"title": "Contact Activity Event",
"properties": {
"event_name": {
"type": "string",
"title": "Event Name",
"description": "The name of the event."
},
"activity_type": {
"enum": [
"event"
],
"type": "string",
"x-value": "event",
"description": "The type of event activity."
},
"event_properties": {
"type": "array",
"items": {
"type": "string",
"x-skip-validation": true
},
"title": "Event Properties",
"description": "An arbitrary datastore containing properties for the given event."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item that represents a generic event."
},
{
"type": "object",
"title": "Survey response",
"properties": {
"survey_id": {
"type": "string",
"title": "Survey ID",
"description": "The survey's unique id."
},
"survey_title": {
"type": "string",
"title": "Survey Title",
"description": "The title of the survey."
},
"activity_type": {
"enum": [
"survey_response"
],
"type": "string",
"x-value": "survey_response",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Represents when a contact completes and submits a survey"
},
{
"type": "object",
"title": "SMS Bulk Sent",
"properties": {
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "The campaign's unique id."
},
"activity_type": {
"enum": [
"sms_bulk_sent"
],
"type": "string",
"x-value": "sms_bulk_sent",
"description": "The type of event activity."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the SMS campaign."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing an SMS campaign sent to the contact."
},
{
"type": "object",
"title": "Inbox Thread",
"properties": {
"id": {
"type": "string",
"title": "Thread ID",
"description": "The ID of the thread."
},
"thread_url": {
"type": "string",
"title": "Thread URL",
"description": "The url of the thread."
},
"activity_type": {
"enum": [
"inbox_thread"
],
"type": "string",
"x-value": "inbox_thread",
"description": "The type of event activity."
},
"thread_author": {
"type": "string",
"title": "Thread Author",
"description": "The author of the thread."
},
"thread_subject": {
"type": "string",
"title": "Thread Subject",
"description": "The subject of the thread."
},
"thread_direction": {
"enum": [
"INBOUND",
"OUTBOUND"
],
"type": "string",
"title": "Thread Direction",
"description": "The direction of the message noting if it is outbound or inbound."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
}
},
"description": "Activity feed item representing a thread located in Inbox."
},
{
"type": "object",
"title": "QBO Payment Link",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The QuickBooks payment link id."
},
"activity_type": {
"enum": [
"qbo_payment_link"
],
"type": "string",
"x-value": "qbo_payment_link",
"description": "The type of event activity."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"integration_platform": {
"enum": [
"quickbooks"
],
"type": "string",
"title": "Integration Platform",
"description": "The platform Mailchimp is integrated with."
},
"qbo_payment_external_id": {
"type": "string",
"title": "QBO Payment External ID",
"description": "The external QuickBooks payment id."
}
},
"description": "Activity feed item representing a payment link from QBO."
},
{
"type": "object",
"title": "Video Call Transcripts",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "The id for video call transcripts."
},
"activity_type": {
"enum": [
"video_call_transcripts"
],
"type": "string",
"x-value": "video_call_transcripts",
"description": "The type of event activity."
},
"expire_at_timestamp": {
"type": "string",
"title": "Expire At Timestamp",
"format": "date-time",
"description": "The Expire At timestamp in ISO8601."
},
"created_at_timestamp": {
"type": "string",
"title": "Created At Timestamp",
"format": "date-time",
"description": "The created at timestamp in ISO8601."
},
"scheduled_meeting_start_timestamp": {
"type": "string",
"title": "Scheduled Meeting Start Timestamp",
"format": "date-time",
"description": "The Scheduled Meeting Start timestamp in ISO8601."
}
},
"description": "Activity feed item representing a video call transcript."
}
],
"discriminator": {
"type": "string",
"propertyName": "activity_type"
}
},
"title": "Activity",
"readOnly": true,
"description": "An array of objects, each representing a contact event. There are multiple possible types, see the [activity schema documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#activity-schemas)."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
}
},
"description": "The member activity events for a given member."
}
ListsViewRecentActivitydefaultResponse
{
"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'."
}
PingHealthCheck200Response
{
"type": "object",
"title": "API health status",
"properties": {
"health_status": {
"type": "string",
"title": "API health status",
"example": "\"Everything's Chimpy!\"",
"readOnly": true,
"description": "This will return a constant string value if the request is successful. Ex. \"Everything's Chimpy!\""
}
},
"description": "API health status."
}
PingHealthCheckResponse
{
"type": "object",
"title": "API health status",
"properties": {
"health_status": {
"type": "string",
"title": "API health status",
"example": "\"Everything's Chimpy!\"",
"readOnly": true,
"description": "This will return a constant string value if the request is successful. Ex. \"Everything's Chimpy!\""
}
},
"description": "API health status."
}
PingHealthCheckdefaultResponse
{
"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'."
}
ReportingFacebookAdReport200Response
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"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."
}
}
}
]
}
ReportingFacebookAdReportResponse
{
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"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."
}
}
}
]
}
ReportingFacebookAdReportdefaultResponse
{
"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'."
}
ReportingGetLandingPageReport200Response
{
"type": "object",
"title": "Landing Page Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
ReportingGetLandingPageReportResponse
{
"type": "object",
"title": "Landing Page Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
ReportingGetLandingPageReportdefaultResponse
{
"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'."
}
ReportingGetSurveyReport200Response
{
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
}
ReportingGetSurveyReportResponse
{
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
}
ReportingGetSurveyReportdefaultResponse
{
"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'."
}
ReportingListFacebookAdsReports200Response
{
"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."
},
"facebook_ads": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"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."
}
}
}
]
}
}
},
"description": "A collection of Facebook ads."
}
ReportingListFacebookAdsReportsResponse
{
"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."
},
"facebook_ads": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID of an Outreach."
},
"name": {
"type": "string",
"title": "Name",
"description": "Title or name of an Outreach."
},
"type": {
"enum": [
"regular",
"email-touchpoint",
"plaintext",
"rss",
"reconfirm",
"variate",
"absplit",
"automation",
"facebook",
"google",
"autoresponder",
"transactional",
"page",
"website",
"social_post",
"survey",
"customer_journey",
"sms"
],
"type": "string",
"title": "Outreach Type",
"description": "The type of outreach this object is."
},
"status": {
"enum": [
"save",
"paused",
"schedule",
"scheduled",
"sending",
"sent",
"canceled",
"canceling",
"active",
"disconnected",
"somepaused",
"draft",
"completed",
"partialRejected",
"pending",
"rejected",
"published",
"unpublished"
],
"type": "string",
"title": "Outreach Status",
"description": "The status of this outreach."
},
"web_id": {
"type": "integer",
"title": "Web ID",
"description": "The ID used in the Mailchimp web application. For example, for a `regular` outreach, you can view this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"thumbnail": {
"type": "string",
"title": "Thumbnail",
"description": "The URL of the thumbnail for this outreach."
},
"recipients": {
"type": "object",
"title": "Recipients",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "High level audience information for who the outreach targets."
},
"start_time": {
"type": "string",
"title": "Start Time",
"format": "date-time",
"description": "The date and time the outreach was started in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"description": "The date and time the outreach was last updated in ISO 8601 format."
},
"canceled_at": {
"type": "string",
"title": "Canceled At",
"format": "date-time",
"description": "The date and time the outreach was canceled in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"description": "The date and time the outreach was created in ISO 8601 format."
},
"has_segment": {
"type": "boolean",
"title": "Has Segment",
"description": "If this outreach targets a segment of your audience."
},
"show_report": {
"type": "boolean",
"title": "Show Report",
"description": "Outreach report availability. Note: This property is hotly debated in what it _should_ convey. See [MCP-1371](https://jira.mailchimp.com/browse/MCP-1371) for more context."
},
"published_time": {
"type": "string",
"title": "Publish Time",
"format": "date-time",
"description": "The date and time the outreach was (or will be) published in ISO 8601 format."
},
"report_summary": {
"type": "object",
"title": "Report Summary",
"properties": {
"opens": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"visits": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"average_order_revenue": {
"type": "number"
}
}
},
"open_rate": {
"type": "number"
},
"click_rate": {
"type": "number"
},
"subscribes": {
"type": "integer"
},
"total_sent": {
"type": "integer"
},
"engagements": {
"type": "integer"
},
"impressions": {
"type": "number"
},
"unique_opens": {
"type": "integer"
},
"unique_visits": {
"type": "integer"
},
"conversion_rate": {
"type": "number"
},
"subscriber_clicks": {
"type": "integer"
}
},
"description": "High level reporting stats for an outreach."
}
}
},
{
"type": "object",
"properties": {
"end_time": {
"type": "string",
"title": "Ad: End Time",
"format": "date-time",
"description": "The date and time the ad was ended in ISO 8601 format."
},
"paused_at": {
"type": "string",
"title": "Ad: Paused At",
"format": "date-time",
"description": "The date and time the ad was paused in ISO 8601 format."
},
"needs_attention": {
"type": "boolean",
"title": "Ad: Needs Attention",
"description": "If the ad has a problem and needs attention."
},
"email_source_name": {
"type": "string",
"title": "Ad: Email Source Name"
},
"was_canceled_by_facebook": {
"type": "boolean",
"title": "Ad: Was Canceled By Facebook"
}
}
},
{
"type": "object",
"properties": {
"budget": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"example": 86400,
"description": "Duration of the ad in seconds"
},
"total_amount": {
"type": "number",
"example": 500,
"description": "Total budget of the ad"
},
"currency_code": {
"type": "string",
"example": "USD",
"description": "Currency code"
}
}
},
"channel": {
"type": "object",
"properties": {
"fb_placement_feed": {
"type": "boolean",
"example": true,
"description": "Is this for facebook feed"
},
"ig_placement_feed": {
"type": "boolean",
"example": false,
"description": "Is this for instagram feed"
},
"fb_placement_audience": {
"type": "boolean",
"example": false,
"description": "Is this for facebook audience"
}
},
"description": "Channel settings"
},
"audience": {
"type": "object",
"properties": {
"type": {
"enum": [
"Custom Audience",
"Lookalike Audience",
"Interest-based Audience"
],
"type": "string",
"description": "Type of the audience"
},
"source_type": {
"enum": [
"facebook",
"list"
],
"type": "string",
"description": "List or Facebook based audience"
},
"email_source": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Email source name"
},
"type": {
"type": "string",
"description": "Type of the email source"
},
"list_name": {
"type": "string",
"description": "Associated list name to the source"
},
"is_segment": {
"type": "boolean",
"description": "Is the source reference a segment"
},
"segment_type": {
"type": "string",
"description": "Segment type if this source is tied to a segment"
}
}
},
"targeting_specs": {
"type": "object",
"properties": {
"gender": {
"enum": [
0,
1,
2
],
"type": "integer"
},
"max_age": {
"type": "integer"
},
"min_age": {
"type": "integer"
},
"interests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
},
"locations": {
"type": "object",
"properties": {
"zips": {
"type": "array",
"items": {
"type": "string"
}
},
"cities": {
"type": "array",
"items": {
"type": "string"
}
},
"regions": {
"type": "array",
"items": {
"type": "string"
}
},
"countries": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"lookalike_country_code": {
"type": "string",
"description": "To find similar audience in given country"
},
"include_source_in_target": {
"type": "boolean",
"description": "To include list contacts as part of audience"
}
},
"description": "Audience settings"
},
"report_summary": {
"type": "object",
"properties": {
"likes": {
"type": "integer"
},
"reach": {
"type": "integer"
},
"clicks": {
"type": "integer"
},
"shares": {
"type": "integer"
},
"comments": {
"type": "integer"
},
"ecommerce": {
"type": "object",
"properties": {
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
}
}
},
"click_rate": {
"type": "number"
},
"extended_at": {
"type": "object",
"properties": {
"datetime": {
"type": "string"
},
"timezone": {
"type": "string"
}
}
},
"impressions": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"unique_clicks": {
"type": "integer"
},
"cost_per_click": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"first_time_buyers": {
"type": "integer"
},
"total_products_sold": {
"type": "integer"
},
"average_daily_budget": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"average_order_amount": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"currency_code": {
"type": "string"
}
}
},
"return_on_investment": {
"type": "number"
},
"has_extended_ad_duration": {
"type": "boolean"
}
},
"description": "Report summary of facebook ad"
},
"audience_activity": {
"type": "object",
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"clicks": {
"type": "integer"
}
}
}
},
"revenue": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revenue": {
"type": "number"
}
}
}
},
"impressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"impressions": {
"type": "integer"
}
}
}
}
}
}
}
},
{
"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."
}
}
}
]
}
}
},
"description": "A collection of Facebook ads."
}
ReportingListFacebookAdsReportsdefaultResponse
{
"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'."
}
ReportingListFacebookEcommerceReport200Response
{
"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."
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"image_url": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"total_purchased": {
"type": "number"
},
"recommendation_total": {
"type": "integer"
},
"recommendation_purchased": {
"type": "integer"
}
}
}
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of ecommerce products."
}
ReportingListFacebookEcommerceReportResponse
{
"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."
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"image_url": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"total_purchased": {
"type": "number"
},
"recommendation_total": {
"type": "integer"
},
"recommendation_purchased": {
"type": "integer"
}
}
}
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of ecommerce products."
}
ReportingListFacebookEcommerceReportdefaultResponse
{
"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'."
}
ReportingListLandingPagesReports200Response
{
"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 Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
}
},
"description": "A collection of landing pages."
}
ReportingListLandingPagesReportsResponse
{
"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 Report",
"properties": {
"id": {
"type": "string",
"title": "Landing Page ID",
"example": "00dfc2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this landing page."
},
"url": {
"type": "string",
"title": "Url",
"readOnly": true,
"description": "The landing page url."
},
"name": {
"type": "string",
"title": "Name",
"readOnly": true,
"description": "The name of this landing page the user will see."
},
"title": {
"type": "string",
"title": "Title",
"readOnly": true,
"description": "The name of the landing page the user's customers will see."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks to this landing pages."
},
"status": {
"type": "string",
"title": "Status",
"readOnly": true,
"description": "The status of the landing page."
},
"visits": {
"type": "integer",
"title": "Visits",
"readOnly": true,
"description": "The number of visits to this landing pages."
},
"web_id": {
"type": "integer",
"title": "Landing Page Web ID",
"example": 33345484,
"readOnly": true,
"description": "The ID used in the Mailchimp web application."
},
"list_id": {
"type": "string",
"title": "List Id",
"readOnly": true,
"description": "The list id connected to this landing page."
},
"ecommerce": {
"type": "object",
"properties": {
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total number of orders associated with this landing page."
},
"currency_code": {
"type": "string",
"title": "Currency code",
"readOnly": true,
"description": "The user's currency code."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue of this landing page."
},
"average_order_revenue": {
"type": "number",
"title": "Average Order Revenue",
"readOnly": true,
"description": "The average order revenue of this landing page."
}
}
},
"list_name": {
"type": "string",
"title": "List Name",
"example": "Test List",
"readOnly": true,
"description": "List Name"
},
"subscribes": {
"type": "integer",
"title": "Subscribes",
"readOnly": true,
"description": "The number of subscribes to this landing pages."
},
"timeseries": {
"type": "object",
"properties": {
"daily_stats": {
"type": "object",
"title": "Daily clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 13,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks"
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 11,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits"
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last seven days."
},
"weekly_stats": {
"type": "object",
"title": "Weekly clicks and visits data",
"readOnly": true,
"properties": {
"clicks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 23,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Clicks",
"description": "The total number of clicks in a week."
},
"visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 49,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Visits",
"description": "The total number of visits in a week."
},
"unique_visits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"val": {
"type": "integer",
"title": "Value",
"example": 1,
"readOnly": true
},
"date": {
"type": "string",
"title": "Date",
"example": "2018-04-25",
"readOnly": true
}
}
},
"title": "Unique Visits"
}
},
"description": "The clicks and visits data from the last five weeks."
}
}
},
"signup_tags": {
"type": "array",
"items": {
"type": "object",
"title": "Tag",
"properties": {
"tag_id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The unique id for the tag."
},
"tag_name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag."
}
}
},
"title": "Signup Tags",
"readOnly": true,
"description": "A list of tags associated to the landing page."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was published."
},
"unique_visits": {
"type": "integer",
"title": "Unique Visits",
"readOnly": true,
"description": "The number of unique visits to this landing pages."
},
"unpublished_at": {
"type": "string",
"title": "Unpublished At",
"format": "date-time",
"readOnly": true,
"description": "The time this landing page was unpublished."
},
"conversion_rate": {
"type": "number",
"title": "Conversion rate",
"readOnly": true,
"description": "The percentage of people who visited your landing page and were added to your list."
}
},
"description": "A summary of an individual landing page's settings and content."
}
}
},
"description": "A collection of landing pages."
}
ReportingListLandingPagesReportsdefaultResponse
{
"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'."
}
ReportingListSurveyQuestionsReports200Response
{
"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."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Option ID",
"description": "The ID for this survey question option."
},
"count": {
"type": "integer",
"title": "Response Count",
"description": "The count of responses that selected this survey question option."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"known": {
"type": "integer",
"title": "Known Contacts Count",
"description": "The number of known contacts that responded to this survey."
},
"unknown": {
"type": "integer",
"title": "Unknown Contacts Count",
"description": "The number of unknown contacts that responded to this survey."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
},
"title": "Question Reports",
"description": "An array of reports for each question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyQuestionsReportsResponse
{
"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."
},
"questions": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Option ID",
"description": "The ID for this survey question option."
},
"count": {
"type": "integer",
"title": "Response Count",
"description": "The count of responses that selected this survey question option."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"known": {
"type": "integer",
"title": "Known Contacts Count",
"description": "The number of known contacts that responded to this survey."
},
"unknown": {
"type": "integer",
"title": "Unknown Contacts Count",
"description": "The number of unknown contacts that responded to this survey."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
},
"title": "Question Reports",
"description": "An array of reports for each question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyQuestionsReportsdefaultResponse
{
"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'."
}
ReportingListSurveyReports200Response
{
"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."
},
"surveys": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
},
"title": "Surveys",
"description": "The surveys that have reports available."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyReportsResponse
{
"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."
},
"surveys": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Report",
"properties": {
"id": {
"type": "string",
"title": "Survey ID",
"example": "040d2c2e1f0",
"readOnly": true,
"description": "A string that uniquely identifies this survey."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the survey."
},
"title": {
"type": "string",
"title": "Title",
"example": "New product ideas",
"readOnly": true,
"description": "The title of the survey."
},
"status": {
"enum": [
"published",
"unpublished"
],
"type": "string",
"title": "Status",
"example": "published",
"readOnly": true,
"description": "The survey's status."
},
"web_id": {
"type": "integer",
"title": "Survey Web ID",
"example": 165,
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The ID of the list connected to this survey."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list connected to this survey."
},
"created_at": {
"type": "string",
"title": "Created At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was created in ISO 8601 format."
},
"updated_at": {
"type": "string",
"title": "Updated At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was last updated in ISO 8601 format."
},
"published_at": {
"type": "string",
"title": "Published At",
"format": "date-time",
"example": "2017-08-04T11:09:01+00:00",
"readOnly": true,
"description": "The date and time the survey was published in ISO 8601 format."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this survey."
}
},
"description": "The report for a survey."
},
"title": "Surveys",
"description": "The surveys that have reports available."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingListSurveyReportsdefaultResponse
{
"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'."
}
ReportingSingleSurveyResponse200Response
{
"type": "object",
"title": "Survey Response",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"results": {
"type": "array",
"items": {
"type": "object",
"title": "Response",
"properties": {
"query": {
"type": "string",
"title": "Question Query",
"description": "The survey question."
},
"answer": {
"type": "string",
"title": "Answer",
"description": "The answer to this survey question."
},
"question_id": {
"type": "string",
"title": "Question ID",
"description": "The unique ID for this question."
},
"question_type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Question Type",
"description": "The type of question this is."
}
},
"description": "A single question and the response to that question."
},
"title": "Results",
"description": "The survey questions and the answers to those questions."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "A single survey response."
}
ReportingSingleSurveyResponseResponse
{
"type": "object",
"title": "Survey Response",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"results": {
"type": "array",
"items": {
"type": "object",
"title": "Response",
"properties": {
"query": {
"type": "string",
"title": "Question Query",
"description": "The survey question."
},
"answer": {
"type": "string",
"title": "Answer",
"description": "The answer to this survey question."
},
"question_id": {
"type": "string",
"title": "Question ID",
"description": "The unique ID for this question."
},
"question_type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Question Type",
"description": "The type of question this is."
}
},
"description": "A single question and the response to that question."
},
"title": "Results",
"description": "The survey questions and the answers to those questions."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "A single survey response."
}
ReportingSingleSurveyResponsedefaultResponse
{
"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'."
}
ReportingSurveyQuestionAnswersList200Response
{
"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."
},
"answers": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Answer",
"properties": {
"id": {
"type": "string",
"title": "Answer ID",
"readOnly": true,
"description": "The ID of the answer."
},
"value": {
"type": "string",
"title": "Value",
"readOnly": true,
"description": "The raw text answer."
},
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID of the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "The details of a survey question's answer."
},
"title": "Answers",
"description": "An array of answers for a question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyQuestionAnswersListResponse
{
"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."
},
"answers": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Question Answer",
"properties": {
"id": {
"type": "string",
"title": "Answer ID",
"readOnly": true,
"description": "The ID of the answer."
},
"value": {
"type": "string",
"title": "Value",
"readOnly": true,
"description": "The raw text answer."
},
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID of the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "The details of a survey question's answer."
},
"title": "Answers",
"description": "An array of answers for a question on the survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyQuestionAnswersListdefaultResponse
{
"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'."
}
ReportingSurveyQuestionReport200Response
{
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Option ID",
"description": "The ID for this survey question option."
},
"count": {
"type": "integer",
"title": "Response Count",
"description": "The count of responses that selected this survey question option."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"known": {
"type": "integer",
"title": "Known Contacts Count",
"description": "The number of known contacts that responded to this survey."
},
"unknown": {
"type": "integer",
"title": "Unknown Contacts Count",
"description": "The number of unknown contacts that responded to this survey."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
}
ReportingSurveyQuestionReportResponse
{
"type": "object",
"title": "Survey Question Report",
"properties": {
"id": {
"type": "string",
"title": "Survey Question ID",
"readOnly": true,
"description": "The ID of the survey question."
},
"type": {
"enum": [
"pickOne",
"pickMany",
"range",
"text",
"email"
],
"type": "string",
"title": "Response Type",
"readOnly": true,
"description": "The response type of the survey question."
},
"query": {
"type": "string",
"title": "Query Text",
"readOnly": true,
"description": "The query of the survey question."
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Option ID",
"description": "The ID for this survey question option."
},
"count": {
"type": "integer",
"title": "Response Count",
"description": "The count of responses that selected this survey question option."
},
"label": {
"type": "string",
"title": "Option Label",
"description": "The label for this survey question option."
}
}
},
"title": "Options",
"readOnly": true,
"description": "The answer choices for this question."
},
"has_other": {
"type": "boolean",
"title": "Has Other Option",
"readOnly": true,
"description": "Whether this survey question has an 'other' option."
},
"survey_id": {
"type": "string",
"title": "Survey ID",
"readOnly": true,
"description": "The unique ID of the survey."
},
"is_required": {
"type": "boolean",
"title": "Is Required",
"readOnly": true,
"description": "Whether this survey question is required to answer."
},
"merge_field": {
"type": "object",
"title": "Merge Field",
"readOnly": true,
"properties": {
"id": {
"type": "integer",
"title": "Merge Field ID",
"readOnly": true,
"description": "An unchanging id for the merge field."
},
"type": {
"enum": [
"text",
"number",
"address",
"phone",
"date",
"url",
"imageurl",
"radio",
"dropdown",
"birthday",
"zip"
],
"type": "string",
"title": "Merge Field Type",
"readOnly": true,
"description": "The [type](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
},
"label": {
"type": "string",
"title": "Merge Field Label",
"readOnly": true,
"description": "The [label](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for the merge field."
}
},
"description": "A [merge field](https://mailchimp.com/developer/marketing/docs/merge-fields/) for an audience."
},
"other_label": {
"type": "string",
"title": "Other Option Label",
"readOnly": true,
"description": "Label used for the 'other' option of this survey question."
},
"average_rating": {
"type": "number",
"title": "Average Rating for a Range Question",
"format": "float",
"example": 2.5,
"readOnly": true,
"description": "The average rating for this range question."
},
"contact_counts": {
"type": "object",
"title": "Contact Counts",
"properties": {
"new": {
"type": "integer",
"title": "New Contacts Count",
"description": "The number of new contacts that responded to this survey."
},
"known": {
"type": "integer",
"title": "Known Contacts Count",
"description": "The number of known contacts that responded to this survey."
},
"unknown": {
"type": "integer",
"title": "Unknown Contacts Count",
"description": "The number of unknown contacts that responded to this survey."
}
},
"description": "For email question types, how many are new, known, or unknown contacts."
},
"range_low_label": {
"type": "string",
"title": "Range Low Label",
"readOnly": true,
"description": "Label for the low end of the range."
},
"total_responses": {
"type": "integer",
"title": "Total Responses",
"example": 810,
"readOnly": true,
"description": "The total number of responses to this question."
},
"range_high_label": {
"type": "string",
"title": "Range High Label",
"readOnly": true,
"description": "Label for the high end of the range."
},
"placeholder_label": {
"type": "string",
"title": "Placeholder Label",
"readOnly": true,
"description": "Placeholder text for this survey question's answer box."
},
"subscribe_checkbox_label": {
"type": "string",
"title": "Subscribe Checkbox Label",
"readOnly": true,
"description": "Label used for the subscribe checkbox for this email question."
},
"subscribe_checkbox_enabled": {
"type": "boolean",
"title": "Is Subscribe Checkbox Enabled",
"readOnly": true,
"description": "Whether the subscribe checkbox is shown for this email question."
}
},
"description": "The details of a survey question's report."
}
ReportingSurveyQuestionReportdefaultResponse
{
"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'."
}
ReportingSurveyResponsesList200Response
{
"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."
},
"responses": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Respondents",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "Survey respondent details."
},
"title": "Responses",
"description": "An array of responses to a survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyResponsesListResponse
{
"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."
},
"responses": {
"type": "array",
"items": {
"type": "object",
"title": "Survey Respondents",
"properties": {
"contact": {
"type": "object",
"title": "Contact",
"readOnly": true,
"properties": {
"email": {
"type": "string",
"title": "Contact Email",
"readOnly": true,
"description": "The contact's email address."
},
"phone": {
"type": "string",
"title": "Contact SMS Phone",
"readOnly": true,
"description": "The contact's sms phone number."
},
"status": {
"enum": [
"Subscribed",
"Unsubscribed",
"Non-Subscribed",
"Cleaned",
"Archived"
],
"type": "string",
"title": "Contact Status",
"readOnly": true,
"description": "The contact's current status."
},
"email_id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL for the contact's avatar or profile image."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "The ID of this contact."
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Information about the contact."
},
"response_id": {
"type": "string",
"title": "Response ID",
"readOnly": true,
"description": "The ID for the survey response."
},
"submitted_at": {
"type": "string",
"title": "Submitted At",
"format": "date-time",
"readOnly": true,
"description": "The date and time when the survey response was submitted in ISO 8601 format."
},
"is_new_contact": {
"type": "boolean",
"title": "Is New Contact",
"readOnly": false,
"description": "If this contact was added to the Mailchimp audience via this survey."
}
},
"description": "Survey respondent details."
},
"title": "Responses",
"description": "An array of responses to a survey."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
}
}
ReportingSurveyResponsesListdefaultResponse
{
"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'."
}
ReportsCampaignRecipientInfo200Response
{
"type": "object",
"title": "Sent To",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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": [
"sent",
"hard",
"soft"
],
"type": "string",
"title": "Delivery Status",
"description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/)."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open for this member in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"open_count": {
"type": "integer",
"title": "Open Count",
"description": "The number of times a campaign was opened by this member."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"absplit_group": {
"enum": [
"a",
"b",
"winner"
],
"type": "string",
"title": "A/B Split Group",
"description": "For A/B Split Campaigns, the group the member was apart of."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber's status for a specific campaign."
}
ReportsCampaignRecipientInfoResponse
{
"type": "object",
"title": "Sent To",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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": [
"sent",
"hard",
"soft"
],
"type": "string",
"title": "Delivery Status",
"description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/)."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open for this member in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"open_count": {
"type": "integer",
"title": "Open Count",
"description": "The number of times a campaign was opened by this member."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"absplit_group": {
"enum": [
"a",
"b",
"winner"
],
"type": "string",
"title": "A/B Split Group",
"description": "For A/B Split Campaigns, the group the member was apart of."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber's status for a specific campaign."
}
ReportsCampaignRecipientInfodefaultResponse
{
"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'."
}
ReportsGetAbuseReport200Response
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ReportsGetAbuseReportResponse
{
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
}
ReportsGetAbuseReportdefaultResponse
{
"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'."
}
ReportsGetCampaignClickDetails200Response
{
"type": "object",
"title": "Click Detail Report",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"urls_clicked": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Report",
"properties": {
"id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The unique id for the link."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the link in the campaign."
},
"_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."
},
"ab_split": {
"type": "object",
"title": "A/B Split",
"properties": {
"a": {
"type": "object",
"title": "Group A",
"properties": {
"total_clicks_a": {
"type": "integer",
"title": "Total Clicks Group A",
"readOnly": true,
"description": "The total number of clicks for Group A."
},
"unique_clicks_a": {
"type": "integer",
"title": "Unique Clicks Group A",
"readOnly": true,
"description": "The number of unique clicks for Group A."
},
"click_percentage_a": {
"type": "number",
"title": "Click Percentage Group A",
"readOnly": true,
"description": "The percentage of total clicks for Group A."
},
"unique_click_percentage_a": {
"type": "number",
"title": "Unique Click Percentage Group A",
"readOnly": true,
"description": "The percentage of unique clicks for Group A."
}
},
"description": "Stats for Group A."
},
"b": {
"type": "object",
"title": "Group B",
"properties": {
"total_clicks_b": {
"type": "integer",
"title": "Total Clicks Group B",
"readOnly": true,
"description": "The total number of clicks for Group B."
},
"unique_clicks_b": {
"type": "integer",
"title": "Unique Clicks Group B",
"readOnly": true,
"description": "The number of unique clicks for Group B."
},
"click_percentage_b": {
"type": "number",
"title": "Click Percentage Group B",
"readOnly": true,
"description": "The percentage of total clicks for Group B."
},
"unique_click_percentage_b": {
"type": "number",
"title": "Unique Click Percentage Group B",
"readOnly": true,
"description": "The percentage of unique clicks for Group B."
}
},
"description": "Stats for Group B."
}
},
"description": "A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The date and time for the last recorded click for a link in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The number of total clicks for a link."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"readOnly": true,
"description": "Number of unique clicks for a link."
},
"click_percentage": {
"type": "number",
"title": "Click Percentage",
"readOnly": true,
"description": "The percentage of total clicks a link generated for a campaign."
},
"unique_click_percentage": {
"type": "number",
"title": "Unique Click Percentage",
"readOnly": true,
"description": "The percentage of unique clicks a link generated for a campaign."
}
},
"description": "A report of links clicked in a specific campaign."
},
"title": "URLs Clicked",
"description": "An array of objects, each representing a specific URL contained in the campaign."
}
},
"description": "A list of URLs and unique IDs included in HTML and plain-text versions of a campaign."
}
ReportsGetCampaignClickDetailsResponse
{
"type": "object",
"title": "Click Detail Report",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"urls_clicked": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Report",
"properties": {
"id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The unique id for the link."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the link in the campaign."
},
"_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."
},
"ab_split": {
"type": "object",
"title": "A/B Split",
"properties": {
"a": {
"type": "object",
"title": "Group A",
"properties": {
"total_clicks_a": {
"type": "integer",
"title": "Total Clicks Group A",
"readOnly": true,
"description": "The total number of clicks for Group A."
},
"unique_clicks_a": {
"type": "integer",
"title": "Unique Clicks Group A",
"readOnly": true,
"description": "The number of unique clicks for Group A."
},
"click_percentage_a": {
"type": "number",
"title": "Click Percentage Group A",
"readOnly": true,
"description": "The percentage of total clicks for Group A."
},
"unique_click_percentage_a": {
"type": "number",
"title": "Unique Click Percentage Group A",
"readOnly": true,
"description": "The percentage of unique clicks for Group A."
}
},
"description": "Stats for Group A."
},
"b": {
"type": "object",
"title": "Group B",
"properties": {
"total_clicks_b": {
"type": "integer",
"title": "Total Clicks Group B",
"readOnly": true,
"description": "The total number of clicks for Group B."
},
"unique_clicks_b": {
"type": "integer",
"title": "Unique Clicks Group B",
"readOnly": true,
"description": "The number of unique clicks for Group B."
},
"click_percentage_b": {
"type": "number",
"title": "Click Percentage Group B",
"readOnly": true,
"description": "The percentage of total clicks for Group B."
},
"unique_click_percentage_b": {
"type": "number",
"title": "Unique Click Percentage Group B",
"readOnly": true,
"description": "The percentage of unique clicks for Group B."
}
},
"description": "Stats for Group B."
}
},
"description": "A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The date and time for the last recorded click for a link in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The number of total clicks for a link."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"readOnly": true,
"description": "Number of unique clicks for a link."
},
"click_percentage": {
"type": "number",
"title": "Click Percentage",
"readOnly": true,
"description": "The percentage of total clicks a link generated for a campaign."
},
"unique_click_percentage": {
"type": "number",
"title": "Unique Click Percentage",
"readOnly": true,
"description": "The percentage of unique clicks a link generated for a campaign."
}
},
"description": "A report of links clicked in a specific campaign."
},
"title": "URLs Clicked",
"description": "An array of objects, each representing a specific URL contained in the campaign."
}
},
"description": "A list of URLs and unique IDs included in HTML and plain-text versions of a campaign."
}
ReportsGetCampaignClickDetailsdefaultResponse
{
"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'."
}
ReportsGetCampaignProductActivity200Response
{
"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."
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"image_url": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"total_purchased": {
"type": "number"
},
"recommendation_total": {
"type": "integer"
},
"recommendation_purchased": {
"type": "integer"
}
}
}
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of ecommerce products."
}
ReportsGetCampaignProductActivityResponse
{
"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."
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"image_url": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"total_revenue": {
"type": "number"
},
"total_purchased": {
"type": "number"
},
"recommendation_total": {
"type": "integer"
},
"recommendation_purchased": {
"type": "integer"
}
}
}
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of ecommerce products."
}
ReportsGetCampaignProductActivitydefaultResponse
{
"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'."
}
ReportsGetSubscriberActivity200Response
{
"type": "object",
"title": "Email Activity",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
}
ReportsGetSubscriberActivityResponse
{
"type": "object",
"title": "Email Activity",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
}
ReportsGetSubscriberActivitydefaultResponse
{
"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'."
}
ReportsGetUnsubscribedMemberInfo200Response
{
"type": "object",
"title": "Unsubscribes",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A member who unsubscribed from a specific campaign."
}
ReportsGetUnsubscribedMemberInfoResponse
{
"type": "object",
"title": "Unsubscribes",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A member who unsubscribed from a specific campaign."
}
ReportsGetUnsubscribedMemberInfodefaultResponse
{
"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'."
}
ReportsListAbuseReports200Response
{
"type": "object",
"title": "Abuse Complaints",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A list of abuse complaints for a specific list."
}
ReportsListAbuseReportsResponse
{
"type": "object",
"title": "Abuse Complaints",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"abuse_reports": {
"type": "array",
"items": {
"type": "object",
"title": "Abuse Complaint",
"properties": {
"id": {
"type": "integer",
"title": "Abuse Report ID",
"readOnly": true,
"description": "The id for the abuse report"
},
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"date": {
"type": "string",
"title": "Date",
"format": "date-time",
"readOnly": true,
"description": "Date for the abuse report"
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id of the list for the abuse report."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id for the abuse report"
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "Details of abuse complaints for a specific list. An abuse complaint occurs when your recipient clicks to 'report spam' in their email program."
},
"title": "Abuse Reports",
"description": "An array of objects, each representing an abuse report resource."
}
},
"description": "A list of abuse complaints for a specific list."
}
ReportsListAbuseReportsdefaultResponse
{
"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'."
}
ReportsListCampaignFeedback200Response
{
"type": "object",
"title": "Campaign Advice Report",
"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."
},
"advice": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Advice",
"properties": {
"type": {
"enum": [
"negative",
"positive",
"neutral"
],
"type": "string",
"title": "Advice Type",
"readOnly": true,
"description": "The sentiment type for a feedback message."
},
"_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."
},
"message": {
"type": "string",
"title": "Advice Message",
"readOnly": true,
"description": "The advice message."
}
},
"description": "Campaign feedback details."
},
"title": "Campaign Advice",
"description": "An array of objects, each representing a point of campaign feedback."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"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 feedback based on a campaign's statistics."
}
ReportsListCampaignFeedbackResponse
{
"type": "object",
"title": "Campaign Advice Report",
"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."
},
"advice": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Advice",
"properties": {
"type": {
"enum": [
"negative",
"positive",
"neutral"
],
"type": "string",
"title": "Advice Type",
"readOnly": true,
"description": "The sentiment type for a feedback message."
},
"_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."
},
"message": {
"type": "string",
"title": "Advice Message",
"readOnly": true,
"description": "The advice message."
}
},
"description": "Campaign feedback details."
},
"title": "Campaign Advice",
"description": "An array of objects, each representing a point of campaign feedback."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"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 feedback based on a campaign's statistics."
}
ReportsListCampaignFeedbackdefaultResponse
{
"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'."
}
ReportsListCampaignOpenDetails200Response
{
"type": "object",
"title": "Open Detail Report",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Open Activity",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"opens": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Time series data of opens activity",
"description": "An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"opens_count": {
"type": "integer",
"title": "Opens count",
"readOnly": true,
"description": "The total number of times the this campaign was opened by the list member."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's opens activity in a specific campaign."
},
"title": "Open Reports",
"description": "An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"total_opens": {
"type": "integer",
"title": "Total opens",
"description": "The total number of opens matching the query regardless of pagination."
}
},
"description": "A detailed report of any campaign emails that were opened by a list member."
}
ReportsListCampaignOpenDetailsResponse
{
"type": "object",
"title": "Open Detail Report",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Open Activity",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"opens": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Time series data of opens activity",
"description": "An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"opens_count": {
"type": "integer",
"title": "Opens count",
"readOnly": true,
"description": "The total number of times the this campaign was opened by the list member."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's opens activity in a specific campaign."
},
"title": "Open Reports",
"description": "An array of objects, each representing a list member who opened a campaign email. Each members object will contain information about the number of total opens by a single member, as well as timestamps for each open event."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"total_opens": {
"type": "integer",
"title": "Total opens",
"description": "The total number of opens matching the query regardless of pagination."
}
},
"description": "A detailed report of any campaign emails that were opened by a list member."
}
ReportsListCampaignOpenDetailsdefaultResponse
{
"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'."
}
ReportsListCampaignRecipients200Response
{
"type": "object",
"title": "Sent-To",
"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."
},
"sent_to": {
"type": "array",
"items": {
"type": "object",
"title": "Sent To",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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": [
"sent",
"hard",
"soft"
],
"type": "string",
"title": "Delivery Status",
"description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/)."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open for this member in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"open_count": {
"type": "integer",
"title": "Open Count",
"description": "The number of times a campaign was opened by this member."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"absplit_group": {
"enum": [
"a",
"b",
"winner"
],
"type": "string",
"title": "A/B Split Group",
"description": "For A/B Split Campaigns, the group the member was apart of."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber's status for a specific campaign."
},
"title": "Sent To",
"description": "An array of objects, each representing a campaign recipient."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"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 subscribers who were sent a specific campaign."
}
ReportsListCampaignRecipientsResponse
{
"type": "object",
"title": "Sent-To",
"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."
},
"sent_to": {
"type": "array",
"items": {
"type": "object",
"title": "Sent To",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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": [
"sent",
"hard",
"soft"
],
"type": "string",
"title": "Delivery Status",
"description": "The status of the email delivered to this subscriber. `hard` and `soft` refer to different [bounce types](https://mailchimp.com/help/soft-vs-hard-bounces/)."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open for this member in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"open_count": {
"type": "integer",
"title": "Open Count",
"description": "The number of times a campaign was opened by this member."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"absplit_group": {
"enum": [
"a",
"b",
"winner"
],
"type": "string",
"title": "A/B Split Group",
"description": "For A/B Split Campaigns, the group the member was apart of."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber's status for a specific campaign."
},
"title": "Sent To",
"description": "An array of objects, each representing a campaign recipient."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"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 subscribers who were sent a specific campaign."
}
ReportsListCampaignRecipientsdefaultResponse
{
"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'."
}
ReportsListCampaignReports200Response
{
"type": "object",
"title": "Campaign Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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."
},
"clicks": {
"type": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a report resource."
},
"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 reports containing campaigns marked as Sent."
}
ReportsListCampaignReportsResponse
{
"type": "object",
"title": "Campaign Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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."
},
"clicks": {
"type": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a report resource."
},
"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 reports containing campaigns marked as Sent."
}
ReportsListCampaignReportsdefaultResponse
{
"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'."
}
ReportsListChildCampaignReports200Response
{
"type": "object",
"title": "Campaign Sub-Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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."
},
"clicks": {
"type": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Reports",
"description": "An array of objects, each representing a report resource."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "Unique identifier of the parent campaign"
},
"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 reports containing child campaigns for a specific campaign."
}
ReportsListChildCampaignReportsResponse
{
"type": "object",
"title": "Campaign Sub-Reports",
"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."
},
"reports": {
"type": "array",
"items": {
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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."
},
"clicks": {
"type": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
},
"title": "Reports",
"description": "An array of objects, each representing a report resource."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"description": "Unique identifier of the parent campaign"
},
"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 reports containing child campaigns for a specific campaign."
}
ReportsListChildCampaignReportsdefaultResponse
{
"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'."
}
ReportsListClickedLinkSubscribers200Response
{
"type": "object",
"title": "Click Detail Members",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Member",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of times the subscriber clicked on the link."
},
"url_id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The id for the tracked URL in the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber who clicked a specific URL in a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who clicked a specific link within a campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of members who clicked on a specific link within a campaign."
}
ReportsListClickedLinkSubscribersResponse
{
"type": "object",
"title": "Click Detail Members",
"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."
},
"members": {
"type": "array",
"items": {
"type": "object",
"title": "Click Detail Member",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of times the subscriber clicked on the link."
},
"url_id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The id for the tracked URL in the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber who clicked a specific URL in a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who clicked a specific link within a campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A collection of members who clicked on a specific link within a campaign."
}
ReportsListClickedLinkSubscribersdefaultResponse
{
"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'."
}
ReportsListDomainPerformanceStats200Response
{
"type": "object",
"title": "Domain Performance",
"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."
},
"domains": {
"type": "array",
"items": {
"type": "object",
"title": "Email Domain",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of opens for a domain."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks for a domain."
},
"domain": {
"type": "string",
"title": "Domain",
"readOnly": true,
"description": "The name of the domain (gmail.com, hotmail.com, yahoo.com)."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"readOnly": true,
"description": "The total number of unsubscribes for a domain."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"readOnly": true,
"description": "The number of bounces at a domain."
},
"delivered": {
"type": "integer",
"title": "Successful Deliveries",
"readOnly": true,
"description": "The number of successful deliveries for a domain."
},
"opens_pct": {
"type": "number",
"title": "Opens Percent",
"readOnly": true,
"description": "The percentage of total opens from this domain."
},
"clicks_pct": {
"type": "number",
"title": "Clicks Percent",
"readOnly": true,
"description": "The percentage of total clicks from this domain."
},
"emails_pct": {
"type": "number",
"title": "Email Percent",
"readOnly": true,
"description": "The percentage of total emails that went to this domain."
},
"unsubs_pct": {
"type": "number",
"title": "Unsubscribes Percent",
"readOnly": true,
"description": "The percentage of total unsubscribes from this domain."
},
"bounces_pct": {
"type": "number",
"title": "Bounces Percent",
"readOnly": true,
"description": "The percentage of total bounces from this domain."
},
"emails_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The number of emails sent to that specific domain."
}
},
"description": "A single email domain's performance"
},
"title": "Lists",
"readOnly": true,
"description": "The top 5 email domains based on total delivered emails."
},
"total_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The total number of emails sent for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Statistics for the top-performing email domains in a campaign."
}
ReportsListDomainPerformanceStatsResponse
{
"type": "object",
"title": "Domain Performance",
"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."
},
"domains": {
"type": "array",
"items": {
"type": "object",
"title": "Email Domain",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of opens for a domain."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The number of clicks for a domain."
},
"domain": {
"type": "string",
"title": "Domain",
"readOnly": true,
"description": "The name of the domain (gmail.com, hotmail.com, yahoo.com)."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"readOnly": true,
"description": "The total number of unsubscribes for a domain."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"readOnly": true,
"description": "The number of bounces at a domain."
},
"delivered": {
"type": "integer",
"title": "Successful Deliveries",
"readOnly": true,
"description": "The number of successful deliveries for a domain."
},
"opens_pct": {
"type": "number",
"title": "Opens Percent",
"readOnly": true,
"description": "The percentage of total opens from this domain."
},
"clicks_pct": {
"type": "number",
"title": "Clicks Percent",
"readOnly": true,
"description": "The percentage of total clicks from this domain."
},
"emails_pct": {
"type": "number",
"title": "Email Percent",
"readOnly": true,
"description": "The percentage of total emails that went to this domain."
},
"unsubs_pct": {
"type": "number",
"title": "Unsubscribes Percent",
"readOnly": true,
"description": "The percentage of total unsubscribes from this domain."
},
"bounces_pct": {
"type": "number",
"title": "Bounces Percent",
"readOnly": true,
"description": "The percentage of total bounces from this domain."
},
"emails_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The number of emails sent to that specific domain."
}
},
"description": "A single email domain's performance"
},
"title": "Lists",
"readOnly": true,
"description": "The top 5 email domains based on total delivered emails."
},
"total_sent": {
"type": "integer",
"title": "Total Sent",
"readOnly": true,
"description": "The total number of emails sent for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Statistics for the top-performing email domains in a campaign."
}
ReportsListDomainPerformanceStatsdefaultResponse
{
"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'."
}
ReportsListEepurlActivity200Response
{
"type": "object",
"title": "Eepurl Activity",
"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."
},
"clicks": {
"type": "object",
"title": "Click Summary",
"readOnly": true,
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The total number of clicks to the campaign's URL."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"title": "Location",
"properties": {
"region": {
"type": "string",
"title": "Region",
"example": "NY",
"description": "If available, a specific region where the click was recorded."
},
"country": {
"type": "string",
"title": "Country",
"description": "The two-digit country code for a recorded click."
}
},
"description": "An individual click location."
},
"title": "Click Locations",
"readOnly": true,
"description": "A summary of the top click locations."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the last click to the URL."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the first click to the URL."
}
},
"description": "A summary of the click-throughs on the campaign's URL."
},
"eepurl": {
"type": "string",
"title": "Eepurl",
"readOnly": true,
"description": "The shortened link used for tracking."
},
"twitter": {
"type": "object",
"title": "Twitter Stats",
"properties": {
"tweets": {
"type": "integer",
"title": "Tweet Count",
"readOnly": true,
"description": "The number of tweets including a link to the campaign."
},
"retweets": {
"type": "integer",
"title": "Retweet Count",
"readOnly": true,
"description": "The number of retweets that include a link to the campaign."
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"title": "Twitter Status",
"properties": {
"status": {
"type": "string",
"title": "Status Body",
"readOnly": true,
"description": "The body of the tweet."
},
"datetime": {
"type": "string",
"title": "Datetime",
"format": "date-time",
"readOnly": true,
"description": "A timestamp for the tweet."
},
"status_id": {
"type": "string",
"title": "Status ID",
"readOnly": true,
"description": "The individual id for the tweet."
},
"is_retweet": {
"type": "boolean",
"title": "Is Retweet",
"readOnly": true,
"description": "A 'true' or 'false' status of whether the tweet is a retweet."
},
"screen_name": {
"type": "string",
"title": "Screen Name",
"readOnly": true,
"description": "The Twitter handle for the author of the tweet."
}
},
"description": "An individual tweet."
},
"title": "Twitter Status",
"readOnly": true,
"description": "A summary of tweets that include a link to the campaign."
},
"last_tweet": {
"type": "string",
"title": "Last Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the last recorded tweet with a link to the campaign."
},
"first_tweet": {
"type": "string",
"title": "First Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the first recorded tweet with a link to the campaign."
}
},
"description": "A summary of Twitter activity for a campaign."
},
"referrers": {
"type": "array",
"items": {
"type": "object",
"title": "Referrer",
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks a single referrer generated."
},
"referrer": {
"type": "string",
"title": "Referrer",
"description": "A referrer (truncated to 100 bytes)."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The timestamp for the last click from this referrer."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"description": "The timestamp for the first click from this referrer."
}
},
"description": "A single instance of a campaign referral."
},
"title": "Referrers",
"x-title": "Referrers",
"readOnly": true,
"description": "A summary of the top referrers for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of social activity for the campaign, tracked by EepURL."
}
ReportsListEepurlActivityResponse
{
"type": "object",
"title": "Eepurl Activity",
"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."
},
"clicks": {
"type": "object",
"title": "Click Summary",
"readOnly": true,
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"readOnly": true,
"description": "The total number of clicks to the campaign's URL."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"title": "Location",
"properties": {
"region": {
"type": "string",
"title": "Region",
"example": "NY",
"description": "If available, a specific region where the click was recorded."
},
"country": {
"type": "string",
"title": "Country",
"description": "The two-digit country code for a recorded click."
}
},
"description": "An individual click location."
},
"title": "Click Locations",
"readOnly": true,
"description": "A summary of the top click locations."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the last click to the URL."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"readOnly": true,
"description": "The timestamp for the first click to the URL."
}
},
"description": "A summary of the click-throughs on the campaign's URL."
},
"eepurl": {
"type": "string",
"title": "Eepurl",
"readOnly": true,
"description": "The shortened link used for tracking."
},
"twitter": {
"type": "object",
"title": "Twitter Stats",
"properties": {
"tweets": {
"type": "integer",
"title": "Tweet Count",
"readOnly": true,
"description": "The number of tweets including a link to the campaign."
},
"retweets": {
"type": "integer",
"title": "Retweet Count",
"readOnly": true,
"description": "The number of retweets that include a link to the campaign."
},
"statuses": {
"type": "array",
"items": {
"type": "object",
"title": "Twitter Status",
"properties": {
"status": {
"type": "string",
"title": "Status Body",
"readOnly": true,
"description": "The body of the tweet."
},
"datetime": {
"type": "string",
"title": "Datetime",
"format": "date-time",
"readOnly": true,
"description": "A timestamp for the tweet."
},
"status_id": {
"type": "string",
"title": "Status ID",
"readOnly": true,
"description": "The individual id for the tweet."
},
"is_retweet": {
"type": "boolean",
"title": "Is Retweet",
"readOnly": true,
"description": "A 'true' or 'false' status of whether the tweet is a retweet."
},
"screen_name": {
"type": "string",
"title": "Screen Name",
"readOnly": true,
"description": "The Twitter handle for the author of the tweet."
}
},
"description": "An individual tweet."
},
"title": "Twitter Status",
"readOnly": true,
"description": "A summary of tweets that include a link to the campaign."
},
"last_tweet": {
"type": "string",
"title": "Last Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the last recorded tweet with a link to the campaign."
},
"first_tweet": {
"type": "string",
"title": "First Tweet Timestamp",
"readOnly": true,
"description": "The day and time of the first recorded tweet with a link to the campaign."
}
},
"description": "A summary of Twitter activity for a campaign."
},
"referrers": {
"type": "array",
"items": {
"type": "object",
"title": "Referrer",
"properties": {
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks a single referrer generated."
},
"referrer": {
"type": "string",
"title": "Referrer",
"description": "A referrer (truncated to 100 bytes)."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The timestamp for the last click from this referrer."
},
"first_click": {
"type": "string",
"title": "First Click",
"format": "date-time",
"description": "The timestamp for the first click from this referrer."
}
},
"description": "A single instance of a campaign referral."
},
"title": "Referrers",
"x-title": "Referrers",
"readOnly": true,
"description": "A summary of the top referrers for the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A summary of social activity for the campaign, tracked by EepURL."
}
ReportsListEepurlActivitydefaultResponse
{
"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'."
}
ReportsListEmailActivity200Response
{
"type": "object",
"title": "Email Activity",
"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."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Email Activity",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
},
"title": "Sent To",
"description": "An array of members that were sent the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the sent campaign."
},
"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 member's subscriber activity in a specific campaign."
}
ReportsListEmailActivityResponse
{
"type": "object",
"title": "Email Activity",
"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."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"title": "Email Activity",
"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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"activity": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"ip": {
"type": "string",
"title": "IP",
"description": "The IP address recorded for the action."
},
"url": {
"type": "string",
"title": "URL",
"description": "If the action is a 'click', the URL on which the member clicked."
},
"type": {
"type": "string",
"title": "Type",
"description": "If the action is a 'bounce', the type of bounce received: 'hard', 'soft'."
},
"action": {
"type": "string",
"title": "Action",
"description": "One of the following actions: 'open', 'click', or 'bounce'"
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Member Activity",
"description": "An array of objects, each showing an interaction with the email. Member activity limited to 1,000 open activities and 1,000 click activities per member per campaign."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's subscriber activity in a specific campaign, including opens, clicks, and bounces."
},
"title": "Sent To",
"description": "An array of members that were sent the campaign."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the sent campaign."
},
"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 member's subscriber activity in a specific campaign."
}
ReportsListEmailActivitydefaultResponse
{
"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'."
}
ReportsListTopOpenLocations200Response
{
"type": "object",
"title": "Open Locations",
"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."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of unique campaign opens for a region."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region."
},
"region_name": {
"type": "string",
"title": "Region Name",
"readOnly": true,
"description": "The name of the region, if we have one. For blank \"region\" values, this will be \"Rest of Country\"."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The ISO 3166 2 digit country code."
}
}
},
"title": "Lists",
"description": "An array of objects, each representing a top location for opens."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Top open locations for a specific campaign."
}
ReportsListTopOpenLocationsResponse
{
"type": "object",
"title": "Open Locations",
"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."
},
"locations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"readOnly": true,
"description": "The number of unique campaign opens for a region."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "An internal code for the region representing the more specific location area such as city or state. When this is blank, it indicates we know the country, but not the region."
},
"region_name": {
"type": "string",
"title": "Region Name",
"readOnly": true,
"description": "The name of the region, if we have one. For blank \"region\" values, this will be \"Rest of Country\"."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The ISO 3166 2 digit country code."
}
}
},
"title": "Lists",
"description": "An array of objects, each representing a top location for opens."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Top open locations for a specific campaign."
}
ReportsListTopOpenLocationsdefaultResponse
{
"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'."
}
ReportsListUnsubscribedMembers200Response
{
"type": "object",
"title": "Unsubscribes",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"unsubscribes": {
"type": "array",
"items": {
"type": "object",
"title": "Unsubscribes",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A member who unsubscribed from a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who unsubscribed from a campaign."
}
},
"description": "A list of members who have unsubscribed from a specific campaign."
}
ReportsListUnsubscribedMembersResponse
{
"type": "object",
"title": "Unsubscribes",
"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."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
},
"unsubscribes": {
"type": "array",
"items": {
"type": "object",
"title": "Unsubscribes",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"reason": {
"type": "string",
"title": "Unsubscribe Reason",
"readOnly": true,
"description": "If available, the reason listed by the member for unsubscribing."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member opted-out in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A member who unsubscribed from a specific campaign."
},
"title": "Lists",
"description": "An array of objects, each representing a member who unsubscribed from a campaign."
}
},
"description": "A list of members who have unsubscribed from a specific campaign."
}
ReportsListUnsubscribedMembersdefaultResponse
{
"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'."
}
ReportsOpenSubscriberDetails200Response
{
"type": "object",
"title": "Open Activity",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"opens": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Time series data of opens activity",
"description": "An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"opens_count": {
"type": "integer",
"title": "Opens count",
"readOnly": true,
"description": "The total number of times the this campaign was opened by the list member."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's opens activity in a specific campaign."
}
ReportsOpenSubscriberDetailsResponse
{
"type": "object",
"title": "Open Activity",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"opens": {
"type": "array",
"items": {
"type": "object",
"title": "Member Activity",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time recorded for the action in ISO 8601 format."
}
},
"description": "A summary of the interaction with the campaign."
},
"title": "Time series data of opens activity",
"description": "An array of timestamps for each time a list member opened the campaign. If a list member opens an email multiple times, this will return a separate timestamp for each open event."
},
"_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."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique id for the list."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The unique id for the campaign."
},
"opens_count": {
"type": "integer",
"title": "Opens count",
"readOnly": true,
"description": "The total number of times the this campaign was opened by the list member."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A list of a member's opens activity in a specific campaign."
}
ReportsOpenSubscriberDetailsdefaultResponse
{
"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'."
}
ReportsSpecificCampaignReport200Response
{
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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."
},
"clicks": {
"type": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
}
ReportsSpecificCampaignReportResponse
{
"type": "object",
"title": "Campaign Report",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"description": "A string that uniquely identifies this campaign."
},
"type": {
"type": "string",
"title": "Campaign Type",
"description": "The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto)."
},
"opens": {
"type": "object",
"title": "Opens",
"properties": {
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last recorded open in ISO 8601 format."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"opens_total": {
"type": "integer",
"title": "Total Opens",
"description": "The total number of opens for a campaign."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The total number of unique opens."
}
},
"description": "An object describing the open activity for the campaign."
},
"_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."
},
"clicks": {
"type": "object",
"title": "Clicks",
"properties": {
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last recorded click for the campaign in ISO 8601 format."
},
"clicks_total": {
"type": "integer",
"title": "Total Clicks",
"description": "The total number of clicks for the campaign."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The total number of unique clicks for links across a campaign."
},
"unique_subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"description": "The total number of subscribers who clicked on a campaign."
}
},
"description": "An object describing the click activity for the campaign."
},
"bounces": {
"type": "object",
"title": "Bounces",
"properties": {
"hard_bounces": {
"type": "integer",
"title": "Hard Bounces",
"description": "The total number of hard bounced email addresses."
},
"soft_bounces": {
"type": "integer",
"title": "Soft Bounces",
"description": "The total number of soft bounced email addresses."
},
"syntax_errors": {
"type": "integer",
"title": "Syntax Errors",
"description": "The total number of addresses that were syntax-related bounces."
}
},
"description": "An object describing the bounce summary for the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The unique list id."
},
"ab_split": {
"type": "object",
"title": "A/B Split Stats",
"properties": {
"a": {
"type": "object",
"title": "Campaign A",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign A."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign A."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign A."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign A."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign A."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign A."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign A."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens from forwards for Campaign A."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipient Clicks for Campaign A."
}
},
"description": "Stats for Campaign A."
},
"b": {
"type": "object",
"title": "Campaign B",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "Opens for Campaign B."
},
"unsubs": {
"type": "integer",
"title": "Unsubscribes",
"description": "Unsubscribes for Campaign B."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "Bounces for Campaign B."
},
"forwards": {
"type": "integer",
"title": "Forwards",
"description": "Forwards for Campaign B."
},
"last_open": {
"type": "string",
"title": "Last Open",
"description": "The last open for Campaign B."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "Unique opens for Campaign B."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "Abuse reports for Campaign B."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "Opens for forwards from Campaign B."
},
"recipient_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "Recipients clicks for Campaign B."
}
},
"description": "Stats for Campaign B."
}
},
"description": "General stats about different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"forwards": {
"type": "object",
"title": "Forwards",
"properties": {
"forwards_count": {
"type": "integer",
"title": "Total Forwards",
"description": "How many times the campaign has been forwarded."
},
"forwards_opens": {
"type": "integer",
"title": "Forward Opens",
"description": "How many times the forwarded campaign has been opened."
}
},
"description": "An object describing the forwards and forward activity for the campaign."
},
"timewarp": {
"type": "array",
"items": {
"type": "object",
"properties": {
"opens": {
"type": "integer",
"title": "Opens",
"description": "The number of opens."
},
"clicks": {
"type": "integer",
"title": "Clicks",
"description": "The number of clicks."
},
"bounces": {
"type": "integer",
"title": "Bounces",
"description": "The number of bounces."
},
"last_open": {
"type": "string",
"title": "Last Open",
"format": "date-time",
"description": "The date and time of the last open in ISO 8601 format."
},
"gmt_offset": {
"type": "integer",
"title": "GMT Offset",
"description": "For campaigns sent with timewarp, the time zone group the member is apart of."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"description": "The date and time of the last click in ISO 8601 format."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"description": "The number of unique clicks."
}
}
},
"title": "Timewarp Stats",
"description": "An hourly breakdown of sends, opens, and clicks if a campaign is sent using timewarp."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"currency_code": {
"type": "string",
"title": "Three letter currency code for this user",
"example": "USD",
"readOnly": true
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"list_stats": {
"type": "object",
"title": "List Stats",
"properties": {
"sub_rate": {
"type": "number",
"title": "Average Subscription Rate",
"readOnly": true,
"description": "The average number of subscriptions per month for the list."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average open rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average click rate (a percentage represented as a number between 0 and 100) per campaign for the list."
},
"unsub_rate": {
"type": "number",
"title": "Average Unsubscription Rate",
"readOnly": true,
"description": "The average number of unsubscriptions per month for the list."
}
},
"description": "The average campaign statistics for your list. This won't be present if we haven't calculated it yet for this list."
},
"timeseries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"title": "Timestamp",
"format": "date-time",
"description": "The date and time for the series in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The number of emails sent in the timeseries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"description": "The number of unique opens in the timeseries."
},
"recipients_clicks": {
"type": "integer",
"title": "Recipient Clicks",
"description": "The number of clicks in the timeseries."
}
}
},
"title": "Timeseries",
"description": "An hourly breakdown of the performance of the campaign over the first 24 hours."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"description": "The total number of emails sent for this campaign."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"share_report": {
"type": "object",
"title": "Share Report",
"properties": {
"share_url": {
"type": "string",
"title": "Report URL",
"readOnly": true,
"description": "The URL for the VIP report."
},
"share_password": {
"type": "string",
"title": "Report Password",
"readOnly": true,
"description": "If password protected, the password for the VIP report."
}
},
"description": "The url and password for the [VIP report](https://mailchimp.com/help/share-a-campaign-report/)."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"readOnly": true,
"description": "The subject line for the campaign."
},
"unsubscribed": {
"type": "integer",
"title": "Unsubscribe Count",
"readOnly": true,
"description": "The total number of unsubscribed members for this campaign."
},
"abuse_reports": {
"type": "integer",
"title": "Abuse Reports",
"description": "The number of abuse reports generated for this campaign."
},
"rss_last_send": {
"type": "string",
"title": "RSS Last Send",
"format": "date-time",
"readOnly": true,
"description": "For RSS campaigns, the date and time of the last send in ISO 8601 format."
},
"campaign_title": {
"type": "string",
"title": "Campaign Title",
"readOnly": true,
"description": "The title of the campaign."
},
"facebook_likes": {
"type": "object",
"title": "Facebook Likes",
"properties": {
"unique_likes": {
"type": "integer",
"title": "Unique Likes",
"description": "The number of unique likes."
},
"facebook_likes": {
"type": "integer",
"title": "Facebook Likes",
"description": "The number of Facebook likes for the campaign."
},
"recipient_likes": {
"type": "integer",
"title": "Recipient Likes",
"description": "The number of recipients who liked the campaign on Facebook."
}
},
"description": "An object describing campaign engagement on Facebook."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"properties": {
"type": {
"type": "string",
"title": "Industry Type",
"description": "The type of business industry associated with your account. For example: retail, education, etc."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"description": "The industry open rate."
},
"abuse_rate": {
"type": "number",
"title": "Abuse Rate",
"description": "The industry abuse rate."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"description": "The industry click rate."
},
"unsub_rate": {
"type": "number",
"title": "Unsubscribe Rate",
"description": "The industry unsubscribe rate."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"description": "The industry bounce rate."
},
"unopen_rate": {
"type": "number",
"title": "Unopened Rate",
"description": "The industry unopened rate."
}
},
"description": "The average campaign statistics for your industry."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
}
},
"description": "Report details about a sent campaign."
}
ReportsSpecificCampaignReportdefaultResponse
{
"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'."
}
ReportsSpecificLinkDetails200Response
{
"type": "object",
"title": "Click Detail Report",
"properties": {
"id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The unique id for the link."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the link in the campaign."
},
"_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."
},
"ab_split": {
"type": "object",
"title": "A/B Split",
"properties": {
"a": {
"type": "object",
"title": "Group A",
"properties": {
"total_clicks_a": {
"type": "integer",
"title": "Total Clicks Group A",
"readOnly": true,
"description": "The total number of clicks for Group A."
},
"unique_clicks_a": {
"type": "integer",
"title": "Unique Clicks Group A",
"readOnly": true,
"description": "The number of unique clicks for Group A."
},
"click_percentage_a": {
"type": "number",
"title": "Click Percentage Group A",
"readOnly": true,
"description": "The percentage of total clicks for Group A."
},
"unique_click_percentage_a": {
"type": "number",
"title": "Unique Click Percentage Group A",
"readOnly": true,
"description": "The percentage of unique clicks for Group A."
}
},
"description": "Stats for Group A."
},
"b": {
"type": "object",
"title": "Group B",
"properties": {
"total_clicks_b": {
"type": "integer",
"title": "Total Clicks Group B",
"readOnly": true,
"description": "The total number of clicks for Group B."
},
"unique_clicks_b": {
"type": "integer",
"title": "Unique Clicks Group B",
"readOnly": true,
"description": "The number of unique clicks for Group B."
},
"click_percentage_b": {
"type": "number",
"title": "Click Percentage Group B",
"readOnly": true,
"description": "The percentage of total clicks for Group B."
},
"unique_click_percentage_b": {
"type": "number",
"title": "Unique Click Percentage Group B",
"readOnly": true,
"description": "The percentage of unique clicks for Group B."
}
},
"description": "Stats for Group B."
}
},
"description": "A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The date and time for the last recorded click for a link in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The number of total clicks for a link."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"readOnly": true,
"description": "Number of unique clicks for a link."
},
"click_percentage": {
"type": "number",
"title": "Click Percentage",
"readOnly": true,
"description": "The percentage of total clicks a link generated for a campaign."
},
"unique_click_percentage": {
"type": "number",
"title": "Unique Click Percentage",
"readOnly": true,
"description": "The percentage of unique clicks a link generated for a campaign."
}
},
"description": "A report of links clicked in a specific campaign."
}
ReportsSpecificLinkDetailsResponse
{
"type": "object",
"title": "Click Detail Report",
"properties": {
"id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The unique id for the link."
},
"url": {
"type": "string",
"title": "URL",
"readOnly": true,
"description": "The URL for the link in the campaign."
},
"_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."
},
"ab_split": {
"type": "object",
"title": "A/B Split",
"properties": {
"a": {
"type": "object",
"title": "Group A",
"properties": {
"total_clicks_a": {
"type": "integer",
"title": "Total Clicks Group A",
"readOnly": true,
"description": "The total number of clicks for Group A."
},
"unique_clicks_a": {
"type": "integer",
"title": "Unique Clicks Group A",
"readOnly": true,
"description": "The number of unique clicks for Group A."
},
"click_percentage_a": {
"type": "number",
"title": "Click Percentage Group A",
"readOnly": true,
"description": "The percentage of total clicks for Group A."
},
"unique_click_percentage_a": {
"type": "number",
"title": "Unique Click Percentage Group A",
"readOnly": true,
"description": "The percentage of unique clicks for Group A."
}
},
"description": "Stats for Group A."
},
"b": {
"type": "object",
"title": "Group B",
"properties": {
"total_clicks_b": {
"type": "integer",
"title": "Total Clicks Group B",
"readOnly": true,
"description": "The total number of clicks for Group B."
},
"unique_clicks_b": {
"type": "integer",
"title": "Unique Clicks Group B",
"readOnly": true,
"description": "The number of unique clicks for Group B."
},
"click_percentage_b": {
"type": "number",
"title": "Click Percentage Group B",
"readOnly": true,
"description": "The percentage of total clicks for Group B."
},
"unique_click_percentage_b": {
"type": "number",
"title": "Unique Click Percentage Group B",
"readOnly": true,
"description": "The percentage of unique clicks for Group B."
}
},
"description": "Stats for Group B."
}
},
"description": "A breakdown of clicks by different groups of an A/B Split campaign. Does not return information about Multivariate Campaigns."
},
"last_click": {
"type": "string",
"title": "Last Click",
"format": "date-time",
"readOnly": true,
"description": "The date and time for the last recorded click for a link in ISO 8601 format."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"total_clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The number of total clicks for a link."
},
"unique_clicks": {
"type": "integer",
"title": "Unique Clicks",
"readOnly": true,
"description": "Number of unique clicks for a link."
},
"click_percentage": {
"type": "number",
"title": "Click Percentage",
"readOnly": true,
"description": "The percentage of total clicks a link generated for a campaign."
},
"unique_click_percentage": {
"type": "number",
"title": "Unique Click Percentage",
"readOnly": true,
"description": "The percentage of unique clicks a link generated for a campaign."
}
},
"description": "A report of links clicked in a specific campaign."
}
ReportsSpecificLinkDetailsdefaultResponse
{
"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'."
}
ReportsSpecificLinkSubscriber200Response
{
"type": "object",
"title": "Click Detail Member",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of times the subscriber clicked on the link."
},
"url_id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The id for the tracked URL in the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber who clicked a specific URL in a specific campaign."
}
ReportsSpecificLinkSubscriberResponse
{
"type": "object",
"title": "Click Detail Member",
"properties": {
"vip": {
"type": "boolean",
"title": "VIP",
"readOnly": true,
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"_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."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of times the subscriber clicked on the link."
},
"url_id": {
"type": "string",
"title": "URL ID",
"readOnly": true,
"description": "The id for the tracked URL in the campaign."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"email_id": {
"type": "string",
"title": "Email Hash",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"campaign_id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "The campaign id."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"readOnly": true,
"description": "Email address for a subscriber."
},
"contact_status": {
"type": "string",
"title": "Member Status",
"readOnly": true,
"description": "The status of the member, namely if they are subscribed, unsubscribed, deleted, non-subscribed, transactional, pending, or need reconfirmation."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
}
},
"description": "A subscriber who clicked a specific URL in a specific campaign."
}
ReportsSpecificLinkSubscriberdefaultResponse
{
"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'."
}
RootListResources200Response
{
"type": "object",
"title": "API Root",
"properties": {
"role": {
"type": "string",
"title": "Role",
"readOnly": true,
"description": "The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account."
},
"email": {
"type": "string",
"title": "Account Email",
"readOnly": true,
"description": "The account email address."
},
"_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."
},
"contact": {
"type": "object",
"title": "Account Contact",
"readOnly": true,
"properties": {
"zip": {
"type": "string",
"title": "Zip Code",
"readOnly": true,
"description": "The zip code for the account contact."
},
"city": {
"type": "string",
"title": "City",
"readOnly": true,
"description": "The city for the account contact."
},
"addr1": {
"type": "string",
"title": "Address Line 1",
"readOnly": true,
"description": "The street address for the account contact."
},
"addr2": {
"type": "string",
"title": "Address Line 2",
"readOnly": true,
"description": "The street address for the account contact."
},
"state": {
"type": "string",
"title": "State",
"readOnly": true,
"description": "The state for the account contact."
},
"company": {
"type": "string",
"title": "Company",
"readOnly": true,
"description": "The company name for the account."
},
"country": {
"type": "string",
"title": "Country",
"readOnly": true,
"description": "The country for the account contact."
}
},
"description": "Information about the account contact."
},
"login_id": {
"type": "string",
"title": "Login ID",
"readOnly": true,
"description": "The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account."
},
"username": {
"type": "string",
"title": "User Name",
"example": "freddie2000",
"readOnly": true,
"description": "The username tied to the account."
},
"last_name": {
"type": "string",
"title": "Last Name",
"readOnly": true,
"description": "The last name tied to the account."
},
"account_id": {
"type": "string",
"title": "Account ID",
"readOnly": true,
"description": "The Mailchimp account ID."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL of the avatar for the user."
},
"first_name": {
"type": "string",
"title": "First Name",
"readOnly": true,
"description": "The first name tied to the account."
},
"last_login": {
"type": "string",
"title": "Last Login Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last login for this account in ISO 8601 format."
},
"pro_enabled": {
"type": "boolean",
"title": "Mailchimp Pro",
"readOnly": true,
"description": "Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-mailchimp-pro/)."
},
"account_name": {
"type": "string",
"title": "Account Name",
"readOnly": true,
"description": "The name of the account."
},
"member_since": {
"type": "string",
"title": "Account Creation Date",
"format": "date-time",
"example": "2010-01-01T23:59:59+00:00",
"readOnly": true,
"description": "The date and time that the account was created in ISO 8601 format."
},
"first_payment": {
"type": "string",
"title": "First Payment",
"format": "date-time",
"example": "2010-01-01T23:59:59+00:00",
"readOnly": true,
"description": "Date of first payment for monthly plans."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average unique open rate for all campaigns in the account's specified industry."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average unique click rate for all campaigns in the account's specified industry."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"readOnly": true,
"description": "The average bounce rate for all campaigns in the account's specified industry."
}
},
"description": "The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry."
},
"account_industry": {
"type": "string",
"title": "Account Industry",
"readOnly": true,
"description": "The user-specified industry associated with the account."
},
"account_timezone": {
"type": "string",
"title": "Account Timezone",
"readOnly": true,
"description": "The timezone currently set for the account."
},
"pricing_plan_type": {
"enum": [
"monthly",
"pay_as_you_go",
"forever_free"
],
"type": "string",
"title": "Account Pricing Plan",
"readOnly": true,
"description": "The type of pricing plan the account is on."
},
"total_subscribers": {
"type": "integer",
"title": "Total Subscribers",
"readOnly": true,
"description": "The total number of subscribers across all lists in the account."
}
},
"description": "The API root resource links to all other resources available in the API."
}
RootListResourcesResponse
{
"type": "object",
"title": "API Root",
"properties": {
"role": {
"type": "string",
"title": "Role",
"readOnly": true,
"description": "The [user role](https://mailchimp.com/help/manage-user-levels-in-your-account/) for the account."
},
"email": {
"type": "string",
"title": "Account Email",
"readOnly": true,
"description": "The account email address."
},
"_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."
},
"contact": {
"type": "object",
"title": "Account Contact",
"readOnly": true,
"properties": {
"zip": {
"type": "string",
"title": "Zip Code",
"readOnly": true,
"description": "The zip code for the account contact."
},
"city": {
"type": "string",
"title": "City",
"readOnly": true,
"description": "The city for the account contact."
},
"addr1": {
"type": "string",
"title": "Address Line 1",
"readOnly": true,
"description": "The street address for the account contact."
},
"addr2": {
"type": "string",
"title": "Address Line 2",
"readOnly": true,
"description": "The street address for the account contact."
},
"state": {
"type": "string",
"title": "State",
"readOnly": true,
"description": "The state for the account contact."
},
"company": {
"type": "string",
"title": "Company",
"readOnly": true,
"description": "The company name for the account."
},
"country": {
"type": "string",
"title": "Country",
"readOnly": true,
"description": "The country for the account contact."
}
},
"description": "Information about the account contact."
},
"login_id": {
"type": "string",
"title": "Login ID",
"readOnly": true,
"description": "The ID associated with the user who owns this API key. If you can login to multiple accounts, this ID will be the same for each account."
},
"username": {
"type": "string",
"title": "User Name",
"example": "freddie2000",
"readOnly": true,
"description": "The username tied to the account."
},
"last_name": {
"type": "string",
"title": "Last Name",
"readOnly": true,
"description": "The last name tied to the account."
},
"account_id": {
"type": "string",
"title": "Account ID",
"readOnly": true,
"description": "The Mailchimp account ID."
},
"avatar_url": {
"type": "string",
"title": "Avatar URL",
"readOnly": true,
"description": "URL of the avatar for the user."
},
"first_name": {
"type": "string",
"title": "First Name",
"readOnly": true,
"description": "The first name tied to the account."
},
"last_login": {
"type": "string",
"title": "Last Login Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time of the last login for this account in ISO 8601 format."
},
"pro_enabled": {
"type": "boolean",
"title": "Mailchimp Pro",
"readOnly": true,
"description": "Legacy - whether the account includes [Mailchimp Pro](https://mailchimp.com/help/about-mailchimp-pro/)."
},
"account_name": {
"type": "string",
"title": "Account Name",
"readOnly": true,
"description": "The name of the account."
},
"member_since": {
"type": "string",
"title": "Account Creation Date",
"format": "date-time",
"example": "2010-01-01T23:59:59+00:00",
"readOnly": true,
"description": "The date and time that the account was created in ISO 8601 format."
},
"first_payment": {
"type": "string",
"title": "First Payment",
"format": "date-time",
"example": "2010-01-01T23:59:59+00:00",
"readOnly": true,
"description": "Date of first payment for monthly plans."
},
"industry_stats": {
"type": "object",
"title": "Industry Stats",
"readOnly": true,
"properties": {
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The average unique open rate for all campaigns in the account's specified industry."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The average unique click rate for all campaigns in the account's specified industry."
},
"bounce_rate": {
"type": "number",
"title": "Bounce Rate",
"readOnly": true,
"description": "The average bounce rate for all campaigns in the account's specified industry."
}
},
"description": "The [average campaign statistics](https://mailchimp.com/resources/research/email-marketing-benchmarks/?utm_source=mc-api&utm_medium=docs&utm_campaign=apidocs) for all campaigns in the account's specified industry."
},
"account_industry": {
"type": "string",
"title": "Account Industry",
"readOnly": true,
"description": "The user-specified industry associated with the account."
},
"account_timezone": {
"type": "string",
"title": "Account Timezone",
"readOnly": true,
"description": "The timezone currently set for the account."
},
"pricing_plan_type": {
"enum": [
"monthly",
"pay_as_you_go",
"forever_free"
],
"type": "string",
"title": "Account Pricing Plan",
"readOnly": true,
"description": "The type of pricing plan the account is on."
},
"total_subscribers": {
"type": "integer",
"title": "Total Subscribers",
"readOnly": true,
"description": "The total number of subscribers across all lists in the account."
}
},
"description": "The API root resource links to all other resources available in the API."
}
RootListResourcesdefaultResponse
{
"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'."
}
SearchCampaignsByQueryTerms200Response
{
"type": "object",
"title": "Campaigns",
"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."
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"snippet": {
"type": "string",
"title": "Matching snippet"
},
"campaign": {
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
}
},
"title": "Results",
"description": "An array of matching campaigns and snippets."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Campaigns and Snippets found for given search term."
}
SearchCampaignsByQueryTermsResponse
{
"type": "object",
"title": "Campaigns",
"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."
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"snippet": {
"type": "string",
"title": "Matching snippet"
},
"campaign": {
"type": "object",
"title": "Campaign",
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-defaults/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": false,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage out-of-office replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent."
},
"recipients": {
"type": "object",
"title": "List",
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/create-and-send-to-a-segment/) used for the campaign. Formatted as a string marked up with HTML."
},
"list_is_active": {
"type": "boolean",
"title": "List Status",
"readOnly": true,
"description": "The status of the list used, namely if it's deleted or disabled."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version in ISO 8601 format."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"enum": [
"template",
"html",
"url",
"multichannel"
],
"type": "string",
"title": "Content Type",
"description": "How the campaign's content is put together."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens, clicks, and e-commerce data."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
},
"resend_shortcut_eligibility": {
"type": "object",
"title": "Resend Shortcut Eligibility",
"properties": {
"to_non_openers": {
"type": "object",
"title": "To Non-Openers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"to_non_clickers": {
"type": "object",
"title": "To Non-Clickers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to non-clickers."
},
"to_new_subscribers": {
"type": "object",
"title": "To New Subscribers",
"properties": {
"reason": {
"type": "string",
"title": "Reason",
"readOnly": true,
"description": "The reason the campaign is not eligible to be resent to this segment."
},
"is_eligible": {
"type": "boolean",
"title": "Is Eligible",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to this segment."
}
},
"description": "Determines if the campaign qualifies to be resent to new subscribers."
}
},
"description": "Determines if the campaign qualifies for the Campaign Resend Shortcuts. Only included when query parameter `include_resend_shortcuts` is `true`."
}
},
"description": "A summary of an individual campaign's settings and content."
}
}
},
"title": "Results",
"description": "An array of matching campaigns and snippets."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Campaigns and Snippets found for given search term."
}
SearchCampaignsByQueryTermsdefaultResponse
{
"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'."
}
SearchMembersListMembers200Response
{
"type": "object",
"title": "Members",
"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."
},
"full_search": {
"type": "object",
"title": "Partial Matches",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Partial matches of the provided search query."
},
"exact_matches": {
"type": "object",
"title": "Exact Matches",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Exact matches of the provided search query."
}
},
"description": "Members found for given search term"
}
SearchMembersListMembersResponse
{
"type": "object",
"title": "Members",
"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."
},
"full_search": {
"type": "object",
"title": "Partial Matches",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Partial matches of the provided search query."
},
"exact_matches": {
"type": "object",
"title": "Exact Matches",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"title": "List Members",
"properties": {
"id": {
"type": "string",
"title": "Email ID",
"readOnly": true,
"description": "The MD5 hash of the lowercase version of the list member's email address."
},
"vip": {
"type": "boolean",
"title": "VIP",
"description": "[VIP status](https://mailchimp.com/help/designate-and-send-to-vip-contacts/) for subscriber."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Tag ID",
"readOnly": true,
"description": "The tag id."
},
"name": {
"type": "string",
"title": "Tag Name",
"readOnly": true,
"description": "The name of the tag"
}
}
},
"title": "Tags",
"readOnly": false,
"description": "Returns up to 50 tags applied to this member. To retrieve all tags see [Member Tags](https://mailchimp.com/developer/marketing/api/list-member-tags/)."
},
"stats": {
"type": "object",
"title": "Subscriber Stats",
"readOnly": true,
"properties": {
"avg_open_rate": {
"type": "number",
"title": "Average Open Rate",
"readOnly": true,
"description": "A subscriber's average open rate."
},
"avg_click_rate": {
"type": "number",
"title": "Average Click Rate",
"readOnly": true,
"description": "A subscriber's average clickthrough rate."
},
"ecommerce_data": {
"type": "object",
"title": "Ecommerce Stats",
"readOnly": true,
"properties": {
"currency_code": {
"type": "string",
"title": "Currency",
"example": "USD",
"readOnly": true,
"description": "The three-letter ISO 4217 code for the currency that the store accepts."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue the list member has brought in."
},
"number_of_orders": {
"type": "number",
"title": "Total Number of Orders",
"readOnly": true,
"description": "The total number of orders placed by the list member."
}
},
"description": "Ecommerce stats for the list member if the list is attached to a store."
}
},
"description": "Open and click rates for this subscriber."
},
"_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."
},
"ip_opt": {
"type": "string",
"title": "Opt-in IP",
"readOnly": true,
"description": "The IP address the subscriber used to confirm their opt-in status."
},
"source": {
"type": "string",
"title": "Subscriber Source",
"readOnly": true,
"description": "The source from which the subscriber was added to this list."
},
"status": {
"enum": [
"subscribed",
"unsubscribed",
"cleaned",
"pending",
"transactional",
"archived"
],
"type": "string",
"title": "Status",
"description": "Subscriber's current status."
},
"web_id": {
"type": "integer",
"title": "Member Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this member in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}`."
},
"list_id": {
"type": "string",
"title": "List ID",
"readOnly": true,
"description": "The list id."
},
"language": {
"type": "string",
"title": "Language",
"description": "If set/detected, the [subscriber's language](https://mailchimp.com/help/view-and-edit-contact-languages/)."
},
"location": {
"type": "object",
"title": "Location",
"properties": {
"dstoff": {
"type": "integer",
"title": "DST Offset",
"readOnly": true,
"description": "The offset for timezones where daylight saving time is observed."
},
"gmtoff": {
"type": "integer",
"title": "GMT Offset",
"readOnly": true,
"description": "The time difference in hours from GMT."
},
"region": {
"type": "string",
"title": "Region",
"readOnly": true,
"description": "The region for the location."
},
"latitude": {
"type": "number",
"title": "Latitude",
"description": "The location latitude."
},
"timezone": {
"type": "string",
"title": "Timezone",
"readOnly": true,
"description": "The timezone for the location."
},
"longitude": {
"type": "number",
"title": "Longitude",
"description": "The location longitude."
},
"country_code": {
"type": "string",
"title": "Country Code",
"readOnly": true,
"description": "The unique code for the location country."
}
},
"description": "Subscriber location information."
},
"full_name": {
"type": "string",
"title": "Full Name",
"readOnly": true,
"description": "The contact's full name."
},
"interests": {
"type": "object",
"title": "Subscriber Interests",
"description": "The key of this object's properties is the ID of the interest in question.",
"additionalProperties": {
"type": "boolean",
"title": "Interest Value",
"description": "Keys are interest IDs, values are booleans that describe whether the list member is in that group or not."
}
},
"ip_signup": {
"type": "string",
"title": "Signup IP",
"readOnly": true,
"description": "IP address the subscriber signed up from."
},
"last_note": {
"type": "object",
"title": "Notes",
"readOnly": true,
"properties": {
"note": {
"type": "string",
"title": "Note",
"readOnly": true,
"description": "The content of the note."
},
"note_id": {
"type": "integer",
"title": "Note ID",
"readOnly": true,
"description": "The note id."
},
"created_at": {
"type": "string",
"title": "Created Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the note was created in ISO 8601 format."
},
"created_by": {
"type": "string",
"title": "Author",
"readOnly": true,
"description": "The author of the note."
}
},
"description": "The most recent Note added about this member."
},
"contact_id": {
"type": "string",
"title": "Contact ID",
"readOnly": true,
"description": "As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the `id` is the MD5 hash of their email address, this `contact_id` is agnostic of contact’s inclusion of an email address."
},
"email_type": {
"type": "string",
"title": "Email Type",
"description": "Type of email this member asked to get ('html' or 'text')."
},
"tags_count": {
"type": "integer",
"title": "Tags Count",
"readOnly": true,
"description": "The number of tags applied to this member."
},
"email_client": {
"type": "string",
"title": "Email Client",
"readOnly": true,
"description": "The list member's email client."
},
"last_changed": {
"type": "string",
"title": "Last Changed Date",
"format": "date-time",
"readOnly": true,
"description": "The date and time the member's info was last changed in ISO 8601 format."
},
"merge_fields": {
"type": "object",
"title": "Merge Fields",
"description": "A dictionary of merge fields where the keys are the merge tags. See the [Merge Fields documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/#structure) for more about the structure.",
"additionalProperties": {
"description": "This object's keys are merge tags (like FNAME). It's values are the values to be added to the merge field."
}
},
"email_address": {
"type": "string",
"title": "Email Address",
"description": "Email address for a subscriber."
},
"member_rating": {
"type": "integer",
"title": "Member Rating",
"readOnly": true,
"description": "Star rating for this member, between 1 and 5."
},
"timestamp_opt": {
"type": "string",
"title": "Opt-in Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber confirmed their opt-in status in ISO 8601 format."
},
"unique_email_id": {
"type": "string",
"title": "Unique Email ID",
"readOnly": true,
"description": "An identifier for the address across all of Mailchimp."
},
"sms_phone_number": {
"type": "string",
"title": "SMS Phone Number",
"description": "A US phone number for SMS contact."
},
"timestamp_signup": {
"type": "string",
"title": "Signup Timestamp",
"format": "date-time",
"readOnly": true,
"description": "The date and time the subscriber signed up for the list in ISO 8601 format."
},
"unsubscribe_reason": {
"type": "string",
"title": "Unsubscribe Reason",
"description": "A subscriber's reason for unsubscribing."
},
"marketing_permissions": {
"type": "array",
"items": {
"type": "object",
"title": "Marketing Permission",
"properties": {
"text": {
"type": "string",
"title": "Marketing Permission Text",
"description": "The text of the marketing permission."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "If the subscriber has opted-in to the marketing permission."
},
"marketing_permission_id": {
"type": "string",
"title": "Marketing Permission ID",
"description": "The id for the marketing permission on the list"
}
},
"description": "A single marketing permission a subscriber has either opted-in to or opted-out of."
},
"title": "Marketing Permissions",
"description": "The marketing permissions for the subscriber."
},
"sms_subscription_status": {
"enum": [
"subscribed",
"unsubscribed",
"nonsubscribed",
"pending"
],
"type": "string",
"title": "SMS Subscription Status",
"description": "The status of an SMS subscription."
},
"sms_subscription_last_updated": {
"type": "string",
"title": "SMS Subscription Last Update",
"description": "The datetime when the SMS subscription was last updated"
},
"consents_to_one_to_one_messaging": {
"type": "boolean",
"title": "Messaging Consent",
"readOnly": true,
"description": "Indicates whether a contact consents to 1:1 messaging."
}
},
"description": "Individuals who are currently or have been previously subscribed to this list, including members who have bounced or unsubscribed."
},
"title": "Members",
"description": "An array of objects, each representing a specific list member."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "Exact matches of the provided search query."
}
},
"description": "Members found for given search term"
}
SearchMembersListMembersdefaultResponse
{
"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'."
}
SurveysGenerateCampaign200Response
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
SurveysGenerateCampaignResponse
{
"type": "object",
"title": "Campaign",
"required": [
"type"
],
"properties": {
"id": {
"type": "string",
"title": "Campaign ID",
"readOnly": true,
"description": "A string that uniquely identifies this campaign."
},
"type": {
"enum": [
"regular",
"plaintext",
"absplit",
"rss",
"variate"
],
"type": "string",
"title": "Campaign Type",
"description": "There are four types of [campaigns](https://mailchimp.com/help/getting-started-with-campaigns/) you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead."
},
"_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": [
"save",
"paused",
"schedule",
"sending",
"sent",
"canceled",
"canceling",
"archived"
],
"type": "string",
"title": "Campaign Status",
"readOnly": true,
"description": "The current status of the campaign."
},
"web_id": {
"type": "integer",
"title": "Campaign Web ID",
"readOnly": true,
"description": "The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at `https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}`."
},
"rss_opts": {
"type": "object",
"title": "RSS Options",
"required": [
"feed_url",
"frequency"
],
"properties": {
"feed_url": {
"type": "string",
"title": "Feed URL",
"format": "uri",
"description": "The URL for the RSS feed."
},
"schedule": {
"type": "object",
"title": "Sending Schedule",
"properties": {
"hour": {
"type": "integer",
"title": "Sending Hour",
"maximum": 23,
"minimum": 0,
"description": "The hour to send the campaign in local time. Acceptable hours are 0-23. For example, '4' would be 4am in [your account's default time zone](https://mailchimp.com/help/set-account-details/)."
},
"daily_send": {
"type": "object",
"title": "Daily Sending Days",
"properties": {
"friday": {
"type": "boolean",
"title": "Friday",
"description": "Sends the daily RSS Campaign on Fridays."
},
"monday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Mondays."
},
"sunday": {
"type": "boolean",
"title": "Sunday",
"description": "Sends the daily RSS Campaign on Sundays."
},
"tuesday": {
"type": "boolean",
"title": "tuesday",
"description": "Sends the daily RSS Campaign on Tuesdays."
},
"saturday": {
"type": "boolean",
"title": "Saturday",
"description": "Sends the daily RSS Campaign on Saturdays."
},
"thursday": {
"type": "boolean",
"title": "Thursday",
"description": "Sends the daily RSS Campaign on Thursdays."
},
"wednesday": {
"type": "boolean",
"title": "Monday",
"description": "Sends the daily RSS Campaign on Wednesdays."
}
},
"description": "The days of the week to send a daily RSS Campaign."
},
"weekly_send_day": {
"enum": [
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"type": "string",
"title": "Weekly Sending Day",
"description": "The day of the week to send a weekly RSS Campaign."
},
"monthly_send_date": {
"type": "number",
"title": "Monthly Sending Day",
"maximum": 31,
"minimum": 0,
"description": "The day of the month to send a monthly RSS Campaign. Acceptable days are 0-31, where '0' is always the last day of a month. Months with fewer than the selected number of days will not have an RSS campaign sent out that day. For example, RSS Campaigns set to send on the 30th will not go out in February."
}
},
"description": "The schedule for sending the RSS Campaign."
},
"frequency": {
"enum": [
"daily",
"weekly",
"monthly"
],
"type": "string",
"title": "Frequency",
"description": "The frequency of the RSS Campaign."
},
"last_sent": {
"type": "string",
"title": "Last Sent",
"format": "date-time",
"readOnly": true,
"description": "The date the campaign was last sent."
},
"constrain_rss_img": {
"type": "boolean",
"title": "Constrain RSS Images",
"description": "Whether to add CSS to images in the RSS feed to constrain their width in campaigns."
}
},
"description": "[RSS](https://mailchimp.com/help/share-your-blog-posts-with-mailchimp/) options for a campaign."
},
"settings": {
"type": "object",
"title": "Campaign Settings",
"properties": {
"title": {
"type": "string",
"title": "Campaign Title",
"description": "The title of the campaign."
},
"to_name": {
"type": "string",
"title": "To Name",
"description": "The campaign's custom 'To' name. Typically the first name [audience field](https://mailchimp.com/help/getting-started-with-merge-tags/)."
},
"reply_to": {
"type": "string",
"title": "Reply To Address",
"description": "The reply-to email address for the campaign."
},
"timewarp": {
"type": "boolean",
"title": "Timewarp Send",
"readOnly": true,
"description": "Send this campaign using [Timewarp](https://mailchimp.com/help/use-timewarp/)."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "If the campaign is listed in a folder, the id for that folder."
},
"from_name": {
"type": "string",
"title": "From Name",
"description": "The 'from' name on the campaign (not an email address)."
},
"auto_tweet": {
"type": "boolean",
"title": "Auto-Tweet",
"description": "Automatically tweet a link to the [campaign archive](https://mailchimp.com/help/about-email-campaign-archives-and-pages/) page when the campaign is sent."
},
"inline_css": {
"type": "boolean",
"title": "Inline CSS",
"description": "Automatically inline the CSS included with the campaign content."
},
"auto_footer": {
"type": "boolean",
"title": "Auto-Footer",
"description": "Automatically append Mailchimp's [default footer](https://mailchimp.com/help/about-campaign-footers/) to the campaign."
},
"fb_comments": {
"type": "boolean",
"title": "Facebook Comments",
"description": "Allows Facebook comments on the campaign (also force-enables the Campaign Archive toolbar). Defaults to `true`."
},
"template_id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The id for the template used in this campaign."
},
"authenticate": {
"type": "boolean",
"title": "Authentication",
"description": "Whether Mailchimp [authenticated](https://mailchimp.com/help/about-email-authentication/) the campaign. Defaults to `true`."
},
"auto_fb_post": {
"type": "array",
"items": {
"type": "string"
},
"title": "Auto Post to Facebook",
"description": "An array of [Facebook](https://mailchimp.com/help/connect-or-disconnect-the-facebook-integration/) page ids to auto-post to."
},
"preview_text": {
"type": "string",
"title": "Campaign Preview Text",
"description": "The preview text for the campaign."
},
"subject_line": {
"type": "string",
"title": "Campaign Subject Line",
"description": "The subject line for the campaign."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag And Drop Campaign",
"readOnly": true,
"description": "Whether the campaign uses the drag-and-drop editor."
},
"use_conversation": {
"type": "boolean",
"title": "Conversation",
"description": "Use Mailchimp Conversation feature to manage replies."
}
},
"description": "The settings for your campaign, including subject, from name, reply-to address, and more."
},
"tracking": {
"type": "object",
"title": "Campaign Tracking Options",
"properties": {
"opens": {
"type": "boolean",
"title": "Opens",
"description": "Whether to [track opens](https://mailchimp.com/help/about-open-tracking/). Defaults to `true`. Cannot be set to false for variate campaigns."
},
"capsule": {
"type": "object",
"title": "Capsule CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Capsule Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
}
},
"description": "Deprecated"
},
"ecomm360": {
"type": "boolean",
"title": "E-commerce Tracking",
"description": "Whether to enable e-commerce tracking."
},
"clicktale": {
"type": "string",
"title": "ClickTale Analytics Tracking",
"description": "The custom slug for [ClickTale](https://mailchimp.com/help/additional-tracking-options-for-campaigns/) tracking (max of 50 bytes)."
},
"salesforce": {
"type": "object",
"title": "Salesforce CRM Tracking",
"properties": {
"notes": {
"type": "boolean",
"title": "Salesforce Note",
"description": "Update contact notes for a campaign based on subscriber email addresses."
},
"campaign": {
"type": "boolean",
"title": "Salesforce Campaign",
"description": "Create a campaign in a connected Salesforce account."
}
},
"description": "Deprecated"
},
"html_clicks": {
"type": "boolean",
"title": "HTML Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the HTML version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"text_clicks": {
"type": "boolean",
"title": "Plain-Text Click Tracking",
"description": "Whether to [track clicks](https://mailchimp.com/help/enable-and-view-click-tracking/) in the plain-text version of the campaign. Defaults to `true`. Cannot be set to false for variate campaigns."
},
"goal_tracking": {
"type": "boolean",
"title": "Mailchimp Goal Tracking",
"description": "Deprecated"
},
"google_analytics": {
"type": "string",
"title": "Google Analytics Tracking",
"description": "The custom slug for [Google Analytics](https://mailchimp.com/help/integrate-google-analytics-with-mailchimp/) tracking (max of 50 bytes)."
}
},
"description": "The tracking options for a campaign."
},
"send_time": {
"type": "string",
"title": "Send Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time a campaign was sent in ISO 8601 format."
},
"recipients": {
"type": "object",
"title": "List",
"required": [
"list_id"
],
"properties": {
"list_id": {
"type": "string",
"title": "List ID",
"description": "The unique list id."
},
"list_name": {
"type": "string",
"title": "List Name",
"readOnly": true,
"description": "The name of the list."
},
"segment_opts": {
"type": "object",
"title": "Segment Options",
"properties": {
"match": {
"enum": [
"any",
"all"
],
"type": "string",
"title": "Match Type",
"description": "Segment match type."
},
"conditions": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"title": "Aim Segment",
"properties": {
"op": {
"enum": [
"open",
"click",
"sent",
"noopen",
"noclick",
"nosent"
],
"type": "string",
"title": "Segment Operator",
"example": "open",
"description": "The status of the member with regard to their campaign interaction. One of the following: opened, clicked, was sent, didn't open, didn't click, or was not sent."
},
"field": {
"enum": [
"aim"
],
"type": "string",
"title": "Segment Field",
"example": "aim",
"description": "Segment by interaction with a specific campaign."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "Either the web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Aim"
],
"type": "string",
"x-value": "Aim"
}
},
"description": "Segment by interaction with a specific campaign."
},
{
"type": "object",
"title": "Automation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the automation workflow. One of the following: has started the workflow, has completed the workflow, has not started the workflow, or has not completed the workflow."
},
"field": {
"enum": [
"automation"
],
"type": "string",
"title": "Segment Field",
"example": "automation",
"description": "Segment by interaction with an Automation workflow."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "2135217",
"description": "The web id for the automation workflow to segment against."
},
"condition_type": {
"enum": [
"Automation"
],
"type": "string",
"x-value": "Automation"
}
},
"description": "Segment by interaction with an Automation workflow."
},
{
"type": "object",
"title": "Poll Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members have/have not interacted with a specific poll in a Mailchimp email."
},
"field": {
"enum": [
"poll"
],
"type": "string",
"title": "Segment Field",
"example": "poll",
"description": "Segment by poll activity."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 409,
"description": "The id for the poll."
},
"condition_type": {
"enum": [
"CampaignPoll"
],
"type": "string",
"x-value": "CampaignPoll"
}
},
"description": "Segment by poll activity."
},
{
"type": "object",
"title": "Conversation Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "The status of a member's interaction with a conversation. One of the following: has replied or has not replied."
},
"field": {
"enum": [
"conversation"
],
"type": "string",
"title": "Segment Field",
"example": "conversation",
"description": "Segment by interaction with a campaign via Conversations."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "any",
"description": "The web id value for a specific campaign or 'any' to account for subscribers who have/have not interacted with any campaigns."
},
"condition_type": {
"enum": [
"Conversation"
],
"type": "string",
"x-value": "Conversation"
}
},
"description": "Segment by interaction with a campaign via Conversations."
},
{
"type": "object",
"title": "Date Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is",
"not",
"blank",
"blank_not",
"within",
"notwithin"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "When the event took place: Before, after, is a specific date, is not a specific date, is blank, or is not blank."
},
"extra": {
"type": "string",
"title": "Segment Extra Value",
"example": "2015-01-30",
"description": "When segmenting on 'date' or 'campaign', the date for the segment formatted as YYYY-MM-DD or the web id for the campaign."
},
"field": {
"enum": [
"timestamp_opt",
"info_changed",
"ecomm_date"
],
"type": "string",
"title": "Segment Field",
"example": "timestamp_opt",
"description": "The type of date field to segment on: The opt-in time for a signup, the date the subscriber was last updated, or the date of their last ecomm purchase."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "date",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"Date"
],
"type": "string",
"x-value": "Date"
}
},
"description": "Segment by a specific date field."
},
{
"type": "object",
"title": "Email Client Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"client_is",
"client_not"
],
"type": "string",
"title": "Segment Operator",
"example": "client_is",
"description": "The operation to determine whether we select clients that match the value, or clients that do not match the value."
},
"field": {
"enum": [
"email_client"
],
"type": "string",
"title": "Segment Field",
"example": "email_client",
"description": "Segment by use of a particular email client."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Gmail",
"description": "The name of the email client."
},
"condition_type": {
"enum": [
"EmailClient"
],
"type": "string",
"x-value": "EmailClient"
}
},
"description": "Segment by use of a particular email client."
},
{
"type": "object",
"title": "Language Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's language is or is not set to a specific language."
},
"field": {
"enum": [
"language"
],
"type": "string",
"title": "Segment Field",
"example": "language",
"description": "Segmenting based off of a subscriber's language."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "en",
"description": "A two-letter language identifier."
},
"condition_type": {
"enum": [
"Language"
],
"type": "string",
"x-value": "Language"
}
},
"description": "Segment by language."
},
{
"type": "object",
"title": "Member Rating Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have have a rating that is/not exactly a given number or members who have a rating greater/less than a given number."
},
"field": {
"enum": [
"rating"
],
"type": "string",
"title": "Segment Field",
"example": "rating",
"description": "Segment by member rating."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 4,
"description": "The star rating number to segment against."
},
"condition_type": {
"enum": [
"MemberRating"
],
"type": "string",
"x-value": "MemberRating"
}
},
"description": "Segment by member rating."
},
{
"type": "object",
"title": "Signup Source Segment",
"required": [
"field",
"condition_type",
"op"
],
"properties": {
"op": {
"enum": [
"source_is",
"source_not"
],
"type": "string",
"title": "Segment Operator",
"example": "source_is",
"description": "Whether the member's signup source was/was not a particular value."
},
"field": {
"enum": [
"source"
],
"type": "string",
"title": "Segment Field",
"example": "source"
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "List Import",
"description": "The signup source."
},
"condition_type": {
"enum": [
"SignupSource"
],
"type": "string",
"title": "Type",
"x-value": "SignupSource"
}
},
"description": "Segment by signup source."
},
{
"type": "object",
"title": "Survey Monkey Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"started",
"completed",
"not_started",
"not_completed"
],
"type": "string",
"title": "Segment Operator",
"example": "started",
"description": "The status of the member with regard to the survey.One of the following: has started the survey, has completed the survey, has not started the survey, or has not completed the survey."
},
"field": {
"enum": [
"survey_monkey"
],
"type": "string",
"title": "Segment Field",
"example": "survey_monkey",
"description": "Segment by interaction with a SurveyMonkey survey."
},
"value": {
"type": "string",
"title": "Survey ID",
"example": "32179586",
"description": "The unique ID of the survey monkey survey."
},
"condition_type": {
"enum": [
"SurveyMonkey"
],
"type": "string",
"x-value": "SurveyMonkey"
}
},
"description": "Segment by interaction with a SurveyMonkey survey."
},
{
"type": "object",
"title": "VIP Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Whether the member is or is not marked as VIP."
},
"field": {
"enum": [
"gmonkey"
],
"type": "string",
"title": "Segment Field",
"example": "gmonkey",
"description": "Segment by VIP status."
},
"condition_type": {
"enum": [
"VIP"
],
"type": "string",
"x-value": "VIP"
}
},
"description": "Segment by VIP status."
},
{
"type": "object",
"title": "Interests Segment",
"properties": {
"op": {
"enum": [
"interestcontains",
"interestcontainsall",
"interestnotcontains"
],
"type": "string",
"title": "Segment Operator",
"example": "interestcontains",
"description": "Whether the member is a part of one, all, or none of the groups."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "interests-123",
"description": "Segmenting based on interest group information. This should start with 'interests-' followed by the grouping id. Ex. 'interests-123'."
},
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"44401",
"44405",
"44409"
]
},
"title": "Segment Value",
"description": "An array containing strings, each representing a group id."
},
"condition_type": {
"enum": [
"Interests"
],
"type": "string",
"x-value": "Interests"
}
},
"description": "Segment by an interest group merge field."
},
{
"type": "object",
"title": "Ecommerce Category Segment",
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "A member who has purchased from a category/specific item that is/is not a specific name, where the category/item name contains/doesn't contain a specific phrase or string, or a category/item name that starts/ends with a string."
},
"field": {
"enum": [
"ecomm_cat",
"ecomm_prod"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_cat",
"description": "Segment by purchases in specific items or categories."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "Product",
"description": "The ecommerce category/item information."
},
"condition_type": {
"enum": [
"EcommCategory"
],
"type": "string",
"x-value": "EcommCategory"
}
},
"description": "Segment by purchases in specific items or categories."
},
{
"type": "object",
"title": "Ecommerce Number Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than the segment value."
},
"field": {
"enum": [
"ecomm_spent_avg",
"ecomm_orders",
"ecomm_prod_all",
"ecomm_avg_ord"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_orders",
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 42,
"description": "Members who have spent exactly, have not spent exactly, spent more, or spent less than this amount."
},
"condition_type": {
"enum": [
"EcommNumber"
],
"type": "string",
"x-value": "EcommNumber"
}
},
"description": "Segment by average spent total, number of orders, total number of products purchased, or average number of products per order."
},
{
"type": "object",
"title": "Ecommerce Purchased Segment",
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who have have ('member') or have not ('notmember') purchased."
},
"field": {
"enum": [
"ecomm_purchased"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_purchased",
"description": "Segment by whether someone has purchased anything."
},
"condition_type": {
"enum": [
"EcommPurchased"
],
"type": "string",
"x-value": "EcommPurchased"
}
},
"description": "Segment by whether someone has purchased anything."
},
{
"type": "object",
"title": "Ecommerce Spent Segment",
"properties": {
"op": {
"enum": [
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have spent 'more' or 'less' than then specified value."
},
"field": {
"enum": [
"ecomm_spent_one",
"ecomm_spent_all"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_spent_one",
"description": "Segment by amount spent on a single order or across all orders."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The total amount a member spent."
},
"condition_type": {
"enum": [
"EcommSpent"
],
"type": "string",
"x-value": "EcommSpent"
}
},
"description": "Segment by amount spent on a single order or across all orders."
},
{
"type": "object",
"title": "Ecommerce Purchased Store Segment",
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who have or have not purchased from a specific store."
},
"field": {
"enum": [
"ecomm_store"
],
"type": "string",
"title": "Segment Field",
"example": "ecomm_store",
"description": "Segment by purchases from a specific store."
},
"value": {
"type": "string",
"title": "Segment Operator",
"example": "289",
"description": "The store id to segment against."
},
"condition_type": {
"enum": [
"EcommStore"
],
"type": "string",
"x-value": "EcommStore"
}
},
"description": "Segment by purchases from a specific store."
},
{
"type": "object",
"title": "Goal Activity Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"goal_not",
"contains",
"goal_notcontain",
"starts",
"ends"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the website URL is/not exactly, contains/doesn't contain, starts with/ends with a string."
},
"field": {
"enum": [
"goal"
],
"type": "string",
"title": "Segment Field",
"example": "goal",
"description": "Segment by Goal activity."
},
"value": {
"type": "string",
"title": "Segment Value",
"description": "The URL to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalActivity"
],
"type": "string",
"x-value": "GoalActivity"
}
},
"description": "Segment by Goal activity."
},
{
"type": "object",
"title": "Goal Timestamp Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"greater",
"less",
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Whether the website activity happened after, before, or at a given timestamp."
},
"field": {
"enum": [
"goal_last_visited"
],
"type": "string",
"title": "Segment Field",
"example": "goal_last_visited",
"description": "Segment by most recent interaction with a website."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "2015-07-20 19:45:21",
"description": "The date to check Goal activity against."
},
"condition_type": {
"enum": [
"GoalTimestamp"
],
"type": "string",
"x-value": "GoalTimestamp"
}
},
"description": "Segment by most recent interaction with a website."
},
{
"type": "object",
"title": "Similar Subscribers Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"fuzzy_is",
"fuzzy_not"
],
"type": "string",
"title": "Segment Operator",
"example": "fuzzy_is",
"description": "Members who are/are not apart of a 'similar subscribers' segment."
},
"field": {
"enum": [
"fuzzy_segment"
],
"type": "string",
"title": "Segment Field",
"example": "fuzzy_segment",
"description": "Segment by similar subscribers."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the 'similar subscribers' segment."
},
"condition_type": {
"enum": [
"FuzzySegment"
],
"type": "string",
"x-value": "FuzzySegment"
}
},
"description": "Segment by similar subscribers."
},
{
"type": "object",
"title": "Static Segment Member Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"static_is",
"static_not"
],
"type": "string",
"title": "Segment Operator",
"example": "static_is",
"description": "Members who are/are not apart of a static segment."
},
"field": {
"enum": [
"static_segment"
],
"type": "string",
"title": "Segment Field",
"example": "static_segment",
"description": "Segment by a given static segment."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 48433,
"description": "The id for the static segment."
},
"condition_type": {
"enum": [
"StaticSegment"
],
"type": "string",
"x-value": "StaticSegment"
}
},
"description": "Segment by a given static segment."
},
{
"type": "object",
"title": "Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeocountry",
"ipgeonotcountry",
"ipgeostate",
"ipgeonotstate"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeocountry",
"description": "Segment members who are within a specific country or US state."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "string",
"title": "Segment Data",
"example": "US",
"description": "The two-letter country code or US state abbreviation."
},
"condition_type": {
"enum": [
"IPGeoCountryState"
],
"type": "string",
"x-value": "IPGeoCountryState"
}
},
"description": "Segment by a specific country or US state."
},
{
"type": "object",
"title": "Geolocation Segment",
"required": [
"field",
"op",
"value",
"addr",
"lat",
"lng"
],
"properties": {
"op": {
"enum": [
"ipgeoin",
"ipgeonotin"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoin",
"description": "Segment members who are within a specific geographic region."
},
"lat": {
"type": "string",
"title": "Segment Location Latitude",
"example": "33.7489954",
"description": "The latitude of the target location."
},
"lng": {
"type": "string",
"title": "Segment Location Longitude",
"example": "-84.3879824",
"description": "The longitude of the target location."
},
"addr": {
"type": "string",
"title": "Segment Location Address",
"example": "Atlanta, GA, USA",
"description": "The address of the target location."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 42,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoIn"
],
"type": "string",
"x-value": "IPGeoIn"
}
},
"description": "Segment by a specific geographic region."
},
{
"type": "object",
"title": "US Zip Code Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"ipgeoinzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeoinzip",
"description": "Segment members who are within a specific US zip code."
},
"extra": {
"type": "integer",
"title": "Extra Data",
"example": 30318,
"description": "The zip code to segment against."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 25,
"description": "The radius of the target location."
},
"condition_type": {
"enum": [
"IPGeoInZip"
],
"type": "string",
"x-value": "IPGeoInZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Unknown Location-Based Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"ipgeounknown"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeounknown",
"description": "Segment members for which location information is unknown."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"condition_type": {
"enum": [
"IPGeoUnknown"
],
"type": "string",
"x-value": "IPGeoUnknown"
}
},
"description": "Segment members whose location information is unknown."
},
{
"type": "object",
"title": "Zip Code Location-Based Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"ipgeoiszip",
"ipgeonotzip"
],
"type": "string",
"title": "Segment Operator",
"example": "ipgeonotzip",
"description": "Segment members who are/are not within a specific US zip code."
},
"field": {
"enum": [
"ipgeo"
],
"type": "string",
"title": "Segment Field",
"example": "ipgeo",
"description": "Segmenting subscribers who are within a specific location."
},
"value": {
"type": "integer",
"title": "Segment Data",
"example": 30318,
"description": "The 5-digit zip code."
},
"condition_type": {
"enum": [
"IPGeoZip"
],
"type": "string",
"x-value": "IPGeoZip"
}
},
"description": "Segment by a specific US ZIP code."
},
{
"type": "object",
"title": "Social Profiles Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_age"
],
"type": "string",
"title": "Segment Field",
"example": "social_age",
"description": "Segment by age ranges in Social Profiles data."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-54",
"55+"
],
"type": "string",
"title": "Segment Operator",
"example": "35-54",
"description": "The age range to segment."
},
"condition_type": {
"enum": [
"SocialAge"
],
"type": "string",
"x-value": "SocialAge"
}
},
"description": "Segment by age ranges in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"social_gender"
],
"type": "string",
"title": "Segment Field",
"example": "social_gender",
"description": "Segment by listed gender in Social Profiles data."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The Social Profiles gender to segment."
},
"condition_type": {
"enum": [
"SocialGender"
],
"type": "string",
"x-value": "SocialGender"
}
},
"description": "Segment by listed gender in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Influence Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"example": "greater",
"description": "Members who have a rating that is/not or greater/less than the rating provided."
},
"field": {
"enum": [
"social_influence"
],
"type": "string",
"title": "Segment Field",
"example": "social_influence",
"description": "Segment by influence rating in Social Profiles data."
},
"value": {
"type": "number",
"title": "Segment Operator",
"example": 2,
"description": "The Social Profiles influence rating to segment."
},
"condition_type": {
"enum": [
"SocialInfluence"
],
"type": "string",
"x-value": "SocialInfluence"
}
},
"description": "Segment by influence rating in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"member",
"notmember"
],
"type": "string",
"title": "Segment Operator",
"example": "member",
"description": "Members who are/not on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter",
"facebook",
"linkedin",
"flickr",
"foursquare",
"lastfm",
"myspace",
"quora",
"vimeo",
"yelp",
"youtube"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkMember"
],
"type": "string",
"x-value": "SocialNetworkMember"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Social Profiles Social Network Follow Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"follow",
"notfollow"
],
"type": "string",
"title": "Segment Operator",
"example": "follow",
"description": "Members who are/not following a linked account on a given social network."
},
"field": {
"enum": [
"social_network"
],
"type": "string",
"title": "Segment Field",
"example": "social_network",
"description": "Segment by social network in Social Profiles data."
},
"value": {
"enum": [
"twitter_follow"
],
"type": "string",
"title": "Segment Operator",
"example": "twitter_follow",
"description": "The social network to segment against."
},
"condition_type": {
"enum": [
"SocialNetworkFollow"
],
"type": "string",
"x-value": "SocialNetworkFollow"
}
},
"description": "Segment by social network in Social Profiles data."
},
{
"type": "object",
"title": "Address Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"contains",
"notcontain",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's address merge field contains/does not contain a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE3",
"description": "An address-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Atlanta",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"AddressMerge"
],
"type": "string",
"x-value": "AddressMerge"
}
},
"description": "Segment by an address-type merge field."
},
{
"type": "object",
"title": "Address/Zip Merge Field Segment",
"required": [
"field",
"op",
"value",
"extra"
],
"properties": {
"op": {
"enum": [
"geoin"
],
"type": "string",
"title": "Segment Operator",
"example": "geoin",
"description": "Whether the member's address merge field is within a given distance from a city or zip."
},
"extra": {
"type": "string",
"title": "Segment Extra",
"example": "30318",
"description": "The city or the zip being used to segment against."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE2",
"description": "An address or zip-type merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "25",
"description": "The distance from the city/zip."
},
"condition_type": {
"enum": [
"ZipMerge"
],
"type": "string",
"x-value": "ZipMerge"
}
},
"description": "Segment by an address-type merge field within a given distance."
},
{
"type": "object",
"title": "Birthday Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's birthday merge information is/is not a certain date or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE4",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30",
"description": "A date to segment against (mm/dd)."
},
"condition_type": {
"enum": [
"BirthdayMerge"
],
"type": "string",
"x-value": "BirthdayMerge"
}
},
"description": "Segment by a contact's birthday."
},
{
"type": "object",
"title": "Date Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"less",
"blank",
"blank_not",
"greater"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not, is greater/less than a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE5",
"description": "A date merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "01/30/2015",
"description": "A date to segment against."
},
"condition_type": {
"enum": [
"DateMerge"
],
"type": "string",
"x-value": "DateMerge"
}
},
"description": "Segment by a given date merge field."
},
{
"type": "object",
"title": "Dropdown/Radio Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"blank",
"blank_not",
"notcontain",
"contains"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Whether the member's merge information is/is not a value or is/is not blank."
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE6",
"description": "A merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Second Choice",
"description": "The value to segment a text merge field with."
},
"condition_type": {
"enum": [
"SelectMerge"
],
"type": "string",
"x-value": "SelectMerge"
}
},
"description": "An individual segment condition"
},
{
"type": "object",
"title": "Text or Number Merge Field Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less",
"blank",
"blank_not"
],
"type": "string",
"title": "Segment Operator",
"example": "contains",
"description": "Whether the member's merge information is/is not, contains/does not contain, starts/ends with, or is greater/less than a value"
},
"field": {
"type": "string",
"title": "Segment Field",
"example": "MMERGE7",
"description": "A text or number merge field to segment."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "Freddie's Jokes",
"description": "The value to segment a text or number merge field with."
},
"condition_type": {
"enum": [
"TextMerge"
],
"type": "string",
"x-value": "TextMerge"
}
},
"description": "Segment by a given text or number merge field."
},
{
"type": "object",
"title": "Email Segment",
"required": [
"field",
"op"
],
"properties": {
"op": {
"enum": [
"is",
"not",
"contains",
"notcontain",
"starts",
"ends",
"greater",
"less"
],
"type": "string",
"title": "Segment Operator",
"description": "Whether the email address is/not exactly, contains/doesn't contain, starts/ends with a string."
},
"field": {
"enum": [
"merge0",
"EMAIL"
],
"type": "string",
"title": "Segment Field",
"example": "EMAIL",
"description": "Segmenting based off of a subscriber's email address."
},
"value": {
"type": "string",
"title": "Segment Value",
"example": "urist.mcvankab@freddiesjokes.com",
"description": "The value to compare the email against."
},
"condition_type": {
"enum": [
"EmailAddress"
],
"type": "string",
"x-value": "EmailAddress"
}
},
"description": "Segment by email address."
},
{
"type": "object",
"title": "Predicted Gender Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is",
"not"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_gender"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted gender."
},
"value": {
"enum": [
"male",
"female"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted gender to segment."
},
"condition_type": {
"enum": [
"PredictedGender"
],
"type": "string",
"x-value": "PredictedGender"
}
},
"description": "Segment by predicted gender."
},
{
"type": "object",
"title": "Predicted Age Segment",
"required": [
"field",
"op",
"value"
],
"properties": {
"op": {
"enum": [
"is"
],
"type": "string",
"title": "Segment Operator",
"example": "is",
"description": "Members who are/not the exact criteria listed."
},
"field": {
"enum": [
"predicted_age_range"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by predicted age."
},
"value": {
"enum": [
"18-24",
"25-34",
"35-44",
"45-54",
"55-64",
"65+"
],
"type": "string",
"title": "Segment Operator",
"example": "female",
"description": "The predicted age to segment."
},
"condition_type": {
"enum": [
"PredictedAge"
],
"type": "string",
"x-value": "PredictedAge"
}
},
"description": "Segment by predicted age."
},
{
"type": "object",
"title": "New Subscribers Prebuilt Segment",
"properties": {
"op": {
"enum": [
"date_within"
],
"type": "string",
"title": "Segment Operator",
"description": "Whe the event took place, namely within a time frame."
},
"field": {
"enum": [
"timestamp_opt"
],
"type": "string",
"title": "Segment Field",
"description": "Segment by when people subscribed."
},
"value": {
"type": "string",
"title": "Segment Data",
"description": "What type of data to segment on: a specific date, a specific campaign, or the last campaign sent."
},
"condition_type": {
"enum": [
"NewSubscribers"
],
"type": "string",
"x-value": "NewSubscribers"
}
},
"description": "Segment by when people subscribed."
}
],
"discriminator": {
"type": "string",
"propertyName": "condition_type"
}
},
"title": "Segment Type",
"description": "Segment match conditions. There are multiple possible types, see the [condition types documentation](https://mailchimp.com/developer/marketing/docs/alternative-schemas/#segment-condition-schemas)."
},
"saved_segment_id": {
"type": "integer",
"title": "Saved Segment ID",
"description": "The id for an existing saved segment."
},
"prebuilt_segment_id": {
"type": "string",
"title": "Prebuilt Segment Id",
"example": "subscribers-female",
"description": "The prebuilt segment id, if a prebuilt segment has been designated for this campaign."
}
},
"description": "An object representing all segmentation options. This object should contain a `saved_segment_id` to use an existing segment, or you can create a new segment by including both `match` and `conditions` options."
},
"segment_text": {
"type": "string",
"title": "Segment Text",
"readOnly": true,
"description": "A description of the [segment](https://mailchimp.com/help/save-and-manage-segments/) used for the campaign. Formatted as a string marked up with HTML."
},
"recipient_count": {
"type": "integer",
"title": "Recipient Count",
"readOnly": true,
"description": "Count of the recipients on the associated list. Formatted as an integer."
}
},
"description": "List settings for the campaign."
},
"resendable": {
"type": "boolean",
"title": "Resendable",
"readOnly": true,
"description": "Determines if the campaign qualifies to be resent to non-openers."
},
"archive_url": {
"type": "string",
"title": "Archive URL",
"readOnly": true,
"description": "The link to the campaign's archive version."
},
"create_time": {
"type": "string",
"title": "Create Time",
"format": "date-time",
"readOnly": true,
"description": "The date and time the campaign was created in ISO 8601 format."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails sent for this campaign."
},
"social_card": {
"type": "object",
"title": "Campaign Social Card",
"properties": {
"title": {
"type": "string",
"title": "Title",
"description": "The title for the card. Typically the subject line of the campaign."
},
"image_url": {
"type": "string",
"title": "Image URL",
"description": "The url for the header image for the card."
},
"description": {
"type": "string",
"title": "Campaign Description",
"description": "A short summary of the campaign to display."
}
},
"description": "The preview for the campaign, rendered by social networks like Facebook and Twitter. [Learn more](https://mailchimp.com/help/enable-and-customize-social-cards/)."
},
"content_type": {
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the campaign's content is put together ('template', 'drag_and_drop', 'html', 'url')."
},
"ab_split_opts": {
"type": "object",
"title": "A/B Testing Options",
"readOnly": true,
"properties": {
"subject_a": {
"type": "string",
"title": "Subject Line Group A",
"description": "For campaigns split on 'Subject Line', the subject line for Group A."
},
"subject_b": {
"type": "string",
"title": "Subject Line Group B",
"description": "For campaigns split on 'Subject Line', the subject line for Group B."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The amount of time to wait before picking a winner. This cannot be changed after a campaign is sent."
},
"split_size": {
"type": "integer",
"title": "Split Size",
"maximum": 50,
"minimum": 1,
"description": "The size of the split groups. Campaigns split based on 'schedule' are forced to have a 50/50 split. Valid split integers are between 1-50."
},
"split_test": {
"enum": [
"subject",
"from_name",
"schedule"
],
"type": "string",
"title": "Split Test",
"description": "The type of AB split to run."
},
"wait_units": {
"enum": [
"hours",
"days"
],
"type": "string",
"title": "Wait Time",
"description": "How unit of time for measuring the winner ('hours' or 'days'). This cannot be changed after a campaign is sent."
},
"from_name_a": {
"type": "string",
"title": "From Name Group A",
"description": "For campaigns split on 'From Name', the name for Group A."
},
"from_name_b": {
"type": "string",
"title": "From Name Group B",
"description": "For campaigns split on 'From Name', the name for Group B."
},
"pick_winner": {
"enum": [
"opens",
"clicks",
"manual"
],
"type": "string",
"title": "Pick Winner",
"description": "How we should evaluate a winner. Based on 'opens', 'clicks', or 'manual'."
},
"send_time_a": {
"type": "string",
"title": "Send Time Group A",
"format": "date-time",
"description": "The send time for Group A."
},
"send_time_b": {
"type": "string",
"title": "Send Time Group B",
"format": "date-time",
"description": "The send time for Group B."
},
"reply_email_a": {
"type": "string",
"title": "Reply Email Group A",
"description": "For campaigns split on 'From Name', the reply-to address for Group A."
},
"reply_email_b": {
"type": "string",
"title": "Reply Email Group B",
"description": "For campaigns split on 'From Name', the reply-to address for Group B."
},
"send_time_winner": {
"type": "string",
"title": "Send Time Winner",
"description": "The send time for the winning version."
}
},
"description": "[A/B Testing](https://mailchimp.com/help/about-ab-testing-campaigns/) options for a campaign."
},
"report_summary": {
"type": "object",
"title": "Campaign Report Summary",
"properties": {
"opens": {
"type": "integer",
"title": "Automation Opens",
"readOnly": true,
"description": "The total number of opens for a campaign."
},
"clicks": {
"type": "integer",
"title": "Total Clicks",
"readOnly": true,
"description": "The total number of clicks for an campaign."
},
"ecommerce": {
"type": "object",
"title": "E-Commerce Report",
"properties": {
"total_spent": {
"type": "number",
"title": "Total Spent",
"readOnly": true,
"description": "The total spent for a campaign. Calculated as the sum of all order totals with no deductions."
},
"total_orders": {
"type": "integer",
"title": "Total Orders",
"readOnly": true,
"description": "The total orders for a campaign."
},
"total_revenue": {
"type": "number",
"title": "Total Revenue",
"readOnly": true,
"description": "The total revenue for a campaign. Calculated as the sum of all order totals minus shipping and tax totals."
}
},
"description": "E-Commerce stats for a campaign."
},
"open_rate": {
"type": "number",
"title": "Open Rate",
"readOnly": true,
"description": "The number of unique opens divided by the total number of successful deliveries."
},
"click_rate": {
"type": "number",
"title": "Click Rate",
"readOnly": true,
"description": "The number of unique clicks divided by the total number of successful deliveries."
},
"unique_opens": {
"type": "integer",
"title": "Unique Opens",
"readOnly": true,
"description": "The number of unique opens."
},
"subscriber_clicks": {
"type": "integer",
"title": "Unique Subscriber Clicks",
"readOnly": true,
"description": "The number of unique clicks."
}
},
"description": "For sent campaigns, a summary of opens and clicks."
},
"delivery_status": {
"type": "object",
"title": "Campaign Delivery Status",
"properties": {
"status": {
"enum": [
"delivering",
"delivered",
"canceling",
"canceled"
],
"type": "string",
"title": "Campaign Delivery Status",
"readOnly": true,
"description": "The current state of a campaign delivery."
},
"enabled": {
"type": "boolean",
"title": "Delivery Status Enabled",
"readOnly": true,
"description": "Whether Campaign Delivery Status is enabled for this account and campaign."
},
"can_cancel": {
"type": "boolean",
"title": "Campaign Cancelable",
"readOnly": true,
"description": "Whether a campaign send can be canceled."
},
"emails_sent": {
"type": "integer",
"title": "Emails Sent",
"readOnly": true,
"description": "The total number of emails confirmed sent for this campaign so far."
},
"emails_canceled": {
"type": "integer",
"title": "Emails Canceled",
"readOnly": true,
"description": "The total number of emails canceled for this campaign."
}
},
"description": "Updates on campaigns in the process of sending."
},
"long_archive_url": {
"type": "string",
"title": "Long Archive URL",
"readOnly": true,
"description": "The original link to the campaign's archive version."
},
"variate_settings": {
"type": "object",
"title": "A/B Test Options",
"required": [
"winner_criteria"
],
"properties": {
"contents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Content Descriptions",
"readOnly": true,
"description": "Descriptions of possible email contents. To set campaign contents, make a PUT request to /campaigns/{campaign_id}/content with the field 'variate_contents'."
},
"test_size": {
"type": "integer",
"title": "Test Size",
"description": "The percentage of recipients to send the test combinations to, must be a value between 10 and 100."
},
"wait_time": {
"type": "integer",
"title": "Wait Time",
"description": "The number of minutes to wait before choosing the winning campaign. The value of wait_time must be greater than 0 and in whole hours, specified in minutes."
},
"from_names": {
"type": "array",
"items": {
"type": "string"
},
"title": "From Names",
"description": "The possible from names. The number of from_names provided must match the number of reply_to_addresses. If no from_names are provided, settings.from_name will be used."
},
"send_times": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"title": "Send Times",
"description": "The possible send times to test. The times provided should be in the format YYYY-MM-DD HH:MM:SS. If send_times are provided to test, the test_size will be set to 100% and winner_criteria will be ignored."
},
"combinations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "ID",
"description": "Unique ID for the combination."
},
"reply_to": {
"type": "integer",
"title": "Reply To",
"description": "The index of `variate_settings.reply_to_addresses` used."
},
"from_name": {
"type": "integer",
"title": "From Name",
"description": "The index of `variate_settings.from_names` used."
},
"send_time": {
"type": "integer",
"title": "Send Time",
"description": "The index of `variate_settings.send_times` used."
},
"recipients": {
"type": "integer",
"title": "Recipients",
"description": "The number of recipients for this combination."
},
"subject_line": {
"type": "integer",
"title": "Subject Line",
"description": "The index of `variate_settings.subject_lines` used."
},
"content_description": {
"type": "integer",
"title": "Content Description",
"description": "The index of `variate_settings.contents` used."
}
}
},
"title": "Combinations",
"readOnly": true,
"description": "Combinations of possible variables used to build emails."
},
"subject_lines": {
"type": "array",
"items": {
"type": "string"
},
"title": "Subject Lines",
"description": "The possible subject lines to test. If no subject lines are provided, settings.subject_line will be used."
},
"winner_criteria": {
"enum": [
"opens",
"clicks",
"manual",
"total_revenue"
],
"type": "string",
"title": "Winning Criteria",
"description": "The combination that performs the best. This may be determined automatically by click rate, open rate, or total revenue -- or you may choose manually based on the reporting data you find the most valuable. For Multivariate Campaigns testing send_time, winner_criteria is ignored. For Multivariate Campaigns with 'manual' as the winner_criteria, the winner must be chosen in the Mailchimp web application."
},
"reply_to_addresses": {
"type": "array",
"items": {
"type": "string"
},
"title": "Reply To Addresses",
"description": "The possible reply-to addresses. The number of reply_to_addresses provided must match the number of from_names. If no reply_to_addresses are provided, settings.reply_to will be used."
},
"winning_campaign_id": {
"type": "string",
"title": "Winning Campaign ID",
"readOnly": true,
"description": "ID of the campaign that was sent to the remaining recipients based on the winning combination."
},
"winning_combination_id": {
"type": "string",
"title": "Winning Combination ID",
"readOnly": true,
"description": "ID for the winning combination."
}
},
"description": "The settings specific to A/B test campaigns."
},
"parent_campaign_id": {
"type": "string",
"title": "Parent Campaign ID",
"readOnly": true,
"description": "If this campaign is the child of another campaign, this identifies the parent campaign. For Example, for RSS or Automation children."
},
"needs_block_refresh": {
"type": "boolean",
"title": "Needs Block Refresh",
"readOnly": true,
"description": "Determines if the campaign needs its blocks refreshed by opening the web-based campaign editor. Deprecated and will always return false."
}
},
"description": "A summary of an individual campaign's settings and content."
}
SurveysGenerateCampaigndefaultResponse
{
"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'."
}
SurveysPublishSurveyActionResponse
{
"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'."
}
SurveysPublishSurveyActiondefaultResponse
{
"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'."
}
SurveysUnpublishSurveyActionResponse
{
"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'."
}
SurveysUnpublishSurveyActiondefaultResponse
{
"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'."
}
TemplateFoldersAddNewFolder200Response
{
"type": "object",
"title": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
}
TemplateFoldersAddNewFolderRequest
{
"type": "object",
"title": "Template Folder",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
}
},
"description": "A folder used to organize templates."
}
TemplateFoldersAddNewFolderResponse
{
"type": "object",
"title": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
}
TemplateFoldersAddNewFolderdefaultResponse
{
"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'."
}
TemplateFoldersDeleteSpecificFolderResponse
{
"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'."
}
TemplateFoldersDeleteSpecificFolderdefaultResponse
{
"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'."
}
TemplateFoldersGetInfo200Response
{
"type": "object",
"title": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
}
TemplateFoldersGetInfoResponse
{
"type": "object",
"title": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
}
TemplateFoldersGetInfodefaultResponse
{
"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'."
}
TemplateFoldersListFolders200Response
{
"type": "object",
"title": "Template 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": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
},
"title": "Template Folders",
"description": "An array of objects representing template folders."
},
"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 template folders"
}
TemplateFoldersListFoldersResponse
{
"type": "object",
"title": "Template 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": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
},
"title": "Template Folders",
"description": "An array of objects representing template folders."
},
"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 template folders"
}
TemplateFoldersListFoldersdefaultResponse
{
"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'."
}
TemplateFoldersUpdateSpecificFolder200Response
{
"type": "object",
"title": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
}
TemplateFoldersUpdateSpecificFolderResponse
{
"type": "object",
"title": "Template Folder",
"properties": {
"id": {
"type": "string",
"title": "Folder Id",
"readOnly": true,
"description": "A string that uniquely identifies this template folder."
},
"name": {
"type": "string",
"title": "Folder Name",
"description": "The name of the folder."
},
"count": {
"type": "integer",
"title": "Template Count",
"readOnly": true,
"description": "The number of templates in 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."
}
},
"description": "A folder used to organize templates."
}
TemplateFoldersUpdateSpecificFolderdefaultResponse
{
"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'."
}
TemplatesCreateNewTemplate200Response
{
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
}
TemplatesCreateNewTemplateRequest
{
"type": "object",
"title": "Template Instance",
"required": [
"name",
"html"
],
"properties": {
"html": {
"type": "string",
"title": "Template HTML",
"description": "The raw HTML for the template. We support the Mailchimp [Template Language](https://mailchimp.com/help/getting-started-with-mailchimps-template-language/) in any HTML code passed via the API."
},
"name": {
"type": "string",
"title": "Template Name",
"example": "Freddie's Jokes",
"description": "The name of the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"example": "a4b830b",
"description": "The id of the folder the template is currently in."
}
},
"description": "Information about a specific template."
}
TemplatesCreateNewTemplateResponse
{
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
}
TemplatesCreateNewTemplatedefaultResponse
{
"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'."
}
TemplatesDeleteSpecificTemplateResponse
{
"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'."
}
TemplatesDeleteSpecificTemplatedefaultResponse
{
"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'."
}
TemplatesGetInfo200Response
{
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
}
TemplatesGetInfoResponse
{
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
}
TemplatesGetInfodefaultResponse
{
"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'."
}
TemplatesListAvailableTemplates200Response
{
"type": "object",
"title": "Templates",
"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."
},
"templates": {
"type": "array",
"items": {
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
},
"title": "User Templates",
"description": "All of an account's saved or custom templates."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list an account's available templates."
}
TemplatesListAvailableTemplatesResponse
{
"type": "object",
"title": "Templates",
"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."
},
"templates": {
"type": "array",
"items": {
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
},
"title": "User Templates",
"description": "All of an account's saved or custom templates."
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "A list an account's available templates."
}
TemplatesListAvailableTemplatesdefaultResponse
{
"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'."
}
TemplatesUpdateTemplateById200Response
{
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
}
TemplatesUpdateTemplateByIdResponse
{
"type": "object",
"title": "Template Instance",
"properties": {
"id": {
"type": "integer",
"title": "Template ID",
"readOnly": true,
"description": "The individual id for the template."
},
"name": {
"type": "string",
"title": "Template Name",
"description": "The name of the template."
},
"type": {
"type": "string",
"title": "Template Type",
"readOnly": true,
"description": "The type of template (user, base, or gallery)."
},
"_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."
},
"active": {
"type": "boolean",
"title": "Active",
"readOnly": true,
"description": "User templates are not 'deleted,' but rather marked as 'inactive.' Returns whether the template is still active."
},
"category": {
"type": "string",
"title": "Template Category",
"readOnly": true,
"description": "If available, the category the template is listed in."
},
"edited_by": {
"type": "string",
"title": "Edited By",
"readOnly": true,
"description": "The login name who last edited the template."
},
"folder_id": {
"type": "string",
"title": "Folder ID",
"description": "The id of the folder the template is currently in."
},
"share_url": {
"type": "string",
"title": "Share URL",
"readOnly": true,
"description": "The URL used for [template sharing](https://mailchimp.com/help/share-a-template/)."
},
"thumbnail": {
"type": "string",
"title": "Template Thumbnail",
"readOnly": true,
"description": "If available, the URL for a thumbnail of the template."
},
"created_by": {
"type": "string",
"title": "Created By",
"readOnly": true,
"description": "The login name for template's creator."
},
"responsive": {
"type": "boolean",
"title": "Responsive",
"readOnly": true,
"description": "Whether the template contains media queries to make it responsive."
},
"date_edited": {
"type": "string",
"title": "Date Edited",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was edited in ISO 8601 format."
},
"content_type": {
"enum": [
"template",
"multichannel",
"html"
],
"type": "string",
"title": "Content Type",
"readOnly": true,
"description": "How the template's content is put together."
},
"date_created": {
"type": "string",
"title": "Date Created",
"format": "date-time",
"readOnly": true,
"description": "The date and time the template was created in ISO 8601 format."
},
"drag_and_drop": {
"type": "boolean",
"title": "Drag and Drop",
"readOnly": true,
"description": "Whether the template uses the drag and drop editor."
}
},
"description": "Information about a specific template."
}
TemplatesUpdateTemplateByIddefaultResponse
{
"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'."
}
TemplatesViewDefaultContent200Response
{
"type": "object",
"title": "Template Default Content",
"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."
},
"sections": {
"type": "object",
"title": "Sections",
"description": "The sections that you can edit in the template, including each section's default content.",
"additionalProperties": {
"description": "The default content for the sections that you can edit in the template."
}
}
},
"description": "Default content for a template."
}
TemplatesViewDefaultContentResponse
{
"type": "object",
"title": "Template Default Content",
"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."
},
"sections": {
"type": "object",
"title": "Sections",
"description": "The sections that you can edit in the template, including each section's default content.",
"additionalProperties": {
"description": "The default content for the sections that you can edit in the template."
}
}
},
"description": "Default content for a template."
}
TemplatesViewDefaultContentdefaultResponse
{
"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'."
}
VerifiedDomainsAddDomainToAccount200Response
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsAddDomainToAccountRequest
{
"type": "object",
"title": "Verified Domains",
"required": [
"verification_email"
],
"properties": {
"verification_email": {
"type": "string",
"title": "Verification Email",
"description": "The e-mail address at the domain you want to verify. This will receive a two-factor challenge to be used in the verify action."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsAddDomainToAccountResponse
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsAddDomainToAccountdefaultResponse
{
"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'."
}
VerifiedDomainsDeleteDomainResponse
{
"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'."
}
VerifiedDomainsDeleteDomaindefaultResponse
{
"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'."
}
VerifiedDomainsGetInfo200Response
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsGetInfoResponse
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsGetInfodefaultResponse
{
"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'."
}
VerifiedDomainsListSendingDomains200Response
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domains": {
"type": "array",
"items": {
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
},
"title": "Domains",
"readOnly": true,
"description": "The domains on the account"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsListSendingDomainsResponse
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domains": {
"type": "array",
"items": {
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
},
"title": "Domains",
"readOnly": true,
"description": "The domains on the account"
},
"total_items": {
"type": "integer",
"title": "Item Count",
"readOnly": true,
"description": "The total number of items matching the query regardless of pagination."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsListSendingDomainsdefaultResponse
{
"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'."
}
VerifiedDomainsVerifyDomainForSending200Response
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsVerifyDomainForSendingRequest
{
"type": "object",
"title": "Verify a domain for sending.",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"title": "Verification Code",
"description": "The code that was sent to the email address provided when adding a new domain to verify."
}
},
"description": "Submit a response to the verification challenge and verify a domain for sending."
}
VerifiedDomainsVerifyDomainForSendingResponse
{
"type": "object",
"title": "Verified Domains",
"properties": {
"domain": {
"type": "string",
"title": "Domain Name",
"readOnly": true,
"description": "The name of this domain."
},
"verified": {
"type": "boolean",
"title": "Verified",
"readOnly": true,
"description": "Whether the domain has been verified for sending."
},
"authenticated": {
"type": "boolean",
"title": "Authenticated",
"readOnly": true,
"description": "Whether domain authentication is enabled for this domain."
},
"verification_sent": {
"type": "string",
"title": "Verification Challenge Sent",
"format": "date-time",
"readOnly": true,
"description": "The date/time that the two-factor challenge was sent to the verification email."
},
"verification_email": {
"type": "string",
"title": "Verification Email",
"readOnly": true,
"description": "The e-mail address receiving the two-factor challenge for this domain."
}
},
"description": "The verified domains currently on the account."
}
VerifiedDomainsVerifyDomainForSendingdefaultResponse
{
"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'."
}