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."
}