"""Request Body Schemas for API Tools

DO NOT EDIT THIS MODULE DIRECTLY.

THIS MODULE WAS AUTO-GENERATED AND CONTAINS OpenAPI REQUEST BODY SCHEMAS
FOR TOOLS WITH COMPLEX REQUEST BODIES. ANY CHANGES TO THIS MODULE WILL
BE OVERWRITTEN BY THE TRANSPILER.
"""

from typing import Any

REQUEST_BODY_SCHEMAS: dict[str, Any] = {
    "UPDATECAMPAIGNBATCH": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["id", "properties"], "type": "object", "properties": {"id": {"type": "string"}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}',
    "FETCHMARKETINGCAMPAIGNBATCHES": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string"}}}}}}',
    "CREATEMARKETINGCAMPAIGN": '{"required": ["properties"], "type": "object", "properties": {"properties": {"type": "object", "additionalProperties": {"type": "string"}}}}',
    "ARCHIVECAMPAIGNSBATCH": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["id"], "type": "object", "properties": {"id": {"type": "string"}}}}}}',
    "CREATEMARKETINGCAMPAIGNBATCH": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["properties"], "type": "object", "properties": {"properties": {"type": "object", "additionalProperties": {"type": "string"}}}}}}}',
    "UPDATECAMPAIGNPROPERTIES": '{"required": ["properties"], "type": "object", "properties": {"properties": {"type": "object", "additionalProperties": {"type": "string"}}}}',
    "UPDATEHUBSPOTFORM": '{"properties": {}, "allOf": [{"properties": {}, "oneOf": [{"$ref": "#/components/schemas/HubSpotFormDefinition", "has_circular_reference": true}]}, {"required": ["archived", "configuration", "createdAt", "displayOptions", "fieldGroups", "formType", "id", "legalConsentOptions", "name", "updatedAt"], "type": "object", "properties": {"formType": {"type": "string", "default": "hubspot", "enum": ["hubspot"]}, "id": {"type": "string"}, "name": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "archived": {"type": "boolean"}, "archivedAt": {"type": "string", "format": "date-time"}, "fieldGroups": {"type": "array", "items": {"required": ["fields", "groupType", "richTextType"], "type": "object", "properties": {"groupType": {"type": "string", "enum": ["default_group", "progressive", "queued"]}, "richTextType": {"type": "string", "description": "The type of rich text included. The default value is text.", "enum": ["text", "image"]}, "richText": {"type": "string", "description": "A block of rich text or an image. Those can be used to add extra information for the customers filling in the form. If the field group includes fields, the rich text will be displayed before the fields."}, "fields": {"type": "array", "description": "The form fields included in the group", "items": {"oneOf": [{"title": "email", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"required": ["dependentCondition", "dependentField"], "type": "object", "properties": {"dependentCondition": {"required": ["operator", "rangeEnd", "rangeStart", "value", "values"], "type": "object", "properties": {"rangeStart": {"type": "string"}, "values": {"type": "array", "items": {"type": "string"}}, "value": {"type": "string"}, "operator": {"type": "string", "enum": ["eq", "neq", "contains", "doesnt_contain", "str_starts_with", "str_ends_with", "lt", "lte", "gt", "gte", "between", "not_between", "within_time_reverse", "within_time", "set_any", "set_not_any", "set_all", "set_not_all", "set_eq", "set_neq", "is_not_empty"]}, "rangeEnd": {"type": "string"}}, "description": "A condition based on customer input"}, "dependentField": {"oneOf": [{"$ref": "#/components/schemas/EmailField", "has_circular_reference": true}, {"title": "phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "useCountryCodeSelect", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "useCountryCodeSelect": {"type": "boolean", "description": "Whether to display a country code drop down next to the phone field."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "phone", "enum": ["phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a phone number."}, {"title": "mobile_phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "mobile_phone", "enum": ["mobile_phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a mobile phone number."}, {"title": "single_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_line_text", "enum": ["single_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single-line text box."}, {"title": "multi_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multi_line_text", "enum": ["multi_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a multiple-line text box."}, {"title": "number", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "number", "enum": ["number"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a numeric value should be validated."}}, "description": "A form field used for collecting a numeric value."}, {"title": "single_checkbox", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_checkbox", "enum": ["single_checkbox"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single checkbox."}, {"title": "multiple_checkboxes", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multiple_checkboxes", "enum": ["multiple_checkboxes"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of checkboxes allowing multiple choices to be selected at one time."}, {"title": "dropdown", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "dropdown", "enum": ["dropdown"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A field consisting of a drop down with multiple choices."}, {"title": "radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "radio", "enum": ["radio"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of radio options, out of which one can be selected at a time."}, {"title": "datepicker", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "datepicker", "enum": ["datepicker"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used to select a date"}, {"title": "file", "required": ["allowMultipleFiles", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "allowMultipleFiles": {"type": "boolean", "description": "Whether to allow the upload of multiple files."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "file", "enum": ["file"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used for uploading one or more files."}, {"title": "payment_link_radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string"}, "hidden": {"type": "boolean"}, "name": {"type": "string"}, "options": {"type": "array", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string"}, "defaultValues": {"type": "array", "items": {"type": "string"}}, "dependentFields": {"type": "array", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string"}, "fieldType": {"type": "string", "default": "payment_link_radio", "enum": ["payment_link_radio"]}, "required": {"type": "boolean"}}}]}}, "description": "A form field that will be displayed based on what the customer entered in another field."}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "email", "enum": ["email"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["blockedEmailDomains", "useDefaultBlockList"], "type": "object", "properties": {"useDefaultBlockList": {"type": "boolean", "description": "Whether to block the free email providers."}, "blockedEmailDomains": {"type": "array", "description": "A list of email domains to block.", "items": {"type": "string"}}}, "description": "Describes how an email address should be validated."}}, "description": "A form field used for collecting an email address."}, {"title": "phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "useCountryCodeSelect", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "useCountryCodeSelect": {"type": "boolean", "description": "Whether to display a country code drop down next to the phone field."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "phone", "enum": ["phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a phone number."}, {"title": "mobile_phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "mobile_phone", "enum": ["mobile_phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a mobile phone number."}, {"title": "single_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_line_text", "enum": ["single_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single-line text box."}, {"title": "multi_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multi_line_text", "enum": ["multi_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a multiple-line text box."}, {"title": "number", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "number", "enum": ["number"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a numeric value should be validated."}}, "description": "A form field used for collecting a numeric value."}, {"title": "single_checkbox", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_checkbox", "enum": ["single_checkbox"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single checkbox."}, {"title": "multiple_checkboxes", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multiple_checkboxes", "enum": ["multiple_checkboxes"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of checkboxes allowing multiple choices to be selected at one time."}, {"title": "dropdown", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "dropdown", "enum": ["dropdown"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A field consisting of a drop down with multiple choices."}, {"title": "radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "radio", "enum": ["radio"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of radio options, out of which one can be selected at a time."}, {"title": "datepicker", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "datepicker", "enum": ["datepicker"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used to select a date"}, {"title": "file", "required": ["allowMultipleFiles", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "allowMultipleFiles": {"type": "boolean", "description": "Whether to allow the upload of multiple files."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "file", "enum": ["file"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used for uploading one or more files."}, {"title": "payment_link_radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string"}, "hidden": {"type": "boolean"}, "name": {"type": "string"}, "options": {"type": "array", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string"}, "defaultValues": {"type": "array", "items": {"type": "string"}}, "dependentFields": {"type": "array", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string"}, "fieldType": {"type": "string", "default": "payment_link_radio", "enum": ["payment_link_radio"]}, "required": {"type": "boolean"}}}]}}}, "description": "A collection of up to three form fields usually displayed in a row."}}, "configuration": {"required": ["allowLinkToResetKnownValues", "archivable", "cloneable", "createNewContactForNewEmail", "editable", "language", "notifyContactOwner", "notifyRecipients", "postSubmitAction", "prePopulateKnownValues", "recaptchaEnabled"], "type": "object", "properties": {"createNewContactForNewEmail": {"type": "boolean", "description": "Whether to create a new contact when a form is submitted with an email address that doesn\u2019t match any in your existing contacts records."}, "editable": {"type": "boolean", "description": "Whether the form can be edited."}, "allowLinkToResetKnownValues": {"type": "boolean", "description": "Whether to add a reset link to the form. This removes any pre-populated content on the form and creates a new contact on submission."}, "lifecycleStages": {"type": "array", "items": {"required": ["objectTypeId", "value"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "The objectTypeId for both contact and company"}, "value": {"type": "string", "description": "The internal name of the contact\'s lifecycle stage set when submitting a form"}}}}, "postSubmitAction": {"required": ["type", "value"], "type": "object", "properties": {"type": {"type": "string", "description": "The action to take after submit. The default action is displaying a thank you message.", "enum": ["thank_you", "redirect_url"]}, "value": {"type": "string", "description": "The thank you text or the page to redirect to."}}, "description": "What should happen after the customer submits the form."}, "language": {"type": "string", "description": "The language of the form.", "enum": ["af", "ar-eg", "bg", "bn", "ca-es", "cs", "da", "de", "el", "en", "es", "es-mx", "fi", "fr", "fr-ca", "he-il", "hr", "hu", "id", "it", "ja", "ko", "lt", "ms", "nl", "no-no", "pl", "pt", "pt-br", "ro", "ru", "sk", "sl", "sv", "th", "tl", "tr", "uk", "vi", "zh-cn", "zh-hk", "zh-tw"]}, "prePopulateKnownValues": {"type": "boolean", "description": "Whether contact fields should pre-populate with known information when a contact returns to your site."}, "cloneable": {"type": "boolean", "description": "Whether the form can be cloned."}, "notifyContactOwner": {"type": "boolean", "description": "Whether to send a notification email to the contact owner when a submission is received."}, "recaptchaEnabled": {"type": "boolean", "description": "Whether CAPTCHA (spam prevention) is enabled."}, "archivable": {"type": "boolean", "description": "Whether the form can be archived."}, "notifyRecipients": {"type": "array", "description": "The list of user IDs to receive a notification email when a submission is received.", "items": {"type": "string"}}}}, "displayOptions": {"required": ["renderRawHtml", "style", "submitButtonText", "theme"], "type": "object", "properties": {"renderRawHtml": {"type": "boolean", "description": "Whether the form will render as raw HTML as opposed to inside an iFrame."}, "cssClass": {"type": "string"}, "theme": {"type": "string", "description": "The theme used for styling the input fields. This will not apply if the form is added to a HubSpot CMS page.", "enum": ["default_style", "canvas", "linear", "round", "sharp", "legacy"]}, "submitButtonText": {"type": "string", "description": "The text displayed on the form submit button."}, "style": {"required": ["backgroundWidth", "fontFamily", "helpTextColor", "helpTextSize", "labelTextColor", "labelTextSize", "legalConsentTextColor", "legalConsentTextSize", "submitAlignment", "submitColor", "submitFontColor", "submitSize"], "type": "object", "properties": {"labelTextSize": {"type": "string"}, "legalConsentTextColor": {"type": "string"}, "fontFamily": {"type": "string"}, "legalConsentTextSize": {"type": "string"}, "backgroundWidth": {"type": "string"}, "helpTextSize": {"type": "string"}, "submitFontColor": {"type": "string"}, "labelTextColor": {"type": "string"}, "submitAlignment": {"type": "string", "enum": ["left", "right", "center"]}, "submitSize": {"type": "string"}, "helpTextColor": {"type": "string"}, "submitColor": {"type": "string"}}, "description": "Styling options for the form"}}, "description": "Options for styling the form."}, "legalConsentOptions": {"oneOf": [{"title": "none", "required": ["type"], "type": "object", "properties": {"type": {"type": "string", "default": "none", "enum": ["none"]}}}, {"title": "legitimate_interest", "required": ["lawfulBasis", "privacyText", "subscriptionTypeIds", "type"], "type": "object", "properties": {"subscriptionTypeIds": {"type": "array", "items": {"type": "integer", "format": "int64"}}, "lawfulBasis": {"type": "string", "enum": ["lead", "client", "other"]}, "type": {"type": "string", "default": "legitimate_interest", "enum": ["legitimate_interest"]}, "privacyText": {"type": "string"}}}, {"title": "explicit_consent_to_process", "required": ["communicationsCheckboxes", "privacyText", "type"], "type": "object", "properties": {"communicationsCheckboxes": {"type": "array", "items": {"required": ["label", "required", "subscriptionTypeId"], "type": "object", "properties": {"subscriptionTypeId": {"type": "integer", "format": "int32"}, "label": {"type": "string", "description": "The main label for the form field."}, "required": {"type": "boolean", "description": "Whether this checkbox is required when submitting the form."}}}}, "communicationConsentText": {"type": "string"}, "consentToProcessCheckboxLabel": {"type": "string"}, "consentToProcessFooterText": {"type": "string"}, "type": {"type": "string", "default": "explicit_consent_to_process", "enum": ["explicit_consent_to_process"]}, "privacyText": {"type": "string"}, "consentToProcessText": {"type": "string"}}}, {"title": "implicit_consent_to_process", "required": ["communicationsCheckboxes", "privacyText", "type"], "type": "object", "properties": {"communicationsCheckboxes": {"type": "array", "items": {"required": ["label", "required", "subscriptionTypeId"], "type": "object", "properties": {"subscriptionTypeId": {"type": "integer", "format": "int32"}, "label": {"type": "string", "description": "The main label for the form field."}, "required": {"type": "boolean", "description": "Whether this checkbox is required when submitting the form."}}}}, "communicationConsentText": {"type": "string"}, "type": {"type": "string", "default": "implicit_consent_to_process", "enum": ["implicit_consent_to_process"]}, "privacyText": {"type": "string"}, "consentToProcessText": {"type": "string"}}}]}}, "x-hubspot-sub-type-impl": true}]}',
    "UPDATEHUBSPOTMARKETINGFORM": '{"type": "object", "properties": {"fieldGroups": {"type": "array", "description": "The fields in the form, grouped in rows.", "items": {"required": ["fields", "groupType", "richTextType"], "type": "object", "properties": {"groupType": {"type": "string", "enum": ["default_group", "progressive", "queued"]}, "richTextType": {"type": "string", "description": "The type of rich text included. The default value is text.", "enum": ["text", "image"]}, "richText": {"type": "string", "description": "A block of rich text or an image. Those can be used to add extra information for the customers filling in the form. If the field group includes fields, the rich text will be displayed before the fields."}, "fields": {"type": "array", "description": "The form fields included in the group", "items": {"oneOf": [{"title": "email", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"required": ["dependentCondition", "dependentField"], "type": "object", "properties": {"dependentCondition": {"required": ["operator", "rangeEnd", "rangeStart", "value", "values"], "type": "object", "properties": {"rangeStart": {"type": "string"}, "values": {"type": "array", "items": {"type": "string"}}, "value": {"type": "string"}, "operator": {"type": "string", "enum": ["eq", "neq", "contains", "doesnt_contain", "str_starts_with", "str_ends_with", "lt", "lte", "gt", "gte", "between", "not_between", "within_time_reverse", "within_time", "set_any", "set_not_any", "set_all", "set_not_all", "set_eq", "set_neq", "is_not_empty"]}, "rangeEnd": {"type": "string"}}, "description": "A condition based on customer input"}, "dependentField": {"oneOf": [{"$ref": "#/components/schemas/EmailField", "has_circular_reference": true}, {"title": "phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "useCountryCodeSelect", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "useCountryCodeSelect": {"type": "boolean", "description": "Whether to display a country code drop down next to the phone field."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "phone", "enum": ["phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a phone number."}, {"title": "mobile_phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "mobile_phone", "enum": ["mobile_phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a mobile phone number."}, {"title": "single_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_line_text", "enum": ["single_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single-line text box."}, {"title": "multi_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multi_line_text", "enum": ["multi_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a multiple-line text box."}, {"title": "number", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "number", "enum": ["number"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a numeric value should be validated."}}, "description": "A form field used for collecting a numeric value."}, {"title": "single_checkbox", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_checkbox", "enum": ["single_checkbox"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single checkbox."}, {"title": "multiple_checkboxes", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multiple_checkboxes", "enum": ["multiple_checkboxes"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of checkboxes allowing multiple choices to be selected at one time."}, {"title": "dropdown", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "dropdown", "enum": ["dropdown"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A field consisting of a drop down with multiple choices."}, {"title": "radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "radio", "enum": ["radio"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of radio options, out of which one can be selected at a time."}, {"title": "datepicker", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "datepicker", "enum": ["datepicker"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used to select a date"}, {"title": "file", "required": ["allowMultipleFiles", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "allowMultipleFiles": {"type": "boolean", "description": "Whether to allow the upload of multiple files."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "file", "enum": ["file"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used for uploading one or more files."}, {"title": "payment_link_radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string"}, "hidden": {"type": "boolean"}, "name": {"type": "string"}, "options": {"type": "array", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string"}, "defaultValues": {"type": "array", "items": {"type": "string"}}, "dependentFields": {"type": "array", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string"}, "fieldType": {"type": "string", "default": "payment_link_radio", "enum": ["payment_link_radio"]}, "required": {"type": "boolean"}}}]}}, "description": "A form field that will be displayed based on what the customer entered in another field."}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "email", "enum": ["email"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["blockedEmailDomains", "useDefaultBlockList"], "type": "object", "properties": {"useDefaultBlockList": {"type": "boolean", "description": "Whether to block the free email providers."}, "blockedEmailDomains": {"type": "array", "description": "A list of email domains to block.", "items": {"type": "string"}}}, "description": "Describes how an email address should be validated."}}, "description": "A form field used for collecting an email address."}, {"title": "phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "useCountryCodeSelect", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "useCountryCodeSelect": {"type": "boolean", "description": "Whether to display a country code drop down next to the phone field."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "phone", "enum": ["phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a phone number."}, {"title": "mobile_phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "mobile_phone", "enum": ["mobile_phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a mobile phone number."}, {"title": "single_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_line_text", "enum": ["single_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single-line text box."}, {"title": "multi_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multi_line_text", "enum": ["multi_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a multiple-line text box."}, {"title": "number", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "number", "enum": ["number"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a numeric value should be validated."}}, "description": "A form field used for collecting a numeric value."}, {"title": "single_checkbox", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_checkbox", "enum": ["single_checkbox"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single checkbox."}, {"title": "multiple_checkboxes", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multiple_checkboxes", "enum": ["multiple_checkboxes"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of checkboxes allowing multiple choices to be selected at one time."}, {"title": "dropdown", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "dropdown", "enum": ["dropdown"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A field consisting of a drop down with multiple choices."}, {"title": "radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "radio", "enum": ["radio"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of radio options, out of which one can be selected at a time."}, {"title": "datepicker", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "datepicker", "enum": ["datepicker"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used to select a date"}, {"title": "file", "required": ["allowMultipleFiles", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "allowMultipleFiles": {"type": "boolean", "description": "Whether to allow the upload of multiple files."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "file", "enum": ["file"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used for uploading one or more files."}, {"title": "payment_link_radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string"}, "hidden": {"type": "boolean"}, "name": {"type": "string"}, "options": {"type": "array", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string"}, "defaultValues": {"type": "array", "items": {"type": "string"}}, "dependentFields": {"type": "array", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string"}, "fieldType": {"type": "string", "default": "payment_link_radio", "enum": ["payment_link_radio"]}, "required": {"type": "boolean"}}}]}}}, "description": "A collection of up to three form fields usually displayed in a row."}}, "archived": {"type": "boolean", "description": "Whether this form is archived."}, "configuration": {"required": ["allowLinkToResetKnownValues", "archivable", "cloneable", "createNewContactForNewEmail", "editable", "language", "notifyContactOwner", "notifyRecipients", "postSubmitAction", "prePopulateKnownValues", "recaptchaEnabled"], "type": "object", "properties": {"createNewContactForNewEmail": {"type": "boolean", "description": "Whether to create a new contact when a form is submitted with an email address that doesn\u2019t match any in your existing contacts records."}, "editable": {"type": "boolean", "description": "Whether the form can be edited."}, "allowLinkToResetKnownValues": {"type": "boolean", "description": "Whether to add a reset link to the form. This removes any pre-populated content on the form and creates a new contact on submission."}, "lifecycleStages": {"type": "array", "items": {"required": ["objectTypeId", "value"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "The objectTypeId for both contact and company"}, "value": {"type": "string", "description": "The internal name of the contact\'s lifecycle stage set when submitting a form"}}}}, "postSubmitAction": {"required": ["type", "value"], "type": "object", "properties": {"type": {"type": "string", "description": "The action to take after submit. The default action is displaying a thank you message.", "enum": ["thank_you", "redirect_url"]}, "value": {"type": "string", "description": "The thank you text or the page to redirect to."}}, "description": "What should happen after the customer submits the form."}, "language": {"type": "string", "description": "The language of the form.", "enum": ["af", "ar-eg", "bg", "bn", "ca-es", "cs", "da", "de", "el", "en", "es", "es-mx", "fi", "fr", "fr-ca", "he-il", "hr", "hu", "id", "it", "ja", "ko", "lt", "ms", "nl", "no-no", "pl", "pt", "pt-br", "ro", "ru", "sk", "sl", "sv", "th", "tl", "tr", "uk", "vi", "zh-cn", "zh-hk", "zh-tw"]}, "prePopulateKnownValues": {"type": "boolean", "description": "Whether contact fields should pre-populate with known information when a contact returns to your site."}, "cloneable": {"type": "boolean", "description": "Whether the form can be cloned."}, "notifyContactOwner": {"type": "boolean", "description": "Whether to send a notification email to the contact owner when a submission is received."}, "recaptchaEnabled": {"type": "boolean", "description": "Whether CAPTCHA (spam prevention) is enabled."}, "archivable": {"type": "boolean", "description": "Whether the form can be archived."}, "notifyRecipients": {"type": "array", "description": "The list of user IDs to receive a notification email when a submission is received.", "items": {"type": "string"}}}}, "name": {"type": "string", "description": "The name of the form. Expected to be unique for a hub."}, "legalConsentOptions": {"oneOf": [{"title": "none", "required": ["type"], "type": "object", "properties": {"type": {"type": "string", "default": "none", "enum": ["none"]}}}, {"title": "legitimate_interest", "required": ["lawfulBasis", "privacyText", "subscriptionTypeIds", "type"], "type": "object", "properties": {"subscriptionTypeIds": {"type": "array", "items": {"type": "integer", "format": "int64"}}, "lawfulBasis": {"type": "string", "enum": ["lead", "client", "other"]}, "type": {"type": "string", "default": "legitimate_interest", "enum": ["legitimate_interest"]}, "privacyText": {"type": "string"}}}, {"title": "explicit_consent_to_process", "required": ["communicationsCheckboxes", "privacyText", "type"], "type": "object", "properties": {"communicationsCheckboxes": {"type": "array", "items": {"required": ["label", "required", "subscriptionTypeId"], "type": "object", "properties": {"subscriptionTypeId": {"type": "integer", "format": "int32"}, "label": {"type": "string", "description": "The main label for the form field."}, "required": {"type": "boolean", "description": "Whether this checkbox is required when submitting the form."}}}}, "communicationConsentText": {"type": "string"}, "consentToProcessCheckboxLabel": {"type": "string"}, "consentToProcessFooterText": {"type": "string"}, "type": {"type": "string", "default": "explicit_consent_to_process", "enum": ["explicit_consent_to_process"]}, "privacyText": {"type": "string"}, "consentToProcessText": {"type": "string"}}}, {"title": "implicit_consent_to_process", "required": ["communicationsCheckboxes", "privacyText", "type"], "type": "object", "properties": {"communicationsCheckboxes": {"type": "array", "items": {"required": ["label", "required", "subscriptionTypeId"], "type": "object", "properties": {"subscriptionTypeId": {"type": "integer", "format": "int32"}, "label": {"type": "string", "description": "The main label for the form field."}, "required": {"type": "boolean", "description": "Whether this checkbox is required when submitting the form."}}}}, "communicationConsentText": {"type": "string"}, "type": {"type": "string", "default": "implicit_consent_to_process", "enum": ["implicit_consent_to_process"]}, "privacyText": {"type": "string"}, "consentToProcessText": {"type": "string"}}}]}, "displayOptions": {"required": ["renderRawHtml", "style", "submitButtonText", "theme"], "type": "object", "properties": {"renderRawHtml": {"type": "boolean", "description": "Whether the form will render as raw HTML as opposed to inside an iFrame."}, "cssClass": {"type": "string"}, "theme": {"type": "string", "description": "The theme used for styling the input fields. This will not apply if the form is added to a HubSpot CMS page.", "enum": ["default_style", "canvas", "linear", "round", "sharp", "legacy"]}, "submitButtonText": {"type": "string", "description": "The text displayed on the form submit button."}, "style": {"required": ["backgroundWidth", "fontFamily", "helpTextColor", "helpTextSize", "labelTextColor", "labelTextSize", "legalConsentTextColor", "legalConsentTextSize", "submitAlignment", "submitColor", "submitFontColor", "submitSize"], "type": "object", "properties": {"labelTextSize": {"type": "string"}, "legalConsentTextColor": {"type": "string"}, "fontFamily": {"type": "string"}, "legalConsentTextSize": {"type": "string"}, "backgroundWidth": {"type": "string"}, "helpTextSize": {"type": "string"}, "submitFontColor": {"type": "string"}, "labelTextColor": {"type": "string"}, "submitAlignment": {"type": "string", "enum": ["left", "right", "center"]}, "submitSize": {"type": "string"}, "helpTextColor": {"type": "string"}, "submitColor": {"type": "string"}}, "description": "Styling options for the form"}}, "description": "Options for styling the form."}}}',
    "CREATEMARKETINGFORM": '{"properties": {}, "oneOf": [{"properties": {}, "allOf": [{"$ref": "#/components/schemas/FormDefinitionCreateRequestBase", "has_circular_reference": true}, {"required": ["archived", "configuration", "createdAt", "displayOptions", "fieldGroups", "formType", "legalConsentOptions", "name", "updatedAt"], "type": "object", "properties": {"formType": {"type": "string", "default": "hubspot", "enum": ["hubspot"]}, "name": {"type": "string"}, "createdAt": {"type": "string", "format": "date-time"}, "updatedAt": {"type": "string", "format": "date-time"}, "archived": {"type": "boolean"}, "archivedAt": {"type": "string", "format": "date-time"}, "fieldGroups": {"type": "array", "items": {"required": ["fields", "groupType", "richTextType"], "type": "object", "properties": {"groupType": {"type": "string", "enum": ["default_group", "progressive", "queued"]}, "richTextType": {"type": "string", "description": "The type of rich text included. The default value is text.", "enum": ["text", "image"]}, "richText": {"type": "string", "description": "A block of rich text or an image. Those can be used to add extra information for the customers filling in the form. If the field group includes fields, the rich text will be displayed before the fields."}, "fields": {"type": "array", "description": "The form fields included in the group", "items": {"oneOf": [{"title": "email", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"required": ["dependentCondition", "dependentField"], "type": "object", "properties": {"dependentCondition": {"required": ["operator", "rangeEnd", "rangeStart", "value", "values"], "type": "object", "properties": {"rangeStart": {"type": "string"}, "values": {"type": "array", "items": {"type": "string"}}, "value": {"type": "string"}, "operator": {"type": "string", "enum": ["eq", "neq", "contains", "doesnt_contain", "str_starts_with", "str_ends_with", "lt", "lte", "gt", "gte", "between", "not_between", "within_time_reverse", "within_time", "set_any", "set_not_any", "set_all", "set_not_all", "set_eq", "set_neq", "is_not_empty"]}, "rangeEnd": {"type": "string"}}, "description": "A condition based on customer input"}, "dependentField": {"oneOf": [{"$ref": "#/components/schemas/EmailField", "has_circular_reference": true}, {"title": "phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "useCountryCodeSelect", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "useCountryCodeSelect": {"type": "boolean", "description": "Whether to display a country code drop down next to the phone field."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "phone", "enum": ["phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a phone number."}, {"title": "mobile_phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "mobile_phone", "enum": ["mobile_phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a mobile phone number."}, {"title": "single_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_line_text", "enum": ["single_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single-line text box."}, {"title": "multi_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multi_line_text", "enum": ["multi_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a multiple-line text box."}, {"title": "number", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "number", "enum": ["number"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a numeric value should be validated."}}, "description": "A form field used for collecting a numeric value."}, {"title": "single_checkbox", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_checkbox", "enum": ["single_checkbox"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single checkbox."}, {"title": "multiple_checkboxes", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multiple_checkboxes", "enum": ["multiple_checkboxes"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of checkboxes allowing multiple choices to be selected at one time."}, {"title": "dropdown", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "dropdown", "enum": ["dropdown"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A field consisting of a drop down with multiple choices."}, {"title": "radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "radio", "enum": ["radio"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of radio options, out of which one can be selected at a time."}, {"title": "datepicker", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "datepicker", "enum": ["datepicker"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used to select a date"}, {"title": "file", "required": ["allowMultipleFiles", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "allowMultipleFiles": {"type": "boolean", "description": "Whether to allow the upload of multiple files."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "file", "enum": ["file"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used for uploading one or more files."}, {"title": "payment_link_radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string"}, "hidden": {"type": "boolean"}, "name": {"type": "string"}, "options": {"type": "array", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string"}, "defaultValues": {"type": "array", "items": {"type": "string"}}, "dependentFields": {"type": "array", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string"}, "fieldType": {"type": "string", "default": "payment_link_radio", "enum": ["payment_link_radio"]}, "required": {"type": "boolean"}}}]}}, "description": "A form field that will be displayed based on what the customer entered in another field."}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "email", "enum": ["email"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["blockedEmailDomains", "useDefaultBlockList"], "type": "object", "properties": {"useDefaultBlockList": {"type": "boolean", "description": "Whether to block the free email providers."}, "blockedEmailDomains": {"type": "array", "description": "A list of email domains to block.", "items": {"type": "string"}}}, "description": "Describes how an email address should be validated."}}, "description": "A form field used for collecting an email address."}, {"title": "phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "useCountryCodeSelect", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "useCountryCodeSelect": {"type": "boolean", "description": "Whether to display a country code drop down next to the phone field."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "phone", "enum": ["phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a phone number."}, {"title": "mobile_phone", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required", "validation"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "mobile_phone", "enum": ["mobile_phone"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a phone number should be validated."}}, "description": "A form field used for collecting a mobile phone number."}, {"title": "single_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_line_text", "enum": ["single_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single-line text box."}, {"title": "multi_line_text", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multi_line_text", "enum": ["multi_line_text"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a multiple-line text box."}, {"title": "number", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "number", "enum": ["number"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}, "validation": {"required": ["maxAllowedDigits", "minAllowedDigits"], "type": "object", "properties": {"minAllowedDigits": {"type": "integer", "format": "int32"}, "maxAllowedDigits": {"type": "integer", "format": "int32"}}, "description": "Describes how a numeric value should be validated."}}, "description": "A form field used for collecting a numeric value."}, {"title": "single_checkbox", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "single_checkbox", "enum": ["single_checkbox"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a single checkbox."}, {"title": "multiple_checkboxes", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "multiple_checkboxes", "enum": ["multiple_checkboxes"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of checkboxes allowing multiple choices to be selected at one time."}, {"title": "dropdown", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "dropdown", "enum": ["dropdown"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A field consisting of a drop down with multiple choices."}, {"title": "radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "options": {"type": "array", "description": "The list of available choices for this field.", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "defaultValues": {"type": "array", "description": "The values selected by default. Those values will be submitted unless the customer modifies them.", "items": {"type": "string"}}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "radio", "enum": ["radio"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field consisting of a set of radio options, out of which one can be selected at a time."}, {"title": "datepicker", "required": ["dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "datepicker", "enum": ["datepicker"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used to select a date"}, {"title": "file", "required": ["allowMultipleFiles", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "A unique ID for this field\'s CRM object type. For example a CONTACT field will have the object type ID 0-1."}, "allowMultipleFiles": {"type": "boolean", "description": "Whether to allow the upload of multiple files."}, "hidden": {"type": "boolean", "description": "Whether a field should be hidden or not. Hidden fields won\'t appear on the form, but can be used to pass a value to a property without requiring the customer to fill it in."}, "defaultValue": {"type": "string", "description": "The value filled in by default. This value will be submitted unless the customer modifies it."}, "name": {"type": "string", "description": "The identifier of the field. In combination with the object type ID, it must be unique."}, "description": {"type": "string", "description": "Additional text helping the customer to complete the field."}, "dependentFields": {"type": "array", "description": "A list of other fields to make visible based on the value filled in for this field.", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string", "description": "The main label for the form field."}, "placeholder": {"type": "string", "description": "The prompt text showing when the field isn\'t filled in."}, "fieldType": {"type": "string", "description": "Determines how the field will be displayed and validated.", "default": "file", "enum": ["file"]}, "required": {"type": "boolean", "description": "Whether a value for this field is required when submitting the form."}}, "description": "A form field used for uploading one or more files."}, {"title": "payment_link_radio", "required": ["defaultValues", "dependentFields", "fieldType", "hidden", "label", "name", "objectTypeId", "options", "required"], "type": "object", "properties": {"objectTypeId": {"type": "string"}, "hidden": {"type": "boolean"}, "name": {"type": "string"}, "options": {"type": "array", "items": {"required": ["displayOrder", "label", "value"], "type": "object", "properties": {"displayOrder": {"type": "integer", "description": "The order the choices will be displayed in.", "format": "int32"}, "description": {"type": "string"}, "label": {"type": "string", "description": "The visible label for this choice."}, "value": {"type": "string", "description": "The value which will be submitted if this choice is selected."}}}}, "description": {"type": "string"}, "defaultValues": {"type": "array", "items": {"type": "string"}}, "dependentFields": {"type": "array", "items": {"$ref": "#/components/schemas/DependentField", "has_circular_reference": true}}, "label": {"type": "string"}, "fieldType": {"type": "string", "default": "payment_link_radio", "enum": ["payment_link_radio"]}, "required": {"type": "boolean"}}}]}}}, "description": "A collection of up to three form fields usually displayed in a row."}}, "configuration": {"required": ["allowLinkToResetKnownValues", "archivable", "cloneable", "createNewContactForNewEmail", "editable", "language", "notifyContactOwner", "notifyRecipients", "postSubmitAction", "prePopulateKnownValues", "recaptchaEnabled"], "type": "object", "properties": {"createNewContactForNewEmail": {"type": "boolean", "description": "Whether to create a new contact when a form is submitted with an email address that doesn\u2019t match any in your existing contacts records."}, "editable": {"type": "boolean", "description": "Whether the form can be edited."}, "allowLinkToResetKnownValues": {"type": "boolean", "description": "Whether to add a reset link to the form. This removes any pre-populated content on the form and creates a new contact on submission."}, "lifecycleStages": {"type": "array", "items": {"required": ["objectTypeId", "value"], "type": "object", "properties": {"objectTypeId": {"type": "string", "description": "The objectTypeId for both contact and company"}, "value": {"type": "string", "description": "The internal name of the contact\'s lifecycle stage set when submitting a form"}}}}, "postSubmitAction": {"required": ["type", "value"], "type": "object", "properties": {"type": {"type": "string", "description": "The action to take after submit. The default action is displaying a thank you message.", "enum": ["thank_you", "redirect_url"]}, "value": {"type": "string", "description": "The thank you text or the page to redirect to."}}, "description": "What should happen after the customer submits the form."}, "language": {"type": "string", "description": "The language of the form.", "enum": ["af", "ar-eg", "bg", "bn", "ca-es", "cs", "da", "de", "el", "en", "es", "es-mx", "fi", "fr", "fr-ca", "he-il", "hr", "hu", "id", "it", "ja", "ko", "lt", "ms", "nl", "no-no", "pl", "pt", "pt-br", "ro", "ru", "sk", "sl", "sv", "th", "tl", "tr", "uk", "vi", "zh-cn", "zh-hk", "zh-tw"]}, "prePopulateKnownValues": {"type": "boolean", "description": "Whether contact fields should pre-populate with known information when a contact returns to your site."}, "cloneable": {"type": "boolean", "description": "Whether the form can be cloned."}, "notifyContactOwner": {"type": "boolean", "description": "Whether to send a notification email to the contact owner when a submission is received."}, "recaptchaEnabled": {"type": "boolean", "description": "Whether CAPTCHA (spam prevention) is enabled."}, "archivable": {"type": "boolean", "description": "Whether the form can be archived."}, "notifyRecipients": {"type": "array", "description": "The list of user IDs to receive a notification email when a submission is received.", "items": {"type": "string"}}}}, "displayOptions": {"required": ["renderRawHtml", "style", "submitButtonText", "theme"], "type": "object", "properties": {"renderRawHtml": {"type": "boolean", "description": "Whether the form will render as raw HTML as opposed to inside an iFrame."}, "cssClass": {"type": "string"}, "theme": {"type": "string", "description": "The theme used for styling the input fields. This will not apply if the form is added to a HubSpot CMS page.", "enum": ["default_style", "canvas", "linear", "round", "sharp", "legacy"]}, "submitButtonText": {"type": "string", "description": "The text displayed on the form submit button."}, "style": {"required": ["backgroundWidth", "fontFamily", "helpTextColor", "helpTextSize", "labelTextColor", "labelTextSize", "legalConsentTextColor", "legalConsentTextSize", "submitAlignment", "submitColor", "submitFontColor", "submitSize"], "type": "object", "properties": {"labelTextSize": {"type": "string"}, "legalConsentTextColor": {"type": "string"}, "fontFamily": {"type": "string"}, "legalConsentTextSize": {"type": "string"}, "backgroundWidth": {"type": "string"}, "helpTextSize": {"type": "string"}, "submitFontColor": {"type": "string"}, "labelTextColor": {"type": "string"}, "submitAlignment": {"type": "string", "enum": ["left", "right", "center"]}, "submitSize": {"type": "string"}, "helpTextColor": {"type": "string"}, "submitColor": {"type": "string"}}, "description": "Styling options for the form"}}, "description": "Options for styling the form."}, "legalConsentOptions": {"oneOf": [{"title": "none", "required": ["type"], "type": "object", "properties": {"type": {"type": "string", "default": "none", "enum": ["none"]}}}, {"title": "legitimate_interest", "required": ["lawfulBasis", "privacyText", "subscriptionTypeIds", "type"], "type": "object", "properties": {"subscriptionTypeIds": {"type": "array", "items": {"type": "integer", "format": "int64"}}, "lawfulBasis": {"type": "string", "enum": ["lead", "client", "other"]}, "type": {"type": "string", "default": "legitimate_interest", "enum": ["legitimate_interest"]}, "privacyText": {"type": "string"}}}, {"title": "explicit_consent_to_process", "required": ["communicationsCheckboxes", "privacyText", "type"], "type": "object", "properties": {"communicationsCheckboxes": {"type": "array", "items": {"required": ["label", "required", "subscriptionTypeId"], "type": "object", "properties": {"subscriptionTypeId": {"type": "integer", "format": "int32"}, "label": {"type": "string", "description": "The main label for the form field."}, "required": {"type": "boolean", "description": "Whether this checkbox is required when submitting the form."}}}}, "communicationConsentText": {"type": "string"}, "consentToProcessCheckboxLabel": {"type": "string"}, "consentToProcessFooterText": {"type": "string"}, "type": {"type": "string", "default": "explicit_consent_to_process", "enum": ["explicit_consent_to_process"]}, "privacyText": {"type": "string"}, "consentToProcessText": {"type": "string"}}}, {"title": "implicit_consent_to_process", "required": ["communicationsCheckboxes", "privacyText", "type"], "type": "object", "properties": {"communicationsCheckboxes": {"type": "array", "items": {"required": ["label", "required", "subscriptionTypeId"], "type": "object", "properties": {"subscriptionTypeId": {"type": "integer", "format": "int32"}, "label": {"type": "string", "description": "The main label for the form field."}, "required": {"type": "boolean", "description": "Whether this checkbox is required when submitting the form."}}}}, "communicationConsentText": {"type": "string"}, "type": {"type": "string", "default": "implicit_consent_to_process", "enum": ["implicit_consent_to_process"]}, "privacyText": {"type": "string"}, "consentToProcessText": {"type": "string"}}}]}}, "x-hubspot-sub-type-impl": true}]}]}',
    "UPDATEEMAILDRAFT": '{"type": "object", "properties": {"rssData": {"type": "object", "properties": {"blogImageMaxWidth": {"type": "integer", "format": "int32"}, "blogEmailType": {"type": "string"}, "hubspotBlogId": {"type": "string"}, "rssEntryTemplate": {"type": "string"}, "timing": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "maxEntries": {"type": "integer", "format": "int32"}, "useHeadlineAsSubject": {"type": "boolean"}, "blogLayout": {"type": "string"}, "url": {"type": "string"}}, "description": "RSS related data if it is a blog or rss email."}, "subject": {"type": "string", "description": "The subject of the email."}, "testing": {"type": "object", "properties": {"isAbVariation": {"type": "boolean"}, "abSamplingDefault": {"type": "string", "description": "Version of the email that should be sent if the results are inconclusive after the test period, master or variant.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abSampleSizeDefault": {"type": "string", "description": "Version of the email that should be sent if there are too few recipients to conduct an AB test.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abStatus": {"type": "string", "description": "Status of the AB test.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abTestPercentage": {"type": "integer", "description": "The size of your test group.", "format": "int32"}, "hoursToWait": {"type": "integer", "description": "Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.", "format": "int32"}, "testId": {"type": "string", "description": "The ID of the AB test."}, "abSuccessMetric": {"type": "string", "description": "Metric to determine the version that will be sent to the remaining contacts.", "enum": ["CLICKS_BY_OPENS", "CLICKS_BY_DELIVERED", "OPENS_BY_DELIVERED"]}}, "description": "AB testing related data. This property is only returned for AB type emails."}, "publishDate": {"type": "string", "description": "The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.", "format": "date-time"}, "language": {"type": "string", "enum": ["af", "af-na", "af-za", "agq", "agq-cm", "ak", "ak-gh", "am", "am-et", "ann", "ann-ng", "ar", "ar-001", "ar-ae", "ar-bh", "ar-dj", "ar-dz", "ar-eg", "ar-eh", "ar-er", "ar-il", "ar-iq", "ar-jo", "ar-km", "ar-kw", "ar-lb", "ar-ly", "ar-ma", "ar-mr", "ar-om", "ar-ps", "ar-qa", "ar-sa", "ar-sd", "ar-so", "ar-ss", "ar-sy", "ar-td", "ar-tn", "ar-ye", "as", "asa", "asa-tz", "ast", "ast-es", "as-in", "az", "az-az", "bas", "bas-cm", "be", "bem", "bem-zm", "bez", "bez-tz", "be-by", "bg", "bgc", "bgc-in", "bg-bg", "bho", "bho-in", "bm", "bm-ml", "bn", "bn-bd", "bn-in", "bo", "bo-cn", "bo-in", "br", "brx", "brx-in", "br-fr", "bs", "bs-ba", "ca", "ca-ad", "ca-es", "ca-fr", "ca-it", "ccp", "ccp-bd", "ccp-in", "ce", "ceb", "ceb-ph", "ce-ru", "cgg", "cgg-ug", "chr", "chr-us", "ckb", "ckb-iq", "ckb-ir", "cs", "cs-cz", "cu", "cu-ru", "cv", "cv-ru", "cy", "cy-gb", "da", "dav", "dav-ke", "da-dk", "da-gl", "de", "de-at", "de-be", "de-ch", "de-de", "de-gr", "de-it", "de-li", "de-lu", "dje", "dje-ne", "doi", "doi-in", "dsb", "dsb-de", "dua", "dua-cm", "dyo", "dyo-sn", "dz", "dz-bt", "ebu", "ebu-ke", "ee", "ee-gh", "ee-tg", "el", "el-cy", "el-gr", "en", "en-001", "en-150", "en-ae", "en-ag", "en-ai", "en-as", "en-at", "en-au", "en-bb", "en-be", "en-bi", "en-bm", "en-bs", "en-bw", "en-bz", "en-ca", "en-cc", "en-ch", "en-ck", "en-cm", "en-cn", "en-cx", "en-cy", "en-de", "en-dg", "en-dk", "en-dm", "en-ee", "en-eg", "en-er", "en-es", "en-fi", "en-fj", "en-fk", "en-fm", "en-fr", "en-gb", "en-gd", "en-gg", "en-gh", "en-gi", "en-gm", "en-gu", "en-gy", "en-hk", "en-ie", "en-il", "en-im", "en-in", "en-io", "en-je", "en-jm", "en-ke", "en-ki", "en-kn", "en-ky", "en-lc", "en-lr", "en-ls", "en-lu", "en-mg", "en-mh", "en-mo", "en-mp", "en-ms", "en-mt", "en-mu", "en-mv", "en-mw", "en-mx", "en-my", "en-na", "en-nf", "en-ng", "en-nl", "en-nr", "en-nu", "en-nz", "en-pg", "en-ph", "en-pk", "en-pn", "en-pr", "en-pw", "en-rw", "en-sb", "en-sc", "en-sd", "en-se", "en-sg", "en-sh", "en-si", "en-sl", "en-ss", "en-sx", "en-sz", "en-tc", "en-tk", "en-tn", "en-to", "en-tt", "en-tv", "en-tz", "en-ug", "en-um", "en-us", "en-vc", "en-vg", "en-vi", "en-vu", "en-ws", "en-za", "en-zm", "en-zw", "eo", "eo-001", "es", "es-419", "es-ar", "es-bo", "es-br", "es-bz", "es-cl", "es-co", "es-cr", "es-cu", "es-do", "es-ea", "es-ec", "es-es", "es-gq", "es-gt", "es-hn", "es-ic", "es-mx", "es-ni", "es-pa", "es-pe", "es-ph", "es-pr", "es-py", "es-sv", "es-us", "es-uy", "es-ve", "et", "et-ee", "eu", "eu-es", "ewo", "ewo-cm", "fa", "fa-af", "fa-ir", "ff", "ff-bf", "ff-cm", "ff-gh", "ff-gm", "ff-gn", "ff-gw", "ff-lr", "ff-mr", "ff-ne", "ff-ng", "ff-sl", "ff-sn", "fi", "fil", "fil-ph", "fi-fi", "fo", "fo-dk", "fo-fo", "fr", "frr", "frr-de", "fr-be", "fr-bf", "fr-bi", "fr-bj", "fr-bl", "fr-ca", "fr-cd", "fr-cf", "fr-cg", "fr-ch", "fr-ci", "fr-cm", "fr-dj", "fr-dz", "fr-fr", "fr-ga", "fr-gf", "fr-gn", "fr-gp", "fr-gq", "fr-ht", "fr-km", "fr-lu", "fr-ma", "fr-mc", "fr-mf", "fr-mg", "fr-ml", "fr-mq", "fr-mr", "fr-mu", "fr-nc", "fr-ne", "fr-pf", "fr-pm", "fr-re", "fr-rw", "fr-sc", "fr-sn", "fr-sy", "fr-td", "fr-tg", "fr-tn", "fr-vu", "fr-wf", "fr-yt", "fur", "fur-it", "fy", "fy-nl", "ga", "ga-gb", "ga-ie", "gd", "gd-gb", "gl", "gl-es", "gsw", "gsw-ch", "gsw-fr", "gsw-li", "gu", "guz", "guz-ke", "gu-in", "gv", "gv-im", "ha", "haw", "haw-us", "ha-gh", "ha-ne", "ha-ng", "he", "he-il", "hi", "hi-in", "hr", "hr-ba", "hr-hr", "hsb", "hsb-de", "hu", "hu-hu", "hy", "hy-am", "ia", "ia-001", "id", "ig", "ig-ng", "ii", "ii-cn", "id-id", "is", "is-is", "it", "it-ch", "it-it", "it-sm", "it-va", "ja", "ja-jp", "jgo", "jgo-cm", "yi", "yi-001", "jmc", "jmc-tz", "jv", "jv-id", "ka", "kab", "kab-dz", "kam", "kam-ke", "ka-ge", "kde", "kde-tz", "kea", "kea-cv", "kgp", "kgp-br", "khq", "khq-ml", "ki", "ki-ke", "kk", "kkj", "kkj-cm", "kk-kz", "kl", "kln", "kln-ke", "kl-gl", "km", "km-kh", "kn", "kn-in", "ko", "kok", "kok-in", "ko-kp", "ko-kr", "ks", "ksb", "ksb-tz", "ksf", "ksf-cm", "ksh", "ksh-de", "ks-in", "ku", "ku-tr", "kw", "kw-gb", "ky", "ky-kg", "lag", "lag-tz", "lb", "lb-lu", "lg", "lg-ug", "lkt", "lkt-us", "ln", "ln-ao", "ln-cd", "ln-cf", "ln-cg", "lo", "lo-la", "lrc", "lrc-iq", "lrc-ir", "lt", "lt-lt", "lu", "luo", "luo-ke", "luy", "luy-ke", "lu-cd", "lv", "lv-lv", "mai", "mai-in", "mas", "mas-ke", "mas-tz", "mdf", "mdf-ru", "mer", "mer-ke", "mfe", "mfe-mu", "mg", "mgh", "mgh-mz", "mgo", "mgo-cm", "mg-mg", "mi", "mi-nz", "mk", "mk-mk", "ml", "ml-in", "mn", "mni", "mni-in", "mn-mn", "mr", "mr-in", "ms", "ms-bn", "ms-id", "ms-my", "ms-sg", "mt", "mt-mt", "mua", "mua-cm", "my", "my-mm", "mzn", "mzn-ir", "naq", "naq-na", "nb", "nb-no", "nb-sj", "nd", "nds", "nds-de", "nds-nl", "nd-zw", "ne", "ne-in", "ne-np", "nl", "nl-aw", "nl-be", "nl-bq", "nl-ch", "nl-cw", "nl-lu", "nl-nl", "nl-sr", "nl-sx", "nmg", "nmg-cm", "nn", "nnh", "nnh-cm", "nn-no", "no", "no-no", "nus", "nus-ss", "nyn", "nyn-ug", "oc", "oc-es", "oc-fr", "om", "om-et", "om-ke", "or", "or-in", "os", "os-ge", "os-ru", "pa", "pa-in", "pa-pk", "pcm", "pcm-ng", "pis", "pis-sb", "pl", "pl-pl", "prg", "prg-001", "ps", "ps-af", "ps-pk", "pt", "pt-ao", "pt-br", "pt-ch", "pt-cv", "pt-gq", "pt-gw", "pt-lu", "pt-mo", "pt-mz", "pt-pt", "pt-st", "pt-tl", "qu", "qu-bo", "qu-ec", "qu-pe", "raj", "raj-in", "rm", "rm-ch", "rn", "rn-bi", "ro", "rof", "rof-tz", "ro-md", "ro-ro", "ru", "ru-by", "ru-kg", "ru-kz", "ru-md", "ru-ru", "ru-ua", "rw", "rwk", "rwk-tz", "rw-rw", "sa", "sah", "sah-ru", "saq", "saq-ke", "sat", "sat-in", "sa-in", "sbp", "sbp-tz", "sc", "sc-it", "sd", "sd-in", "sd-pk", "se", "seh", "seh-mz", "ses", "ses-ml", "se-fi", "se-no", "se-se", "sg", "sg-cf", "shi", "shi-ma", "si", "si-lk", "sk", "sk-sk", "sl", "sl-si", "smn", "smn-fi", "sms", "sms-fi", "sn", "sn-zw", "so", "so-dj", "so-et", "so-ke", "so-so", "sq", "sq-al", "sq-mk", "sq-xk", "sr", "sr-ba", "sr-cs", "sr-me", "sr-rs", "sr-xk", "su", "su-id", "sv", "sv-ax", "sv-fi", "sv-se", "sw", "sw-cd", "sw-ke", "sw-tz", "sw-ug", "sy", "ta", "ta-in", "ta-lk", "ta-my", "ta-sg", "te", "teo", "teo-ke", "teo-ug", "te-in", "tg", "tg-tj", "th", "th-th", "ti", "ti-er", "ti-et", "tk", "tk-tm", "tl", "to", "tok", "tok-001", "to-to", "tr", "tr-cy", "tr-tr", "tt", "tt-ru", "twq", "twq-ne", "tzm", "tzm-ma", "ug", "ug-cn", "uk", "uk-ua", "ur", "ur-in", "ur-pk", "uz", "uz-af", "uz-uz", "vai", "vai-lr", "vi", "vi-vn", "vo", "vo-001", "vun", "vun-tz", "wae", "wae-ch", "wo", "wo-sn", "xh", "xh-za", "xog", "xog-ug", "yav", "yav-cm", "yo", "yo-bj", "yo-ng", "yrl", "yrl-br", "yrl-co", "yrl-ve", "yue", "yue-cn", "yue-hk", "zgh", "zgh-ma", "zh", "zh-cn", "zh-hans", "zh-hant", "zh-hk", "zh-mo", "zh-sg", "zh-tw", "zu", "zu-za"]}, "businessUnitId": {"type": "integer", "format": "int64"}, "content": {"type": "object", "properties": {"smartFields": {"type": "object", "additionalProperties": {"type": "object", "properties": {}, "description": "An email field whose value is controlled by one or more smart rules."}}, "themeSettingsValues": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "flexAreas": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "widgets": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "plainTextVersion": {"type": "string"}, "templatePath": {"type": "string"}, "widgetContainers": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "styleSettings": {"type": "object", "properties": {"backgroundColor": {"type": "string"}, "backgroundImage": {"type": "string"}, "backgroundImageType": {"type": "string"}, "bodyColor": {"type": "string"}, "bodyBorderColor": {"type": "string"}, "bodyBorderWidth": {"type": "number"}, "bodyBorderColorChoice": {"type": "string"}, "primaryFont": {"type": "string"}, "primaryFontColor": {"type": "string"}, "primaryAccentColor": {"type": "string"}, "primaryFontSize": {"type": "number"}, "primaryFontLineHeight": {"type": "string"}, "secondaryFont": {"type": "string"}, "secondaryFontColor": {"type": "string"}, "secondaryAccentColor": {"type": "string"}, "secondaryFontSize": {"type": "number"}, "secondaryFontLineHeight": {"type": "string"}, "headingOneFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "headingTwoFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "linksFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "colorPickerFavorite1": {"type": "string"}, "colorPickerFavorite2": {"type": "string"}, "colorPickerFavorite3": {"type": "string"}, "colorPickerFavorite4": {"type": "string"}, "colorPickerFavorite5": {"type": "string"}, "colorPickerFavorite6": {"type": "string"}, "emailBodyPadding": {"type": "string"}, "emailBodyWidth": {"type": "string"}, "buttonStyleSettings": {"type": "object", "properties": {"backgroundColor": {"type": "object", "properties": {}}, "cornerRadius": {"type": "integer", "format": "int32"}, "fontStyle": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}}}, "dividerStyleSettings": {"type": "object", "properties": {"height": {"type": "integer", "format": "int32"}, "color": {"type": "object", "properties": {}}, "lineType": {"type": "string"}}}}}}, "description": "Data structure representing the content of the email."}, "webversion": {"type": "object", "properties": {"domain": {"type": "string"}, "redirectToPageId": {"type": "string"}, "isPageRedirected": {"type": "boolean"}, "redirectToUrl": {"type": "string"}, "title": {"type": "string"}, "metaDescription": {"type": "string"}, "pageExpiryEnabled": {"type": "boolean"}, "enabled": {"type": "boolean"}, "slug": {"type": "string"}, "url": {"type": "string"}, "expiresAt": {"type": "string", "format": "date-time"}}}, "archived": {"type": "boolean", "description": "Determines if the email is archived or not."}, "subscriptionDetails": {"type": "object", "properties": {"officeLocationId": {"type": "string", "description": "ID of the selected office location."}, "subscriptionName": {"type": "string"}, "preferencesGroupId": {"type": "string"}, "subscriptionId": {"type": "string", "description": "ID of the subscription."}}, "description": "Data structure representing the subscription fields of the email."}, "activeDomain": {"type": "string", "description": "The active domain of the email."}, "name": {"type": "string", "description": "The name of the email, as displayed on the email dashboard."}, "campaign": {"type": "string", "description": "The ID of the campaign this email is associated to."}, "from": {"type": "object", "properties": {"customReplyTo": {"type": "string", "description": "The reply to recipients will see."}, "fromName": {"type": "string", "description": "The name recipients will see."}, "replyTo": {"type": "string", "description": "The from address and reply to email address (if no customReplyTo defined) recipients will see."}}, "description": "Data structure representing the from fields on the email."}, "jitterSendTime": {"type": "boolean"}, "state": {"type": "string", "description": "The email state.", "enum": ["AUTOMATED", "AUTOMATED_DRAFT", "AUTOMATED_SENDING", "AUTOMATED_FOR_FORM", "AUTOMATED_FOR_FORM_BUFFER", "AUTOMATED_FOR_FORM_DRAFT", "AUTOMATED_FOR_FORM_LEGACY", "BLOG_EMAIL_DRAFT", "BLOG_EMAIL_PUBLISHED", "DRAFT", "DRAFT_AB", "DRAFT_AB_VARIANT", "ERROR", "LOSER_AB_VARIANT", "PAGE_STUB", "PRE_PROCESSING", "PROCESSING", "PUBLISHED", "PUBLISHED_AB", "PUBLISHED_AB_VARIANT", "PUBLISHED_OR_SCHEDULED", "RSS_TO_EMAIL_DRAFT", "RSS_TO_EMAIL_PUBLISHED", "SCHEDULED", "SCHEDULED_AB", "SCHEDULED_OR_PUBLISHED", "AUTOMATED_AB", "AUTOMATED_AB_VARIANT", "AUTOMATED_DRAFT_AB", "AUTOMATED_DRAFT_ABVARIANT", "AUTOMATED_LOSER_ABVARIANT", "AGENT_GENERATED"]}, "to": {"type": "object", "properties": {"contactIlsLists": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}, "limitSendFrequency": {"type": "boolean"}, "suppressGraymail": {"type": "boolean"}, "contactIds": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}, "contactLists": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}}, "description": "Data structure representing the to fields of the email."}, "subcategory": {"type": "string", "description": "The email subcategory.", "enum": ["ab_master", "ab_variant", "ab_loser_variant", "page_stub", "landing_page", "site_page", "legacy_page", "ab_master_site_page", "ab_variant_site_page", "ab_loser_variant_site_page", "performable_landing_page", "performable_landing_page_cutover", "staged_page", "automated", "automated_for_deal", "automated_for_form", "automated_for_form_legacy", "automated_for_form_buffer", "automated_for_form_draft", "rss_to_email", "rss_to_email_child", "blog_email", "blog_email_child", "optin_email", "optin_followup_email", "batch", "resubscribe_email", "unsubscribe_confirmation_email", "resubscribe_confirmation_email", "single_send_api", "marketing_single_send_api", "smtp_token", "localtime", "automated_for_ticket", "automated_for_leadflow", "automated_for_feedback_ces", "automated_for_feedback_nps", "automated_for_feedback_custom", "membership_registration", "membership_password_saved", "membership_password_reset", "membership_otp_login", "membership_passwordless_auth", "membership_email_verification", "membership_registration_follow_up", "membership_verification", "membership_follow_up", "ticket_closed_kickback_email", "ticket_opened_kickback_email", "automated_for_custom_survey", "discardable_stub", "normal_blog_post", "legacy_blog_post", "imported_blog_post", "automated_ab_master", "automated_ab_variant", "web_interactive", "portal_content", "page_instance_layout", "kb_article_instance_layout", "kb_listing", "kb_search_results", "kb_support_form", "kb_404_page", "case_study", "case_study_listing", "case_study_instance_layout", "scp_static_page", "scp_instance_layout_page", "podcast_instance_layout", "podcast_listing", "blog_article_instance_layout", "blog_article_listing", "blog_author_detail", "UNKNOWN"]}, "sendOnPublish": {"type": "boolean", "description": "Determines whether the email will be sent immediately on publish."}}, "description": "Properties of a marketing email you can update via the API.", "example": {"activeDomain": "test.hs-sites.com", "archived": false, "campaign": "1b7f51a6-33c1-44d6-ba28-fe81f655dced", "content": {"flexAreas": {"main": {"boxed": false, "isSingleColumnFullWidth": false, "sections": [{"columns": [{"id": "column_1606761806181_0", "widgets": ["module_160676180617911"], "width": 12}], "id": "section_1606761806181", "style": {"backgroundColor": "", "backgroundType": "CONTENT"}}, {"columns": [{"id": "column-0-1", "widgets": ["module-0-1-1"], "width": 12}], "id": "section-0", "style": {"backgroundType": "CONTENT", "paddingBottom": "40px", "paddingTop": "40px"}}, {"columns": [{"id": "column-1-1", "widgets": ["module-1-1-1"], "width": 12}], "id": "section-1", "style": {"backgroundColor": "", "backgroundType": "CONTENT", "paddingBottom": "0px", "paddingTop": "0px"}}]}}, "plainTextVersion": "This is custom! View in browser ({{view_as_page_url}})\n\nHello {{ contact.firstname }},\n\nPlain text emails have minimal formatting so your reader can really focus on what you have to say. Introduce yourself and explain why you\u2019re reaching out.\n\nEvery email should try to lead the reader to some kind of action. Use this space to describe why the reader should want to click on the link below. Put the link on its own line to really draw their eye to it.\n\nLink text\n\nNow it\u2019s time to wrap up your email. Before your signature, thank the recipient for reading. You can also invite them to send this email to any of their colleagues who might be interested.\n\nAll the best,\n\nYour full name\n\nYour job title\n\nOther contact information\n\n{{site_settings.company_name}}, {{site_settings.company_street_address_1}}, {{site_settings.company_street_address_2}}, {{site_settings.company_city}}, {{site_settings.company_state}} {{site_settings.company_zip}}, {{site_settings.company_country}}, {{site_settings.company_phone}}\n\nUnsubscribe ({{unsubscribe_link_all}})\n\nManage preferences ({{unsubscribe_link}})", "styleSettings": {}, "widgets": {"module-0-1-1": {"body": {"css_class": "dnd-module", "html": "<p style="margin-bottom:10px;">Hello {{ contact.firstname }},<br><br>Plain text emails have minimal formatting so your reader can really focus on what you have to say. Introduce yourself and explain why you\u2019re reaching out.</p><p style="margin-bottom:10px;">Every email should try to lead the reader to some kind of action. Use this space to describe why the reader should want to click on the link below. Put the link on its own line to really draw their eye to it.</p><p style="margin-bottom:10px;"><a target="_blank" rel="noopener">Link text</a></p><p style="margin-bottom:10px;">Now it\u2019s time to wrap up your email. Before your signature, thank the recipient for reading. You can also invite them to send this email to any of their colleagues who might be interested.</p><p style="margin-bottom:10px;">All the best,<br>Your full name<br>Your job title<br>Other contact information</p>", "i18nKey": "richText.plainText", "path": "@hubspot/rich_text", "schema_version": 2}, "child_css": {}, "css": {}, "id": "module-0-1-1", "module_id": 1155639, "name": "module-0-1-1", "order": 2, "styles": {}, "type": "module"}, "module-1-1-1": {"body": {"align": "center", "css_class": "dnd-module", "font": {"color": "#23496d", "font": "Arial, sans-serif", "size": {"units": "px", "value": 12}}, "link_font": {"color": "#00a4bd", "font": "Helvetica,Arial,sans-serif", "size": {"units": "px", "value": 12}, "styles": {"bold": false, "italic": false, "underline": true}}, "path": "@hubspot/email_footer", "schema_version": 2, "unsubscribe_link_type": "both"}, "child_css": {}, "css": {}, "id": "module-1-1-1", "module_id": 2869621, "name": "module-1-1-1", "order": 3, "styles": {}, "type": "module"}, "module_160676180617911": {"body": {"font": {"color": "#00a4bd", "font": "Arial, sans-serif", "size": {"units": "px", "value": 12}, "styles": {"bold": false, "italic": false, "underline": true}}, "hs_enable_module_padding": false, "hs_wrapper_css": {}}, "child_css": {}, "css": {}, "id": "module_160676180617911", "module_id": 2794854, "name": "module_160676180617911", "styles": {}, "type": "module"}, "preview_text": {"body": {"value": ""}, "child_css": {}, "css": {}, "id": "preview_text", "label": "Preview Text <span class=help-text>This will be used as the preview text that displays in some email clients</span>", "name": "preview_text", "order": 0, "styles": {}, "type": "text"}}}, "createdAt": "2020-11-30T18:43:17.136Z", "createdById": 3739732, "from": {"fromName": "Bruce Wayne", "replyTo": "test@hubspot.com"}, "name": "My subject", "publishDate": "2023-11-30T18:44:20.387Z", "sendOnPublish": true, "state": "DRAFT", "subcategory": "batch", "subject": "My subject", "subscriptionDetails": {"officeLocationId": "5449392956"}, "to": {"contactIds": {}, "contactIlsLists": {"exclude": [1], "include": [5]}, "suppressGraymail": true}, "webversion": {"expiresAt": "2020-11-30T18:44:20.387Z", "metaDescription": "", "redirectToPageId": 0, "redirectToUrl": "http://www.example.org"}}}',
    "CREATEMARKETINGEMAIL": '{"required": ["name"], "type": "object", "properties": {"feedbackSurveyId": {"type": "string", "description": "The ID of the feedback survey linked to the email."}, "rssData": {"type": "object", "properties": {"blogImageMaxWidth": {"type": "integer", "format": "int32"}, "blogEmailType": {"type": "string"}, "hubspotBlogId": {"type": "string"}, "rssEntryTemplate": {"type": "string"}, "timing": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "maxEntries": {"type": "integer", "format": "int32"}, "useHeadlineAsSubject": {"type": "boolean"}, "blogLayout": {"type": "string"}, "url": {"type": "string"}}, "description": "RSS related data if it is a blog or rss email."}, "subject": {"type": "string", "description": "The subject of the email."}, "testing": {"type": "object", "properties": {"isAbVariation": {"type": "boolean"}, "abSamplingDefault": {"type": "string", "description": "Version of the email that should be sent if the results are inconclusive after the test period, master or variant.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abSampleSizeDefault": {"type": "string", "description": "Version of the email that should be sent if there are too few recipients to conduct an AB test.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abStatus": {"type": "string", "description": "Status of the AB test.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abTestPercentage": {"type": "integer", "description": "The size of your test group.", "format": "int32"}, "hoursToWait": {"type": "integer", "description": "Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.", "format": "int32"}, "testId": {"type": "string", "description": "The ID of the AB test."}, "abSuccessMetric": {"type": "string", "description": "Metric to determine the version that will be sent to the remaining contacts.", "enum": ["CLICKS_BY_OPENS", "CLICKS_BY_DELIVERED", "OPENS_BY_DELIVERED"]}}, "description": "AB testing related data. This property is only returned for AB type emails."}, "publishDate": {"type": "string", "description": "The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.", "format": "date-time"}, "language": {"type": "string", "enum": ["af", "af-na", "af-za", "agq", "agq-cm", "ak", "ak-gh", "am", "am-et", "ann", "ann-ng", "ar", "ar-001", "ar-ae", "ar-bh", "ar-dj", "ar-dz", "ar-eg", "ar-eh", "ar-er", "ar-il", "ar-iq", "ar-jo", "ar-km", "ar-kw", "ar-lb", "ar-ly", "ar-ma", "ar-mr", "ar-om", "ar-ps", "ar-qa", "ar-sa", "ar-sd", "ar-so", "ar-ss", "ar-sy", "ar-td", "ar-tn", "ar-ye", "as", "asa", "asa-tz", "ast", "ast-es", "as-in", "az", "az-az", "bas", "bas-cm", "be", "bem", "bem-zm", "bez", "bez-tz", "be-by", "bg", "bgc", "bgc-in", "bg-bg", "bho", "bho-in", "bm", "bm-ml", "bn", "bn-bd", "bn-in", "bo", "bo-cn", "bo-in", "br", "brx", "brx-in", "br-fr", "bs", "bs-ba", "ca", "ca-ad", "ca-es", "ca-fr", "ca-it", "ccp", "ccp-bd", "ccp-in", "ce", "ceb", "ceb-ph", "ce-ru", "cgg", "cgg-ug", "chr", "chr-us", "ckb", "ckb-iq", "ckb-ir", "cs", "cs-cz", "cu", "cu-ru", "cv", "cv-ru", "cy", "cy-gb", "da", "dav", "dav-ke", "da-dk", "da-gl", "de", "de-at", "de-be", "de-ch", "de-de", "de-gr", "de-it", "de-li", "de-lu", "dje", "dje-ne", "doi", "doi-in", "dsb", "dsb-de", "dua", "dua-cm", "dyo", "dyo-sn", "dz", "dz-bt", "ebu", "ebu-ke", "ee", "ee-gh", "ee-tg", "el", "el-cy", "el-gr", "en", "en-001", "en-150", "en-ae", "en-ag", "en-ai", "en-as", "en-at", "en-au", "en-bb", "en-be", "en-bi", "en-bm", "en-bs", "en-bw", "en-bz", "en-ca", "en-cc", "en-ch", "en-ck", "en-cm", "en-cn", "en-cx", "en-cy", "en-de", "en-dg", "en-dk", "en-dm", "en-ee", "en-eg", "en-er", "en-es", "en-fi", "en-fj", "en-fk", "en-fm", "en-fr", "en-gb", "en-gd", "en-gg", "en-gh", "en-gi", "en-gm", "en-gu", "en-gy", "en-hk", "en-ie", "en-il", "en-im", "en-in", "en-io", "en-je", "en-jm", "en-ke", "en-ki", "en-kn", "en-ky", "en-lc", "en-lr", "en-ls", "en-lu", "en-mg", "en-mh", "en-mo", "en-mp", "en-ms", "en-mt", "en-mu", "en-mv", "en-mw", "en-mx", "en-my", "en-na", "en-nf", "en-ng", "en-nl", "en-nr", "en-nu", "en-nz", "en-pg", "en-ph", "en-pk", "en-pn", "en-pr", "en-pw", "en-rw", "en-sb", "en-sc", "en-sd", "en-se", "en-sg", "en-sh", "en-si", "en-sl", "en-ss", "en-sx", "en-sz", "en-tc", "en-tk", "en-tn", "en-to", "en-tt", "en-tv", "en-tz", "en-ug", "en-um", "en-us", "en-vc", "en-vg", "en-vi", "en-vu", "en-ws", "en-za", "en-zm", "en-zw", "eo", "eo-001", "es", "es-419", "es-ar", "es-bo", "es-br", "es-bz", "es-cl", "es-co", "es-cr", "es-cu", "es-do", "es-ea", "es-ec", "es-es", "es-gq", "es-gt", "es-hn", "es-ic", "es-mx", "es-ni", "es-pa", "es-pe", "es-ph", "es-pr", "es-py", "es-sv", "es-us", "es-uy", "es-ve", "et", "et-ee", "eu", "eu-es", "ewo", "ewo-cm", "fa", "fa-af", "fa-ir", "ff", "ff-bf", "ff-cm", "ff-gh", "ff-gm", "ff-gn", "ff-gw", "ff-lr", "ff-mr", "ff-ne", "ff-ng", "ff-sl", "ff-sn", "fi", "fil", "fil-ph", "fi-fi", "fo", "fo-dk", "fo-fo", "fr", "frr", "frr-de", "fr-be", "fr-bf", "fr-bi", "fr-bj", "fr-bl", "fr-ca", "fr-cd", "fr-cf", "fr-cg", "fr-ch", "fr-ci", "fr-cm", "fr-dj", "fr-dz", "fr-fr", "fr-ga", "fr-gf", "fr-gn", "fr-gp", "fr-gq", "fr-ht", "fr-km", "fr-lu", "fr-ma", "fr-mc", "fr-mf", "fr-mg", "fr-ml", "fr-mq", "fr-mr", "fr-mu", "fr-nc", "fr-ne", "fr-pf", "fr-pm", "fr-re", "fr-rw", "fr-sc", "fr-sn", "fr-sy", "fr-td", "fr-tg", "fr-tn", "fr-vu", "fr-wf", "fr-yt", "fur", "fur-it", "fy", "fy-nl", "ga", "ga-gb", "ga-ie", "gd", "gd-gb", "gl", "gl-es", "gsw", "gsw-ch", "gsw-fr", "gsw-li", "gu", "guz", "guz-ke", "gu-in", "gv", "gv-im", "ha", "haw", "haw-us", "ha-gh", "ha-ne", "ha-ng", "he", "he-il", "hi", "hi-in", "hr", "hr-ba", "hr-hr", "hsb", "hsb-de", "hu", "hu-hu", "hy", "hy-am", "ia", "ia-001", "id", "ig", "ig-ng", "ii", "ii-cn", "id-id", "is", "is-is", "it", "it-ch", "it-it", "it-sm", "it-va", "ja", "ja-jp", "jgo", "jgo-cm", "yi", "yi-001", "jmc", "jmc-tz", "jv", "jv-id", "ka", "kab", "kab-dz", "kam", "kam-ke", "ka-ge", "kde", "kde-tz", "kea", "kea-cv", "kgp", "kgp-br", "khq", "khq-ml", "ki", "ki-ke", "kk", "kkj", "kkj-cm", "kk-kz", "kl", "kln", "kln-ke", "kl-gl", "km", "km-kh", "kn", "kn-in", "ko", "kok", "kok-in", "ko-kp", "ko-kr", "ks", "ksb", "ksb-tz", "ksf", "ksf-cm", "ksh", "ksh-de", "ks-in", "ku", "ku-tr", "kw", "kw-gb", "ky", "ky-kg", "lag", "lag-tz", "lb", "lb-lu", "lg", "lg-ug", "lkt", "lkt-us", "ln", "ln-ao", "ln-cd", "ln-cf", "ln-cg", "lo", "lo-la", "lrc", "lrc-iq", "lrc-ir", "lt", "lt-lt", "lu", "luo", "luo-ke", "luy", "luy-ke", "lu-cd", "lv", "lv-lv", "mai", "mai-in", "mas", "mas-ke", "mas-tz", "mdf", "mdf-ru", "mer", "mer-ke", "mfe", "mfe-mu", "mg", "mgh", "mgh-mz", "mgo", "mgo-cm", "mg-mg", "mi", "mi-nz", "mk", "mk-mk", "ml", "ml-in", "mn", "mni", "mni-in", "mn-mn", "mr", "mr-in", "ms", "ms-bn", "ms-id", "ms-my", "ms-sg", "mt", "mt-mt", "mua", "mua-cm", "my", "my-mm", "mzn", "mzn-ir", "naq", "naq-na", "nb", "nb-no", "nb-sj", "nd", "nds", "nds-de", "nds-nl", "nd-zw", "ne", "ne-in", "ne-np", "nl", "nl-aw", "nl-be", "nl-bq", "nl-ch", "nl-cw", "nl-lu", "nl-nl", "nl-sr", "nl-sx", "nmg", "nmg-cm", "nn", "nnh", "nnh-cm", "nn-no", "no", "no-no", "nus", "nus-ss", "nyn", "nyn-ug", "oc", "oc-es", "oc-fr", "om", "om-et", "om-ke", "or", "or-in", "os", "os-ge", "os-ru", "pa", "pa-in", "pa-pk", "pcm", "pcm-ng", "pis", "pis-sb", "pl", "pl-pl", "prg", "prg-001", "ps", "ps-af", "ps-pk", "pt", "pt-ao", "pt-br", "pt-ch", "pt-cv", "pt-gq", "pt-gw", "pt-lu", "pt-mo", "pt-mz", "pt-pt", "pt-st", "pt-tl", "qu", "qu-bo", "qu-ec", "qu-pe", "raj", "raj-in", "rm", "rm-ch", "rn", "rn-bi", "ro", "rof", "rof-tz", "ro-md", "ro-ro", "ru", "ru-by", "ru-kg", "ru-kz", "ru-md", "ru-ru", "ru-ua", "rw", "rwk", "rwk-tz", "rw-rw", "sa", "sah", "sah-ru", "saq", "saq-ke", "sat", "sat-in", "sa-in", "sbp", "sbp-tz", "sc", "sc-it", "sd", "sd-in", "sd-pk", "se", "seh", "seh-mz", "ses", "ses-ml", "se-fi", "se-no", "se-se", "sg", "sg-cf", "shi", "shi-ma", "si", "si-lk", "sk", "sk-sk", "sl", "sl-si", "smn", "smn-fi", "sms", "sms-fi", "sn", "sn-zw", "so", "so-dj", "so-et", "so-ke", "so-so", "sq", "sq-al", "sq-mk", "sq-xk", "sr", "sr-ba", "sr-cs", "sr-me", "sr-rs", "sr-xk", "su", "su-id", "sv", "sv-ax", "sv-fi", "sv-se", "sw", "sw-cd", "sw-ke", "sw-tz", "sw-ug", "sy", "ta", "ta-in", "ta-lk", "ta-my", "ta-sg", "te", "teo", "teo-ke", "teo-ug", "te-in", "tg", "tg-tj", "th", "th-th", "ti", "ti-er", "ti-et", "tk", "tk-tm", "tl", "to", "tok", "tok-001", "to-to", "tr", "tr-cy", "tr-tr", "tt", "tt-ru", "twq", "twq-ne", "tzm", "tzm-ma", "ug", "ug-cn", "uk", "uk-ua", "ur", "ur-in", "ur-pk", "uz", "uz-af", "uz-uz", "vai", "vai-lr", "vi", "vi-vn", "vo", "vo-001", "vun", "vun-tz", "wae", "wae-ch", "wo", "wo-sn", "xh", "xh-za", "xog", "xog-ug", "yav", "yav-cm", "yo", "yo-bj", "yo-ng", "yrl", "yrl-br", "yrl-co", "yrl-ve", "yue", "yue-cn", "yue-hk", "zgh", "zgh-ma", "zh", "zh-cn", "zh-hans", "zh-hant", "zh-hk", "zh-mo", "zh-sg", "zh-tw", "zu", "zu-za"]}, "businessUnitId": {"type": "integer", "format": "int64"}, "content": {"type": "object", "properties": {"smartFields": {"type": "object", "additionalProperties": {"type": "object", "properties": {}, "description": "An email field whose value is controlled by one or more smart rules."}}, "themeSettingsValues": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "flexAreas": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "widgets": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "plainTextVersion": {"type": "string"}, "templatePath": {"type": "string"}, "widgetContainers": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "styleSettings": {"type": "object", "properties": {"backgroundColor": {"type": "string"}, "backgroundImage": {"type": "string"}, "backgroundImageType": {"type": "string"}, "bodyColor": {"type": "string"}, "bodyBorderColor": {"type": "string"}, "bodyBorderWidth": {"type": "number"}, "bodyBorderColorChoice": {"type": "string"}, "primaryFont": {"type": "string"}, "primaryFontColor": {"type": "string"}, "primaryAccentColor": {"type": "string"}, "primaryFontSize": {"type": "number"}, "primaryFontLineHeight": {"type": "string"}, "secondaryFont": {"type": "string"}, "secondaryFontColor": {"type": "string"}, "secondaryAccentColor": {"type": "string"}, "secondaryFontSize": {"type": "number"}, "secondaryFontLineHeight": {"type": "string"}, "headingOneFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "headingTwoFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "linksFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "colorPickerFavorite1": {"type": "string"}, "colorPickerFavorite2": {"type": "string"}, "colorPickerFavorite3": {"type": "string"}, "colorPickerFavorite4": {"type": "string"}, "colorPickerFavorite5": {"type": "string"}, "colorPickerFavorite6": {"type": "string"}, "emailBodyPadding": {"type": "string"}, "emailBodyWidth": {"type": "string"}, "buttonStyleSettings": {"type": "object", "properties": {"backgroundColor": {"type": "object", "properties": {}}, "cornerRadius": {"type": "integer", "format": "int32"}, "fontStyle": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}}}, "dividerStyleSettings": {"type": "object", "properties": {"height": {"type": "integer", "format": "int32"}, "color": {"type": "object", "properties": {}}, "lineType": {"type": "string"}}}}}}, "description": "Data structure representing the content of the email."}, "webversion": {"type": "object", "properties": {"domain": {"type": "string"}, "redirectToPageId": {"type": "string"}, "isPageRedirected": {"type": "boolean"}, "redirectToUrl": {"type": "string"}, "title": {"type": "string"}, "metaDescription": {"type": "string"}, "pageExpiryEnabled": {"type": "boolean"}, "enabled": {"type": "boolean"}, "slug": {"type": "string"}, "url": {"type": "string"}, "expiresAt": {"type": "string", "format": "date-time"}}}, "archived": {"type": "boolean", "description": "Determines if the email is archived or not."}, "subscriptionDetails": {"type": "object", "properties": {"officeLocationId": {"type": "string", "description": "ID of the selected office location."}, "subscriptionName": {"type": "string"}, "preferencesGroupId": {"type": "string"}, "subscriptionId": {"type": "string", "description": "ID of the subscription."}}, "description": "Data structure representing the subscription fields of the email."}, "activeDomain": {"type": "string", "description": "The active domain of the email."}, "name": {"type": "string", "description": "The name of the email, as displayed on the email dashboard."}, "campaign": {"type": "string", "description": "The ID of the campaign this email is associated to."}, "from": {"type": "object", "properties": {"customReplyTo": {"type": "string", "description": "The reply to recipients will see."}, "fromName": {"type": "string", "description": "The name recipients will see."}, "replyTo": {"type": "string", "description": "The from address and reply to email address (if no customReplyTo defined) recipients will see."}}, "description": "Data structure representing the from fields on the email."}, "jitterSendTime": {"type": "boolean"}, "state": {"type": "string", "description": "The email state.", "enum": ["AUTOMATED", "AUTOMATED_DRAFT", "AUTOMATED_SENDING", "AUTOMATED_FOR_FORM", "AUTOMATED_FOR_FORM_BUFFER", "AUTOMATED_FOR_FORM_DRAFT", "AUTOMATED_FOR_FORM_LEGACY", "BLOG_EMAIL_DRAFT", "BLOG_EMAIL_PUBLISHED", "DRAFT", "DRAFT_AB", "DRAFT_AB_VARIANT", "ERROR", "LOSER_AB_VARIANT", "PAGE_STUB", "PRE_PROCESSING", "PROCESSING", "PUBLISHED", "PUBLISHED_AB", "PUBLISHED_AB_VARIANT", "PUBLISHED_OR_SCHEDULED", "RSS_TO_EMAIL_DRAFT", "RSS_TO_EMAIL_PUBLISHED", "SCHEDULED", "SCHEDULED_AB", "SCHEDULED_OR_PUBLISHED", "AUTOMATED_AB", "AUTOMATED_AB_VARIANT", "AUTOMATED_DRAFT_AB", "AUTOMATED_DRAFT_ABVARIANT", "AUTOMATED_LOSER_ABVARIANT", "AGENT_GENERATED"]}, "to": {"type": "object", "properties": {"contactIlsLists": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}, "limitSendFrequency": {"type": "boolean"}, "suppressGraymail": {"type": "boolean"}, "contactIds": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}, "contactLists": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}}, "description": "Data structure representing the to fields of the email."}, "subcategory": {"type": "string", "description": "The email subcategory.", "enum": ["ab_master", "ab_variant", "ab_loser_variant", "page_stub", "landing_page", "site_page", "legacy_page", "ab_master_site_page", "ab_variant_site_page", "ab_loser_variant_site_page", "performable_landing_page", "performable_landing_page_cutover", "staged_page", "automated", "automated_for_deal", "automated_for_form", "automated_for_form_legacy", "automated_for_form_buffer", "automated_for_form_draft", "rss_to_email", "rss_to_email_child", "blog_email", "blog_email_child", "optin_email", "optin_followup_email", "batch", "resubscribe_email", "unsubscribe_confirmation_email", "resubscribe_confirmation_email", "single_send_api", "marketing_single_send_api", "smtp_token", "localtime", "automated_for_ticket", "automated_for_leadflow", "automated_for_feedback_ces", "automated_for_feedback_nps", "automated_for_feedback_custom", "membership_registration", "membership_password_saved", "membership_password_reset", "membership_otp_login", "membership_passwordless_auth", "membership_email_verification", "membership_registration_follow_up", "membership_verification", "membership_follow_up", "ticket_closed_kickback_email", "ticket_opened_kickback_email", "automated_for_custom_survey", "discardable_stub", "normal_blog_post", "legacy_blog_post", "imported_blog_post", "automated_ab_master", "automated_ab_variant", "web_interactive", "portal_content", "page_instance_layout", "kb_article_instance_layout", "kb_listing", "kb_search_results", "kb_support_form", "kb_404_page", "case_study", "case_study_listing", "case_study_instance_layout", "scp_static_page", "scp_instance_layout_page", "podcast_instance_layout", "podcast_listing", "blog_article_instance_layout", "blog_article_listing", "blog_author_detail", "UNKNOWN"]}, "sendOnPublish": {"type": "boolean", "description": "Determines whether the email will be sent immediately on publish."}}, "description": "Properties of a marketing email you can set when creating a marketing email.", "example": {"activeDomain": "test.hs-sites.com", "archived": false, "campaign": "1b7f51a6-33c1-44d6-ba28-fe81f655dced", "content": {"flexAreas": {"main": {"boxed": false, "isSingleColumnFullWidth": false, "sections": [{"columns": [{"id": "column_1606761806181_0", "widgets": ["module_160676180617911"], "width": 12}], "id": "section_1606761806181", "style": {"backgroundColor": "", "backgroundType": "CONTENT"}}, {"columns": [{"id": "column-0-1", "widgets": ["module-0-1-1"], "width": 12}], "id": "section-0", "style": {"backgroundType": "CONTENT", "paddingBottom": "40px", "paddingTop": "40px"}}, {"columns": [{"id": "column-1-1", "widgets": ["module-1-1-1"], "width": 12}], "id": "section-1", "style": {"backgroundColor": "", "backgroundType": "CONTENT", "paddingBottom": "0px", "paddingTop": "0px"}}]}}, "plainTextVersion": "This is custom! View in browser ({{view_as_page_url}})\n\nHello {{ contact.firstname }},\n\nPlain text emails have minimal formatting so your reader can really focus on what you have to say. Introduce yourself and explain why you\u2019re reaching out.\n\nEvery email should try to lead the reader to some kind of action. Use this space to describe why the reader should want to click on the link below. Put the link on its own line to really draw their eye to it.\n\nLink text\n\nNow it\u2019s time to wrap up your email. Before your signature, thank the recipient for reading. You can also invite them to send this email to any of their colleagues who might be interested.\n\nAll the best,\n\nYour full name\n\nYour job title\n\nOther contact information\n\n{{site_settings.company_name}}, {{site_settings.company_street_address_1}}, {{site_settings.company_street_address_2}}, {{site_settings.company_city}}, {{site_settings.company_state}} {{site_settings.company_zip}}, {{site_settings.company_country}}, {{site_settings.company_phone}}\n\nUnsubscribe ({{unsubscribe_link_all}})\n\nManage preferences ({{unsubscribe_link}})", "styleSettings": {}, "widgets": {"module-0-1-1": {"body": {"css_class": "dnd-module", "html": "<p style="margin-bottom:10px;">Hello {{ contact.firstname }},<br><br>Plain text emails have minimal formatting so your reader can really focus on what you have to say. Introduce yourself and explain why you\u2019re reaching out.</p><p style="margin-bottom:10px;">Every email should try to lead the reader to some kind of action. Use this space to describe why the reader should want to click on the link below. Put the link on its own line to really draw their eye to it.</p><p style="margin-bottom:10px;"><a target="_blank" rel="noopener">Link text</a></p><p style="margin-bottom:10px;">Now it\u2019s time to wrap up your email. Before your signature, thank the recipient for reading. You can also invite them to send this email to any of their colleagues who might be interested.</p><p style="margin-bottom:10px;">All the best,<br>Your full name<br>Your job title<br>Other contact information</p>", "i18nKey": "richText.plainText", "path": "@hubspot/rich_text", "schema_version": 2}, "child_css": {}, "css": {}, "id": "module-0-1-1", "module_id": 1155639, "name": "module-0-1-1", "order": 2, "styles": {}, "type": "module"}, "module-1-1-1": {"body": {"align": "center", "css_class": "dnd-module", "font": {"color": "#23496d", "font": "Arial, sans-serif", "size": {"units": "px", "value": 12}}, "link_font": {"color": "#00a4bd", "font": "Helvetica,Arial,sans-serif", "size": {"units": "px", "value": 12}, "styles": {"bold": false, "italic": false, "underline": true}}, "path": "@hubspot/email_footer", "schema_version": 2, "unsubscribe_link_type": "both"}, "child_css": {}, "css": {}, "id": "module-1-1-1", "module_id": 2869621, "name": "module-1-1-1", "order": 3, "styles": {}, "type": "module"}, "module_160676180617911": {"body": {"font": {"color": "#00a4bd", "font": "Arial, sans-serif", "size": {"units": "px", "value": 12}, "styles": {"bold": false, "italic": false, "underline": true}}, "hs_enable_module_padding": false, "hs_wrapper_css": {}}, "child_css": {}, "css": {}, "id": "module_160676180617911", "module_id": 2794854, "name": "module_160676180617911", "styles": {}, "type": "module"}, "preview_text": {"body": {"value": ""}, "child_css": {}, "css": {}, "id": "preview_text", "label": "Preview Text <span class=help-text>This will be used as the preview text that displays in some email clients</span>", "name": "preview_text", "order": 0, "styles": {}, "type": "text"}}}, "createdAt": "2020-11-30T18:43:17.136Z", "createdById": 3739732, "from": {"fromName": "Bruce Wayne", "replyTo": "test@hubspot.com"}, "name": "My subject", "publishDate": "2023-11-30T18:44:20.387Z", "sendOnPublish": true, "state": "DRAFT", "subcategory": "batch", "subject": "My subject", "subscriptionDetails": {"officeLocationId": "5449392956"}, "to": {"contactIds": {}, "contactIlsLists": {"exclude": [1], "include": [5]}, "suppressGraymail": true}, "webversion": {"expiresAt": "2020-11-30T18:44:20.387Z", "metaDescription": "", "redirectToPageId": 0, "redirectToUrl": "http://www.example.org"}}}',
    "UPDATEMARKETINGEMAILPROPERTIES": '{"type": "object", "properties": {"rssData": {"type": "object", "properties": {"blogImageMaxWidth": {"type": "integer", "format": "int32"}, "blogEmailType": {"type": "string"}, "hubspotBlogId": {"type": "string"}, "rssEntryTemplate": {"type": "string"}, "timing": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "maxEntries": {"type": "integer", "format": "int32"}, "useHeadlineAsSubject": {"type": "boolean"}, "blogLayout": {"type": "string"}, "url": {"type": "string"}}, "description": "RSS related data if it is a blog or rss email."}, "subject": {"type": "string", "description": "The subject of the email."}, "testing": {"type": "object", "properties": {"isAbVariation": {"type": "boolean"}, "abSamplingDefault": {"type": "string", "description": "Version of the email that should be sent if the results are inconclusive after the test period, master or variant.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abSampleSizeDefault": {"type": "string", "description": "Version of the email that should be sent if there are too few recipients to conduct an AB test.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abStatus": {"type": "string", "description": "Status of the AB test.", "enum": ["master", "variant", "loser_variant", "mab_master", "mab_variant", "automated_master", "automated_variant", "automated_loser_variant"]}, "abTestPercentage": {"type": "integer", "description": "The size of your test group.", "format": "int32"}, "hoursToWait": {"type": "integer", "description": "Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.", "format": "int32"}, "testId": {"type": "string", "description": "The ID of the AB test."}, "abSuccessMetric": {"type": "string", "description": "Metric to determine the version that will be sent to the remaining contacts.", "enum": ["CLICKS_BY_OPENS", "CLICKS_BY_DELIVERED", "OPENS_BY_DELIVERED"]}}, "description": "AB testing related data. This property is only returned for AB type emails."}, "publishDate": {"type": "string", "description": "The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.", "format": "date-time"}, "language": {"type": "string", "enum": ["af", "af-na", "af-za", "agq", "agq-cm", "ak", "ak-gh", "am", "am-et", "ann", "ann-ng", "ar", "ar-001", "ar-ae", "ar-bh", "ar-dj", "ar-dz", "ar-eg", "ar-eh", "ar-er", "ar-il", "ar-iq", "ar-jo", "ar-km", "ar-kw", "ar-lb", "ar-ly", "ar-ma", "ar-mr", "ar-om", "ar-ps", "ar-qa", "ar-sa", "ar-sd", "ar-so", "ar-ss", "ar-sy", "ar-td", "ar-tn", "ar-ye", "as", "asa", "asa-tz", "ast", "ast-es", "as-in", "az", "az-az", "bas", "bas-cm", "be", "bem", "bem-zm", "bez", "bez-tz", "be-by", "bg", "bgc", "bgc-in", "bg-bg", "bho", "bho-in", "bm", "bm-ml", "bn", "bn-bd", "bn-in", "bo", "bo-cn", "bo-in", "br", "brx", "brx-in", "br-fr", "bs", "bs-ba", "ca", "ca-ad", "ca-es", "ca-fr", "ca-it", "ccp", "ccp-bd", "ccp-in", "ce", "ceb", "ceb-ph", "ce-ru", "cgg", "cgg-ug", "chr", "chr-us", "ckb", "ckb-iq", "ckb-ir", "cs", "cs-cz", "cu", "cu-ru", "cv", "cv-ru", "cy", "cy-gb", "da", "dav", "dav-ke", "da-dk", "da-gl", "de", "de-at", "de-be", "de-ch", "de-de", "de-gr", "de-it", "de-li", "de-lu", "dje", "dje-ne", "doi", "doi-in", "dsb", "dsb-de", "dua", "dua-cm", "dyo", "dyo-sn", "dz", "dz-bt", "ebu", "ebu-ke", "ee", "ee-gh", "ee-tg", "el", "el-cy", "el-gr", "en", "en-001", "en-150", "en-ae", "en-ag", "en-ai", "en-as", "en-at", "en-au", "en-bb", "en-be", "en-bi", "en-bm", "en-bs", "en-bw", "en-bz", "en-ca", "en-cc", "en-ch", "en-ck", "en-cm", "en-cn", "en-cx", "en-cy", "en-de", "en-dg", "en-dk", "en-dm", "en-ee", "en-eg", "en-er", "en-es", "en-fi", "en-fj", "en-fk", "en-fm", "en-fr", "en-gb", "en-gd", "en-gg", "en-gh", "en-gi", "en-gm", "en-gu", "en-gy", "en-hk", "en-ie", "en-il", "en-im", "en-in", "en-io", "en-je", "en-jm", "en-ke", "en-ki", "en-kn", "en-ky", "en-lc", "en-lr", "en-ls", "en-lu", "en-mg", "en-mh", "en-mo", "en-mp", "en-ms", "en-mt", "en-mu", "en-mv", "en-mw", "en-mx", "en-my", "en-na", "en-nf", "en-ng", "en-nl", "en-nr", "en-nu", "en-nz", "en-pg", "en-ph", "en-pk", "en-pn", "en-pr", "en-pw", "en-rw", "en-sb", "en-sc", "en-sd", "en-se", "en-sg", "en-sh", "en-si", "en-sl", "en-ss", "en-sx", "en-sz", "en-tc", "en-tk", "en-tn", "en-to", "en-tt", "en-tv", "en-tz", "en-ug", "en-um", "en-us", "en-vc", "en-vg", "en-vi", "en-vu", "en-ws", "en-za", "en-zm", "en-zw", "eo", "eo-001", "es", "es-419", "es-ar", "es-bo", "es-br", "es-bz", "es-cl", "es-co", "es-cr", "es-cu", "es-do", "es-ea", "es-ec", "es-es", "es-gq", "es-gt", "es-hn", "es-ic", "es-mx", "es-ni", "es-pa", "es-pe", "es-ph", "es-pr", "es-py", "es-sv", "es-us", "es-uy", "es-ve", "et", "et-ee", "eu", "eu-es", "ewo", "ewo-cm", "fa", "fa-af", "fa-ir", "ff", "ff-bf", "ff-cm", "ff-gh", "ff-gm", "ff-gn", "ff-gw", "ff-lr", "ff-mr", "ff-ne", "ff-ng", "ff-sl", "ff-sn", "fi", "fil", "fil-ph", "fi-fi", "fo", "fo-dk", "fo-fo", "fr", "frr", "frr-de", "fr-be", "fr-bf", "fr-bi", "fr-bj", "fr-bl", "fr-ca", "fr-cd", "fr-cf", "fr-cg", "fr-ch", "fr-ci", "fr-cm", "fr-dj", "fr-dz", "fr-fr", "fr-ga", "fr-gf", "fr-gn", "fr-gp", "fr-gq", "fr-ht", "fr-km", "fr-lu", "fr-ma", "fr-mc", "fr-mf", "fr-mg", "fr-ml", "fr-mq", "fr-mr", "fr-mu", "fr-nc", "fr-ne", "fr-pf", "fr-pm", "fr-re", "fr-rw", "fr-sc", "fr-sn", "fr-sy", "fr-td", "fr-tg", "fr-tn", "fr-vu", "fr-wf", "fr-yt", "fur", "fur-it", "fy", "fy-nl", "ga", "ga-gb", "ga-ie", "gd", "gd-gb", "gl", "gl-es", "gsw", "gsw-ch", "gsw-fr", "gsw-li", "gu", "guz", "guz-ke", "gu-in", "gv", "gv-im", "ha", "haw", "haw-us", "ha-gh", "ha-ne", "ha-ng", "he", "he-il", "hi", "hi-in", "hr", "hr-ba", "hr-hr", "hsb", "hsb-de", "hu", "hu-hu", "hy", "hy-am", "ia", "ia-001", "id", "ig", "ig-ng", "ii", "ii-cn", "id-id", "is", "is-is", "it", "it-ch", "it-it", "it-sm", "it-va", "ja", "ja-jp", "jgo", "jgo-cm", "yi", "yi-001", "jmc", "jmc-tz", "jv", "jv-id", "ka", "kab", "kab-dz", "kam", "kam-ke", "ka-ge", "kde", "kde-tz", "kea", "kea-cv", "kgp", "kgp-br", "khq", "khq-ml", "ki", "ki-ke", "kk", "kkj", "kkj-cm", "kk-kz", "kl", "kln", "kln-ke", "kl-gl", "km", "km-kh", "kn", "kn-in", "ko", "kok", "kok-in", "ko-kp", "ko-kr", "ks", "ksb", "ksb-tz", "ksf", "ksf-cm", "ksh", "ksh-de", "ks-in", "ku", "ku-tr", "kw", "kw-gb", "ky", "ky-kg", "lag", "lag-tz", "lb", "lb-lu", "lg", "lg-ug", "lkt", "lkt-us", "ln", "ln-ao", "ln-cd", "ln-cf", "ln-cg", "lo", "lo-la", "lrc", "lrc-iq", "lrc-ir", "lt", "lt-lt", "lu", "luo", "luo-ke", "luy", "luy-ke", "lu-cd", "lv", "lv-lv", "mai", "mai-in", "mas", "mas-ke", "mas-tz", "mdf", "mdf-ru", "mer", "mer-ke", "mfe", "mfe-mu", "mg", "mgh", "mgh-mz", "mgo", "mgo-cm", "mg-mg", "mi", "mi-nz", "mk", "mk-mk", "ml", "ml-in", "mn", "mni", "mni-in", "mn-mn", "mr", "mr-in", "ms", "ms-bn", "ms-id", "ms-my", "ms-sg", "mt", "mt-mt", "mua", "mua-cm", "my", "my-mm", "mzn", "mzn-ir", "naq", "naq-na", "nb", "nb-no", "nb-sj", "nd", "nds", "nds-de", "nds-nl", "nd-zw", "ne", "ne-in", "ne-np", "nl", "nl-aw", "nl-be", "nl-bq", "nl-ch", "nl-cw", "nl-lu", "nl-nl", "nl-sr", "nl-sx", "nmg", "nmg-cm", "nn", "nnh", "nnh-cm", "nn-no", "no", "no-no", "nus", "nus-ss", "nyn", "nyn-ug", "oc", "oc-es", "oc-fr", "om", "om-et", "om-ke", "or", "or-in", "os", "os-ge", "os-ru", "pa", "pa-in", "pa-pk", "pcm", "pcm-ng", "pis", "pis-sb", "pl", "pl-pl", "prg", "prg-001", "ps", "ps-af", "ps-pk", "pt", "pt-ao", "pt-br", "pt-ch", "pt-cv", "pt-gq", "pt-gw", "pt-lu", "pt-mo", "pt-mz", "pt-pt", "pt-st", "pt-tl", "qu", "qu-bo", "qu-ec", "qu-pe", "raj", "raj-in", "rm", "rm-ch", "rn", "rn-bi", "ro", "rof", "rof-tz", "ro-md", "ro-ro", "ru", "ru-by", "ru-kg", "ru-kz", "ru-md", "ru-ru", "ru-ua", "rw", "rwk", "rwk-tz", "rw-rw", "sa", "sah", "sah-ru", "saq", "saq-ke", "sat", "sat-in", "sa-in", "sbp", "sbp-tz", "sc", "sc-it", "sd", "sd-in", "sd-pk", "se", "seh", "seh-mz", "ses", "ses-ml", "se-fi", "se-no", "se-se", "sg", "sg-cf", "shi", "shi-ma", "si", "si-lk", "sk", "sk-sk", "sl", "sl-si", "smn", "smn-fi", "sms", "sms-fi", "sn", "sn-zw", "so", "so-dj", "so-et", "so-ke", "so-so", "sq", "sq-al", "sq-mk", "sq-xk", "sr", "sr-ba", "sr-cs", "sr-me", "sr-rs", "sr-xk", "su", "su-id", "sv", "sv-ax", "sv-fi", "sv-se", "sw", "sw-cd", "sw-ke", "sw-tz", "sw-ug", "sy", "ta", "ta-in", "ta-lk", "ta-my", "ta-sg", "te", "teo", "teo-ke", "teo-ug", "te-in", "tg", "tg-tj", "th", "th-th", "ti", "ti-er", "ti-et", "tk", "tk-tm", "tl", "to", "tok", "tok-001", "to-to", "tr", "tr-cy", "tr-tr", "tt", "tt-ru", "twq", "twq-ne", "tzm", "tzm-ma", "ug", "ug-cn", "uk", "uk-ua", "ur", "ur-in", "ur-pk", "uz", "uz-af", "uz-uz", "vai", "vai-lr", "vi", "vi-vn", "vo", "vo-001", "vun", "vun-tz", "wae", "wae-ch", "wo", "wo-sn", "xh", "xh-za", "xog", "xog-ug", "yav", "yav-cm", "yo", "yo-bj", "yo-ng", "yrl", "yrl-br", "yrl-co", "yrl-ve", "yue", "yue-cn", "yue-hk", "zgh", "zgh-ma", "zh", "zh-cn", "zh-hans", "zh-hant", "zh-hk", "zh-mo", "zh-sg", "zh-tw", "zu", "zu-za"]}, "businessUnitId": {"type": "integer", "format": "int64"}, "content": {"type": "object", "properties": {"smartFields": {"type": "object", "additionalProperties": {"type": "object", "properties": {}, "description": "An email field whose value is controlled by one or more smart rules."}}, "themeSettingsValues": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "flexAreas": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "widgets": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "plainTextVersion": {"type": "string"}, "templatePath": {"type": "string"}, "widgetContainers": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}}, "styleSettings": {"type": "object", "properties": {"backgroundColor": {"type": "string"}, "backgroundImage": {"type": "string"}, "backgroundImageType": {"type": "string"}, "bodyColor": {"type": "string"}, "bodyBorderColor": {"type": "string"}, "bodyBorderWidth": {"type": "number"}, "bodyBorderColorChoice": {"type": "string"}, "primaryFont": {"type": "string"}, "primaryFontColor": {"type": "string"}, "primaryAccentColor": {"type": "string"}, "primaryFontSize": {"type": "number"}, "primaryFontLineHeight": {"type": "string"}, "secondaryFont": {"type": "string"}, "secondaryFontColor": {"type": "string"}, "secondaryAccentColor": {"type": "string"}, "secondaryFontSize": {"type": "number"}, "secondaryFontLineHeight": {"type": "string"}, "headingOneFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "headingTwoFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "linksFont": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}, "colorPickerFavorite1": {"type": "string"}, "colorPickerFavorite2": {"type": "string"}, "colorPickerFavorite3": {"type": "string"}, "colorPickerFavorite4": {"type": "string"}, "colorPickerFavorite5": {"type": "string"}, "colorPickerFavorite6": {"type": "string"}, "emailBodyPadding": {"type": "string"}, "emailBodyWidth": {"type": "string"}, "buttonStyleSettings": {"type": "object", "properties": {"backgroundColor": {"type": "object", "properties": {}}, "cornerRadius": {"type": "integer", "format": "int32"}, "fontStyle": {"type": "object", "properties": {"font": {"type": "string"}, "size": {"type": "integer", "format": "int32"}, "color": {"type": "string"}, "underline": {"type": "boolean"}, "bold": {"type": "boolean"}, "italic": {"type": "boolean"}}}}}, "dividerStyleSettings": {"type": "object", "properties": {"height": {"type": "integer", "format": "int32"}, "color": {"type": "object", "properties": {}}, "lineType": {"type": "string"}}}}}}, "description": "Data structure representing the content of the email."}, "webversion": {"type": "object", "properties": {"domain": {"type": "string"}, "redirectToPageId": {"type": "string"}, "isPageRedirected": {"type": "boolean"}, "redirectToUrl": {"type": "string"}, "title": {"type": "string"}, "metaDescription": {"type": "string"}, "pageExpiryEnabled": {"type": "boolean"}, "enabled": {"type": "boolean"}, "slug": {"type": "string"}, "url": {"type": "string"}, "expiresAt": {"type": "string", "format": "date-time"}}}, "archived": {"type": "boolean", "description": "Determines if the email is archived or not."}, "subscriptionDetails": {"type": "object", "properties": {"officeLocationId": {"type": "string", "description": "ID of the selected office location."}, "subscriptionName": {"type": "string"}, "preferencesGroupId": {"type": "string"}, "subscriptionId": {"type": "string", "description": "ID of the subscription."}}, "description": "Data structure representing the subscription fields of the email."}, "activeDomain": {"type": "string", "description": "The active domain of the email."}, "name": {"type": "string", "description": "The name of the email, as displayed on the email dashboard."}, "campaign": {"type": "string", "description": "The ID of the campaign this email is associated to."}, "from": {"type": "object", "properties": {"customReplyTo": {"type": "string", "description": "The reply to recipients will see."}, "fromName": {"type": "string", "description": "The name recipients will see."}, "replyTo": {"type": "string", "description": "The from address and reply to email address (if no customReplyTo defined) recipients will see."}}, "description": "Data structure representing the from fields on the email."}, "jitterSendTime": {"type": "boolean"}, "state": {"type": "string", "description": "The email state.", "enum": ["AUTOMATED", "AUTOMATED_DRAFT", "AUTOMATED_SENDING", "AUTOMATED_FOR_FORM", "AUTOMATED_FOR_FORM_BUFFER", "AUTOMATED_FOR_FORM_DRAFT", "AUTOMATED_FOR_FORM_LEGACY", "BLOG_EMAIL_DRAFT", "BLOG_EMAIL_PUBLISHED", "DRAFT", "DRAFT_AB", "DRAFT_AB_VARIANT", "ERROR", "LOSER_AB_VARIANT", "PAGE_STUB", "PRE_PROCESSING", "PROCESSING", "PUBLISHED", "PUBLISHED_AB", "PUBLISHED_AB_VARIANT", "PUBLISHED_OR_SCHEDULED", "RSS_TO_EMAIL_DRAFT", "RSS_TO_EMAIL_PUBLISHED", "SCHEDULED", "SCHEDULED_AB", "SCHEDULED_OR_PUBLISHED", "AUTOMATED_AB", "AUTOMATED_AB_VARIANT", "AUTOMATED_DRAFT_AB", "AUTOMATED_DRAFT_ABVARIANT", "AUTOMATED_LOSER_ABVARIANT", "AGENT_GENERATED"]}, "to": {"type": "object", "properties": {"contactIlsLists": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}, "limitSendFrequency": {"type": "boolean"}, "suppressGraymail": {"type": "boolean"}, "contactIds": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}, "contactLists": {"type": "object", "properties": {"include": {"type": "array", "description": "Included IDs.", "items": {"type": "string"}}, "exclude": {"type": "array", "description": "Excluded IDs.", "items": {"type": "string"}}}, "description": "Data structure representing lists of IDs that should be included and excluded."}}, "description": "Data structure representing the to fields of the email."}, "subcategory": {"type": "string", "description": "The email subcategory.", "enum": ["ab_master", "ab_variant", "ab_loser_variant", "page_stub", "landing_page", "site_page", "legacy_page", "ab_master_site_page", "ab_variant_site_page", "ab_loser_variant_site_page", "performable_landing_page", "performable_landing_page_cutover", "staged_page", "automated", "automated_for_deal", "automated_for_form", "automated_for_form_legacy", "automated_for_form_buffer", "automated_for_form_draft", "rss_to_email", "rss_to_email_child", "blog_email", "blog_email_child", "optin_email", "optin_followup_email", "batch", "resubscribe_email", "unsubscribe_confirmation_email", "resubscribe_confirmation_email", "single_send_api", "marketing_single_send_api", "smtp_token", "localtime", "automated_for_ticket", "automated_for_leadflow", "automated_for_feedback_ces", "automated_for_feedback_nps", "automated_for_feedback_custom", "membership_registration", "membership_password_saved", "membership_password_reset", "membership_otp_login", "membership_passwordless_auth", "membership_email_verification", "membership_registration_follow_up", "membership_verification", "membership_follow_up", "ticket_closed_kickback_email", "ticket_opened_kickback_email", "automated_for_custom_survey", "discardable_stub", "normal_blog_post", "legacy_blog_post", "imported_blog_post", "automated_ab_master", "automated_ab_variant", "web_interactive", "portal_content", "page_instance_layout", "kb_article_instance_layout", "kb_listing", "kb_search_results", "kb_support_form", "kb_404_page", "case_study", "case_study_listing", "case_study_instance_layout", "scp_static_page", "scp_instance_layout_page", "podcast_instance_layout", "podcast_listing", "blog_article_instance_layout", "blog_article_listing", "blog_author_detail", "UNKNOWN"]}, "sendOnPublish": {"type": "boolean", "description": "Determines whether the email will be sent immediately on publish."}}, "description": "Properties of a marketing email you can update via the API.", "example": {"activeDomain": "test.hs-sites.com", "archived": false, "campaign": "1b7f51a6-33c1-44d6-ba28-fe81f655dced", "content": {"flexAreas": {"main": {"boxed": false, "isSingleColumnFullWidth": false, "sections": [{"columns": [{"id": "column_1606761806181_0", "widgets": ["module_160676180617911"], "width": 12}], "id": "section_1606761806181", "style": {"backgroundColor": "", "backgroundType": "CONTENT"}}, {"columns": [{"id": "column-0-1", "widgets": ["module-0-1-1"], "width": 12}], "id": "section-0", "style": {"backgroundType": "CONTENT", "paddingBottom": "40px", "paddingTop": "40px"}}, {"columns": [{"id": "column-1-1", "widgets": ["module-1-1-1"], "width": 12}], "id": "section-1", "style": {"backgroundColor": "", "backgroundType": "CONTENT", "paddingBottom": "0px", "paddingTop": "0px"}}]}}, "plainTextVersion": "This is custom! View in browser ({{view_as_page_url}})\n\nHello {{ contact.firstname }},\n\nPlain text emails have minimal formatting so your reader can really focus on what you have to say. Introduce yourself and explain why you\u2019re reaching out.\n\nEvery email should try to lead the reader to some kind of action. Use this space to describe why the reader should want to click on the link below. Put the link on its own line to really draw their eye to it.\n\nLink text\n\nNow it\u2019s time to wrap up your email. Before your signature, thank the recipient for reading. You can also invite them to send this email to any of their colleagues who might be interested.\n\nAll the best,\n\nYour full name\n\nYour job title\n\nOther contact information\n\n{{site_settings.company_name}}, {{site_settings.company_street_address_1}}, {{site_settings.company_street_address_2}}, {{site_settings.company_city}}, {{site_settings.company_state}} {{site_settings.company_zip}}, {{site_settings.company_country}}, {{site_settings.company_phone}}\n\nUnsubscribe ({{unsubscribe_link_all}})\n\nManage preferences ({{unsubscribe_link}})", "styleSettings": {}, "widgets": {"module-0-1-1": {"body": {"css_class": "dnd-module", "html": "<p style="margin-bottom:10px;">Hello {{ contact.firstname }},<br><br>Plain text emails have minimal formatting so your reader can really focus on what you have to say. Introduce yourself and explain why you\u2019re reaching out.</p><p style="margin-bottom:10px;">Every email should try to lead the reader to some kind of action. Use this space to describe why the reader should want to click on the link below. Put the link on its own line to really draw their eye to it.</p><p style="margin-bottom:10px;"><a target="_blank" rel="noopener">Link text</a></p><p style="margin-bottom:10px;">Now it\u2019s time to wrap up your email. Before your signature, thank the recipient for reading. You can also invite them to send this email to any of their colleagues who might be interested.</p><p style="margin-bottom:10px;">All the best,<br>Your full name<br>Your job title<br>Other contact information</p>", "i18nKey": "richText.plainText", "path": "@hubspot/rich_text", "schema_version": 2}, "child_css": {}, "css": {}, "id": "module-0-1-1", "module_id": 1155639, "name": "module-0-1-1", "order": 2, "styles": {}, "type": "module"}, "module-1-1-1": {"body": {"align": "center", "css_class": "dnd-module", "font": {"color": "#23496d", "font": "Arial, sans-serif", "size": {"units": "px", "value": 12}}, "link_font": {"color": "#00a4bd", "font": "Helvetica,Arial,sans-serif", "size": {"units": "px", "value": 12}, "styles": {"bold": false, "italic": false, "underline": true}}, "path": "@hubspot/email_footer", "schema_version": 2, "unsubscribe_link_type": "both"}, "child_css": {}, "css": {}, "id": "module-1-1-1", "module_id": 2869621, "name": "module-1-1-1", "order": 3, "styles": {}, "type": "module"}, "module_160676180617911": {"body": {"font": {"color": "#00a4bd", "font": "Arial, sans-serif", "size": {"units": "px", "value": 12}, "styles": {"bold": false, "italic": false, "underline": true}}, "hs_enable_module_padding": false, "hs_wrapper_css": {}}, "child_css": {}, "css": {}, "id": "module_160676180617911", "module_id": 2794854, "name": "module_160676180617911", "styles": {}, "type": "module"}, "preview_text": {"body": {"value": ""}, "child_css": {}, "css": {}, "id": "preview_text", "label": "Preview Text <span class=help-text>This will be used as the preview text that displays in some email clients</span>", "name": "preview_text", "order": 0, "styles": {}, "type": "text"}}}, "createdAt": "2020-11-30T18:43:17.136Z", "createdById": 3739732, "from": {"fromName": "Bruce Wayne", "replyTo": "test@hubspot.com"}, "name": "My subject", "publishDate": "2023-11-30T18:44:20.387Z", "sendOnPublish": true, "state": "DRAFT", "subcategory": "batch", "subject": "My subject", "subscriptionDetails": {"officeLocationId": "5449392956"}, "to": {"contactIds": {}, "contactIlsLists": {"exclude": [1], "include": [5]}, "suppressGraymail": true}, "webversion": {"expiresAt": "2020-11-30T18:44:20.387Z", "metaDescription": "", "redirectToPageId": 0, "redirectToUrl": "http://www.example.org"}}}',
    "RECORDMARKETINGEVENTATTENDANCE": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "description": "List of HubSpot contacts to subscribe to the marketing event", "items": {"required": ["interactionDateTime"], "type": "object", "properties": {"vid": {"type": "integer", "format": "int32"}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}, "interactionDateTime": {"type": "integer", "description": "Timestamp in milliseconds at which the contact subscribed to the event.", "format": "int64"}}}}}}',
    "RECORDHUBSPOTSUBSCRIBERSTATE": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "description": "List of HubSpot contacts to subscribe to the marketing event", "items": {"required": ["interactionDateTime"], "type": "object", "properties": {"vid": {"type": "integer", "format": "int32"}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}, "interactionDateTime": {"type": "integer", "description": "Timestamp in milliseconds at which the contact subscribed to the event.", "format": "int64"}}}}}}',
    "UPSERTMARKETINGEVENT": '{"required": ["eventName", "eventOrganizer", "externalAccountId", "externalEventId"], "type": "object", "properties": {"startDateTime": {"type": "string", "description": "The start date and time of the marketing event.", "format": "date-time"}, "customProperties": {"type": "array", "description": "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account\'s definition of the MarketingEvent Object. If they don\'t they will be filtered out and not set.\nIn order to do this you\'ll need to create a new PropertyGroup on the HubSpot account\'s MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "items": {"required": ["name", "sourceUpstreamDeployable", "value"], "type": "object", "properties": {"sourceId": {"type": "string", "description": "The ID of the property source indicating where it was created.", "example": ""}, "selectedByUser": {"type": "boolean", "description": "Whether the value was selected by a user.", "example": false}, "sourceLabel": {"type": "string", "description": "A human-readable label.", "example": ""}, "sourceUpstreamDeployable": {"type": "string"}, "source": {"type": "string", "description": "The origin of the property value, such as "IMPORT" or "API".", "example": "", "enum": ["UNKNOWN", "IMPORT", "API", "FORM", "ANALYTICS", "MIGRATION", "SALESFORCE", "INTEGRATION", "CONTACTS_WEB", "WAL_INCREMENTAL", "TASK", "EMAIL", "WORKFLOWS", "CALCULATED", "SOCIAL", "BATCH_UPDATE", "SIGNALS", "BIDEN", "DEFAULT", "COMPANIES", "DEALS", "ASSISTS", "PRESENTATIONS", "TALLY", "SIDEKICK", "CRM_UI", "MERGE_CONTACTS", "PORTAL_USER_ASSOCIATOR", "INTEGRATIONS_PLATFORM", "BCC_TO_CRM", "FORWARD_TO_CRM", "ENGAGEMENTS", "SALES", "HEISENBERG", "LEADIN", "GMAIL_INTEGRATION", "ACADEMY", "SALES_MESSAGES", "AVATARS_SERVICE", "MERGE_COMPANIES", "SEQUENCES", "COMPANY_FAMILIES", "MOBILE_IOS", "MOBILE_ANDROID", "CONTACTS", "ASSOCIATIONS", "EXTENSION", "SUCCESS", "BOT", "INTEGRATIONS_SYNC", "AUTOMATION_PLATFORM", "CONVERSATIONS", "EMAIL_INTEGRATION", "CONTENT_MEMBERSHIP", "QUOTES", "BET_ASSIGNMENT", "QUOTAS", "BET_CRM_CONNECTOR", "MEETINGS", "MERGE_OBJECTS", "RECYCLING_BIN", "ADS", "AI_GROUP", "COMMUNICATOR", "SETTINGS", "PROPERTY_SETTINGS", "PIPELINE_SETTINGS", "COMPANY_INSIGHTS", "BEHAVIORAL_EVENTS", "PAYMENTS", "GOALS", "PORTAL_OBJECT_SYNC", "APPROVALS", "FILE_MANAGER", "MARKETPLACE", "INTERNAL_PROCESSING", "FORECASTING", "SLACK_INTEGRATION", "CRM_UI_BULK_ACTION", "WORKFLOW_CONTACT_DELETE_ACTION", "ACCEPTANCE_TEST", "PLAYBOOKS", "CHATSPOT", "FLYWHEEL_PRODUCT_DATA_SYNC", "HELP_DESK", "BILLING", "DATA_ENRICHMENT", "AUTOMATION_JOURNEY", "MICROAPPS", "INTENT", "PROSPECTING_AGENT", "CENTRAL_EXCHANGE_RATES", "HELP_DESK_AI", "CONVERSATIONAL_ENRICHMENT", "CRM_PROCESSES_PLATFORM", "CLONE_OBJECTS", "MARKET_SOURCING", "DATASET", "PROPERTY_RESTORE"]}, "updatedByUserId": {"type": "integer", "description": "The ID of the user who updated the property.", "format": "int32"}, "persistenceTimestamp": {"type": "integer", "format": "int64"}, "sourceMetadata": {"type": "string", "description": "Source metadata encoded as a base64 string. For example: `ZXhhbXBsZSBzdHJpbmc=`", "example": ""}, "dataSensitivity": {"type": "string", "description": "The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".", "example": "", "enum": ["none", "standard", "high"]}, "sourceVid": {"type": "array", "description": "The unique identifier associated with the source.", "example": "", "items": {"type": "integer", "format": "int64"}}, "unit": {"type": "string", "description": "The unit of measurement or context for the value.", "example": ""}, "requestId": {"type": "string", "description": "A unique ID associated with this request.", "example": ""}, "isEncrypted": {"type": "boolean", "description": "Whether the property value is encrypted.", "example": false}, "name": {"type": "string", "description": "Name of custom property", "example": ""}, "useTimestampAsPersistenceTimestamp": {"type": "boolean"}, "value": {"type": "string", "description": "Custom property value", "example": ""}, "selectedByUserTimestamp": {"type": "integer", "description": "The timestamp when the value was selected by a user, if applicable.", "format": "int64"}, "timestamp": {"type": "integer", "description": "When the value was set, as a 64-bit integer.", "format": "int64"}, "isLargeValue": {"type": "boolean"}}, "description": "Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes."}}, "externalAccountId": {"type": "string", "description": "The accountId that is associated with this marketing event in the external event application."}, "eventCancelled": {"type": "boolean", "description": "Indicates if the marketing event has been cancelled.  Defaults to `false`"}, "eventOrganizer": {"type": "string", "description": "The name of the organizer of the marketing event."}, "eventUrl": {"type": "string", "description": "A URL in the external event application where the marketing event can be managed."}, "externalEventId": {"type": "string", "description": "The id of the marketing event in the external event application."}, "eventDescription": {"type": "string", "description": "The description of the marketing event."}, "eventName": {"type": "string", "description": "The name of the marketing event."}, "eventType": {"type": "string", "description": "Describes what type of event this is.  For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`"}, "eventCompleted": {"type": "boolean"}, "endDateTime": {"type": "string", "description": "The end date and time of the marketing event.", "format": "date-time"}}}',
    "UPDATEMARKETINGEVENTDETAILS": '{"type": "object", "properties": {"startDateTime": {"type": "string", "description": "The start date and time of the marketing event.", "format": "date-time"}, "customProperties": {"type": "array", "description": "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account\'s definition of the MarketingEvent Object. If they don\'t they will be filtered out and not set.\nIn order to do this you\'ll need to create a new PropertyGroup on the HubSpot account\'s MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "items": {"required": ["name", "sourceUpstreamDeployable", "value"], "type": "object", "properties": {"sourceId": {"type": "string", "description": "The ID of the property source indicating where it was created.", "example": ""}, "selectedByUser": {"type": "boolean", "description": "Whether the value was selected by a user.", "example": false}, "sourceLabel": {"type": "string", "description": "A human-readable label.", "example": ""}, "sourceUpstreamDeployable": {"type": "string"}, "source": {"type": "string", "description": "The origin of the property value, such as "IMPORT" or "API".", "example": "", "enum": ["UNKNOWN", "IMPORT", "API", "FORM", "ANALYTICS", "MIGRATION", "SALESFORCE", "INTEGRATION", "CONTACTS_WEB", "WAL_INCREMENTAL", "TASK", "EMAIL", "WORKFLOWS", "CALCULATED", "SOCIAL", "BATCH_UPDATE", "SIGNALS", "BIDEN", "DEFAULT", "COMPANIES", "DEALS", "ASSISTS", "PRESENTATIONS", "TALLY", "SIDEKICK", "CRM_UI", "MERGE_CONTACTS", "PORTAL_USER_ASSOCIATOR", "INTEGRATIONS_PLATFORM", "BCC_TO_CRM", "FORWARD_TO_CRM", "ENGAGEMENTS", "SALES", "HEISENBERG", "LEADIN", "GMAIL_INTEGRATION", "ACADEMY", "SALES_MESSAGES", "AVATARS_SERVICE", "MERGE_COMPANIES", "SEQUENCES", "COMPANY_FAMILIES", "MOBILE_IOS", "MOBILE_ANDROID", "CONTACTS", "ASSOCIATIONS", "EXTENSION", "SUCCESS", "BOT", "INTEGRATIONS_SYNC", "AUTOMATION_PLATFORM", "CONVERSATIONS", "EMAIL_INTEGRATION", "CONTENT_MEMBERSHIP", "QUOTES", "BET_ASSIGNMENT", "QUOTAS", "BET_CRM_CONNECTOR", "MEETINGS", "MERGE_OBJECTS", "RECYCLING_BIN", "ADS", "AI_GROUP", "COMMUNICATOR", "SETTINGS", "PROPERTY_SETTINGS", "PIPELINE_SETTINGS", "COMPANY_INSIGHTS", "BEHAVIORAL_EVENTS", "PAYMENTS", "GOALS", "PORTAL_OBJECT_SYNC", "APPROVALS", "FILE_MANAGER", "MARKETPLACE", "INTERNAL_PROCESSING", "FORECASTING", "SLACK_INTEGRATION", "CRM_UI_BULK_ACTION", "WORKFLOW_CONTACT_DELETE_ACTION", "ACCEPTANCE_TEST", "PLAYBOOKS", "CHATSPOT", "FLYWHEEL_PRODUCT_DATA_SYNC", "HELP_DESK", "BILLING", "DATA_ENRICHMENT", "AUTOMATION_JOURNEY", "MICROAPPS", "INTENT", "PROSPECTING_AGENT", "CENTRAL_EXCHANGE_RATES", "HELP_DESK_AI", "CONVERSATIONAL_ENRICHMENT", "CRM_PROCESSES_PLATFORM", "CLONE_OBJECTS", "MARKET_SOURCING", "DATASET", "PROPERTY_RESTORE"]}, "updatedByUserId": {"type": "integer", "description": "The ID of the user who updated the property.", "format": "int32"}, "persistenceTimestamp": {"type": "integer", "format": "int64"}, "sourceMetadata": {"type": "string", "description": "Source metadata encoded as a base64 string. For example: `ZXhhbXBsZSBzdHJpbmc=`", "example": ""}, "dataSensitivity": {"type": "string", "description": "The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".", "example": "", "enum": ["none", "standard", "high"]}, "sourceVid": {"type": "array", "description": "The unique identifier associated with the source.", "example": "", "items": {"type": "integer", "format": "int64"}}, "unit": {"type": "string", "description": "The unit of measurement or context for the value.", "example": ""}, "requestId": {"type": "string", "description": "A unique ID associated with this request.", "example": ""}, "isEncrypted": {"type": "boolean", "description": "Whether the property value is encrypted.", "example": false}, "name": {"type": "string", "description": "Name of custom property", "example": ""}, "useTimestampAsPersistenceTimestamp": {"type": "boolean"}, "value": {"type": "string", "description": "Custom property value", "example": ""}, "selectedByUserTimestamp": {"type": "integer", "description": "The timestamp when the value was selected by a user, if applicable.", "format": "int64"}, "timestamp": {"type": "integer", "description": "When the value was set, as a 64-bit integer.", "format": "int64"}, "isLargeValue": {"type": "boolean"}}, "description": "Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes."}}, "eventCancelled": {"type": "boolean", "description": "Indicates if the marketing event has been cancelled. Defaults to `false`"}, "eventOrganizer": {"type": "string", "description": "The name of the organizer of the marketing event."}, "eventUrl": {"type": "string", "description": "A URL in the external event application where the marketing event can be managed."}, "eventDescription": {"type": "string", "description": "The description of the marketing event."}, "eventName": {"type": "string", "description": "The name of the marketing event."}, "eventType": {"type": "string", "description": "Describes what type of event this is.  For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`"}, "eventCompleted": {"type": "boolean"}, "endDateTime": {"type": "string", "description": "The end date and time of the marketing event.", "format": "date-time"}}}',
    "UPSERTMARKETINGEVENTS": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["eventName", "eventOrganizer", "externalAccountId", "externalEventId"], "type": "object", "properties": {"startDateTime": {"type": "string", "description": "The start date and time of the marketing event.", "format": "date-time"}, "customProperties": {"type": "array", "description": "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account\'s definition of the MarketingEvent Object. If they don\'t they will be filtered out and not set.\nIn order to do this you\'ll need to create a new PropertyGroup on the HubSpot account\'s MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "items": {"required": ["name", "sourceUpstreamDeployable", "value"], "type": "object", "properties": {"sourceId": {"type": "string", "description": "The ID of the property source indicating where it was created.", "example": ""}, "selectedByUser": {"type": "boolean", "description": "Whether the value was selected by a user.", "example": false}, "sourceLabel": {"type": "string", "description": "A human-readable label.", "example": ""}, "sourceUpstreamDeployable": {"type": "string"}, "source": {"type": "string", "description": "The origin of the property value, such as "IMPORT" or "API".", "example": "", "enum": ["UNKNOWN", "IMPORT", "API", "FORM", "ANALYTICS", "MIGRATION", "SALESFORCE", "INTEGRATION", "CONTACTS_WEB", "WAL_INCREMENTAL", "TASK", "EMAIL", "WORKFLOWS", "CALCULATED", "SOCIAL", "BATCH_UPDATE", "SIGNALS", "BIDEN", "DEFAULT", "COMPANIES", "DEALS", "ASSISTS", "PRESENTATIONS", "TALLY", "SIDEKICK", "CRM_UI", "MERGE_CONTACTS", "PORTAL_USER_ASSOCIATOR", "INTEGRATIONS_PLATFORM", "BCC_TO_CRM", "FORWARD_TO_CRM", "ENGAGEMENTS", "SALES", "HEISENBERG", "LEADIN", "GMAIL_INTEGRATION", "ACADEMY", "SALES_MESSAGES", "AVATARS_SERVICE", "MERGE_COMPANIES", "SEQUENCES", "COMPANY_FAMILIES", "MOBILE_IOS", "MOBILE_ANDROID", "CONTACTS", "ASSOCIATIONS", "EXTENSION", "SUCCESS", "BOT", "INTEGRATIONS_SYNC", "AUTOMATION_PLATFORM", "CONVERSATIONS", "EMAIL_INTEGRATION", "CONTENT_MEMBERSHIP", "QUOTES", "BET_ASSIGNMENT", "QUOTAS", "BET_CRM_CONNECTOR", "MEETINGS", "MERGE_OBJECTS", "RECYCLING_BIN", "ADS", "AI_GROUP", "COMMUNICATOR", "SETTINGS", "PROPERTY_SETTINGS", "PIPELINE_SETTINGS", "COMPANY_INSIGHTS", "BEHAVIORAL_EVENTS", "PAYMENTS", "GOALS", "PORTAL_OBJECT_SYNC", "APPROVALS", "FILE_MANAGER", "MARKETPLACE", "INTERNAL_PROCESSING", "FORECASTING", "SLACK_INTEGRATION", "CRM_UI_BULK_ACTION", "WORKFLOW_CONTACT_DELETE_ACTION", "ACCEPTANCE_TEST", "PLAYBOOKS", "CHATSPOT", "FLYWHEEL_PRODUCT_DATA_SYNC", "HELP_DESK", "BILLING", "DATA_ENRICHMENT", "AUTOMATION_JOURNEY", "MICROAPPS", "INTENT", "PROSPECTING_AGENT", "CENTRAL_EXCHANGE_RATES", "HELP_DESK_AI", "CONVERSATIONAL_ENRICHMENT", "CRM_PROCESSES_PLATFORM", "CLONE_OBJECTS", "MARKET_SOURCING", "DATASET", "PROPERTY_RESTORE"]}, "updatedByUserId": {"type": "integer", "description": "The ID of the user who updated the property.", "format": "int32"}, "persistenceTimestamp": {"type": "integer", "format": "int64"}, "sourceMetadata": {"type": "string", "description": "Source metadata encoded as a base64 string. For example: `ZXhhbXBsZSBzdHJpbmc=`", "example": ""}, "dataSensitivity": {"type": "string", "description": "The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".", "example": "", "enum": ["none", "standard", "high"]}, "sourceVid": {"type": "array", "description": "The unique identifier associated with the source.", "example": "", "items": {"type": "integer", "format": "int64"}}, "unit": {"type": "string", "description": "The unit of measurement or context for the value.", "example": ""}, "requestId": {"type": "string", "description": "A unique ID associated with this request.", "example": ""}, "isEncrypted": {"type": "boolean", "description": "Whether the property value is encrypted.", "example": false}, "name": {"type": "string", "description": "Name of custom property", "example": ""}, "useTimestampAsPersistenceTimestamp": {"type": "boolean"}, "value": {"type": "string", "description": "Custom property value", "example": ""}, "selectedByUserTimestamp": {"type": "integer", "description": "The timestamp when the value was selected by a user, if applicable.", "format": "int64"}, "timestamp": {"type": "integer", "description": "When the value was set, as a 64-bit integer.", "format": "int64"}, "isLargeValue": {"type": "boolean"}}, "description": "Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes."}}, "externalAccountId": {"type": "string", "description": "The accountId that is associated with this marketing event in the external event application."}, "eventCancelled": {"type": "boolean", "description": "Indicates if the marketing event has been cancelled.  Defaults to `false`"}, "eventOrganizer": {"type": "string", "description": "The name of the organizer of the marketing event."}, "eventUrl": {"type": "string", "description": "A URL in the external event application where the marketing event can be managed."}, "externalEventId": {"type": "string", "description": "The id of the marketing event in the external event application."}, "eventDescription": {"type": "string", "description": "The description of the marketing event."}, "eventName": {"type": "string", "description": "The name of the marketing event."}, "eventType": {"type": "string", "description": "Describes what type of event this is.  For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`"}, "eventCompleted": {"type": "boolean"}, "endDateTime": {"type": "string", "description": "The end date and time of the marketing event.", "format": "date-time"}}}}}}',
    "RECORDEVENTPARTICIPATIONHUBSPOT": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "description": "List of marketing event details to create or update", "items": {"required": ["email", "interactionDateTime"], "type": "object", "properties": {"contactProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}, "email": {"type": "string", "description": "The email address of the contact in HubSpot to associate with the event."}, "interactionDateTime": {"type": "integer", "description": "Timestamp in milliseconds at which the contact subscribed to the event.", "format": "int64"}}}}}}',
    "MODIFYEVENTINFORMATION": '{"required": ["customProperties"], "type": "object", "properties": {"startDateTime": {"type": "string", "format": "date-time"}, "customProperties": {"type": "array", "items": {"required": ["name", "sourceUpstreamDeployable", "value"], "type": "object", "properties": {"sourceId": {"type": "string", "description": "The ID of the property source indicating where it was created.", "example": ""}, "selectedByUser": {"type": "boolean", "description": "Whether the value was selected by a user.", "example": false}, "sourceLabel": {"type": "string", "description": "A human-readable label.", "example": ""}, "sourceUpstreamDeployable": {"type": "string"}, "source": {"type": "string", "description": "The origin of the property value, such as "IMPORT" or "API".", "example": "", "enum": ["UNKNOWN", "IMPORT", "API", "FORM", "ANALYTICS", "MIGRATION", "SALESFORCE", "INTEGRATION", "CONTACTS_WEB", "WAL_INCREMENTAL", "TASK", "EMAIL", "WORKFLOWS", "CALCULATED", "SOCIAL", "BATCH_UPDATE", "SIGNALS", "BIDEN", "DEFAULT", "COMPANIES", "DEALS", "ASSISTS", "PRESENTATIONS", "TALLY", "SIDEKICK", "CRM_UI", "MERGE_CONTACTS", "PORTAL_USER_ASSOCIATOR", "INTEGRATIONS_PLATFORM", "BCC_TO_CRM", "FORWARD_TO_CRM", "ENGAGEMENTS", "SALES", "HEISENBERG", "LEADIN", "GMAIL_INTEGRATION", "ACADEMY", "SALES_MESSAGES", "AVATARS_SERVICE", "MERGE_COMPANIES", "SEQUENCES", "COMPANY_FAMILIES", "MOBILE_IOS", "MOBILE_ANDROID", "CONTACTS", "ASSOCIATIONS", "EXTENSION", "SUCCESS", "BOT", "INTEGRATIONS_SYNC", "AUTOMATION_PLATFORM", "CONVERSATIONS", "EMAIL_INTEGRATION", "CONTENT_MEMBERSHIP", "QUOTES", "BET_ASSIGNMENT", "QUOTAS", "BET_CRM_CONNECTOR", "MEETINGS", "MERGE_OBJECTS", "RECYCLING_BIN", "ADS", "AI_GROUP", "COMMUNICATOR", "SETTINGS", "PROPERTY_SETTINGS", "PIPELINE_SETTINGS", "COMPANY_INSIGHTS", "BEHAVIORAL_EVENTS", "PAYMENTS", "GOALS", "PORTAL_OBJECT_SYNC", "APPROVALS", "FILE_MANAGER", "MARKETPLACE", "INTERNAL_PROCESSING", "FORECASTING", "SLACK_INTEGRATION", "CRM_UI_BULK_ACTION", "WORKFLOW_CONTACT_DELETE_ACTION", "ACCEPTANCE_TEST", "PLAYBOOKS", "CHATSPOT", "FLYWHEEL_PRODUCT_DATA_SYNC", "HELP_DESK", "BILLING", "DATA_ENRICHMENT", "AUTOMATION_JOURNEY", "MICROAPPS", "INTENT", "PROSPECTING_AGENT", "CENTRAL_EXCHANGE_RATES", "HELP_DESK_AI", "CONVERSATIONAL_ENRICHMENT", "CRM_PROCESSES_PLATFORM", "CLONE_OBJECTS", "MARKET_SOURCING", "DATASET", "PROPERTY_RESTORE"]}, "updatedByUserId": {"type": "integer", "description": "The ID of the user who updated the property.", "format": "int32"}, "persistenceTimestamp": {"type": "integer", "format": "int64"}, "sourceMetadata": {"type": "string", "description": "Source metadata encoded as a base64 string. For example: `ZXhhbXBsZSBzdHJpbmc=`", "example": ""}, "dataSensitivity": {"type": "string", "description": "The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".", "example": "", "enum": ["none", "standard", "high"]}, "sourceVid": {"type": "array", "description": "The unique identifier associated with the source.", "example": "", "items": {"type": "integer", "format": "int64"}}, "unit": {"type": "string", "description": "The unit of measurement or context for the value.", "example": ""}, "requestId": {"type": "string", "description": "A unique ID associated with this request.", "example": ""}, "isEncrypted": {"type": "boolean", "description": "Whether the property value is encrypted.", "example": false}, "name": {"type": "string", "description": "Name of custom property", "example": ""}, "useTimestampAsPersistenceTimestamp": {"type": "boolean"}, "value": {"type": "string", "description": "Custom property value", "example": ""}, "selectedByUserTimestamp": {"type": "integer", "description": "The timestamp when the value was selected by a user, if applicable.", "format": "int64"}, "timestamp": {"type": "integer", "description": "When the value was set, as a 64-bit integer.", "format": "int64"}, "isLargeValue": {"type": "boolean"}}, "description": "Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes."}}, "eventCancelled": {"type": "boolean"}, "eventOrganizer": {"type": "string"}, "eventUrl": {"type": "string"}, "eventDescription": {"type": "string"}, "eventName": {"type": "string"}, "eventType": {"type": "string"}, "endDateTime": {"type": "string", "format": "date-time"}}}',
    "REGISTEREVENTPARTICIPATION": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "description": "List of marketing event details to create or update", "items": {"required": ["email", "interactionDateTime"], "type": "object", "properties": {"contactProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}, "email": {"type": "string", "description": "The email address of the contact in HubSpot to associate with the event."}, "interactionDateTime": {"type": "integer", "description": "Timestamp in milliseconds at which the contact subscribed to the event.", "format": "int64"}}}}}}',
    "RECORDEVENTATTENDANCE": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "description": "List of HubSpot contacts to subscribe to the marketing event", "items": {"required": ["interactionDateTime"], "type": "object", "properties": {"vid": {"type": "integer", "format": "int32"}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}, "interactionDateTime": {"type": "integer", "description": "Timestamp in milliseconds at which the contact subscribed to the event.", "format": "int64"}}}}}}',
    "UPDATEMARKETINGEVENTSBATCH": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["customProperties", "objectId"], "type": "object", "properties": {"startDateTime": {"type": "string", "format": "date-time"}, "customProperties": {"type": "array", "items": {"required": ["name", "sourceUpstreamDeployable", "value"], "type": "object", "properties": {"sourceId": {"type": "string", "description": "The ID of the property source indicating where it was created.", "example": ""}, "selectedByUser": {"type": "boolean", "description": "Whether the value was selected by a user.", "example": false}, "sourceLabel": {"type": "string", "description": "A human-readable label.", "example": ""}, "sourceUpstreamDeployable": {"type": "string"}, "source": {"type": "string", "description": "The origin of the property value, such as "IMPORT" or "API".", "example": "", "enum": ["UNKNOWN", "IMPORT", "API", "FORM", "ANALYTICS", "MIGRATION", "SALESFORCE", "INTEGRATION", "CONTACTS_WEB", "WAL_INCREMENTAL", "TASK", "EMAIL", "WORKFLOWS", "CALCULATED", "SOCIAL", "BATCH_UPDATE", "SIGNALS", "BIDEN", "DEFAULT", "COMPANIES", "DEALS", "ASSISTS", "PRESENTATIONS", "TALLY", "SIDEKICK", "CRM_UI", "MERGE_CONTACTS", "PORTAL_USER_ASSOCIATOR", "INTEGRATIONS_PLATFORM", "BCC_TO_CRM", "FORWARD_TO_CRM", "ENGAGEMENTS", "SALES", "HEISENBERG", "LEADIN", "GMAIL_INTEGRATION", "ACADEMY", "SALES_MESSAGES", "AVATARS_SERVICE", "MERGE_COMPANIES", "SEQUENCES", "COMPANY_FAMILIES", "MOBILE_IOS", "MOBILE_ANDROID", "CONTACTS", "ASSOCIATIONS", "EXTENSION", "SUCCESS", "BOT", "INTEGRATIONS_SYNC", "AUTOMATION_PLATFORM", "CONVERSATIONS", "EMAIL_INTEGRATION", "CONTENT_MEMBERSHIP", "QUOTES", "BET_ASSIGNMENT", "QUOTAS", "BET_CRM_CONNECTOR", "MEETINGS", "MERGE_OBJECTS", "RECYCLING_BIN", "ADS", "AI_GROUP", "COMMUNICATOR", "SETTINGS", "PROPERTY_SETTINGS", "PIPELINE_SETTINGS", "COMPANY_INSIGHTS", "BEHAVIORAL_EVENTS", "PAYMENTS", "GOALS", "PORTAL_OBJECT_SYNC", "APPROVALS", "FILE_MANAGER", "MARKETPLACE", "INTERNAL_PROCESSING", "FORECASTING", "SLACK_INTEGRATION", "CRM_UI_BULK_ACTION", "WORKFLOW_CONTACT_DELETE_ACTION", "ACCEPTANCE_TEST", "PLAYBOOKS", "CHATSPOT", "FLYWHEEL_PRODUCT_DATA_SYNC", "HELP_DESK", "BILLING", "DATA_ENRICHMENT", "AUTOMATION_JOURNEY", "MICROAPPS", "INTENT", "PROSPECTING_AGENT", "CENTRAL_EXCHANGE_RATES", "HELP_DESK_AI", "CONVERSATIONAL_ENRICHMENT", "CRM_PROCESSES_PLATFORM", "CLONE_OBJECTS", "MARKET_SOURCING", "DATASET", "PROPERTY_RESTORE"]}, "updatedByUserId": {"type": "integer", "description": "The ID of the user who updated the property.", "format": "int32"}, "persistenceTimestamp": {"type": "integer", "format": "int64"}, "sourceMetadata": {"type": "string", "description": "Source metadata encoded as a base64 string. For example: `ZXhhbXBsZSBzdHJpbmc=`", "example": ""}, "dataSensitivity": {"type": "string", "description": "The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".", "example": "", "enum": ["none", "standard", "high"]}, "sourceVid": {"type": "array", "description": "The unique identifier associated with the source.", "example": "", "items": {"type": "integer", "format": "int64"}}, "unit": {"type": "string", "description": "The unit of measurement or context for the value.", "example": ""}, "requestId": {"type": "string", "description": "A unique ID associated with this request.", "example": ""}, "isEncrypted": {"type": "boolean", "description": "Whether the property value is encrypted.", "example": false}, "name": {"type": "string", "description": "Name of custom property", "example": ""}, "useTimestampAsPersistenceTimestamp": {"type": "boolean"}, "value": {"type": "string", "description": "Custom property value", "example": ""}, "selectedByUserTimestamp": {"type": "integer", "description": "The timestamp when the value was selected by a user, if applicable.", "format": "int64"}, "timestamp": {"type": "integer", "description": "When the value was set, as a 64-bit integer.", "format": "int64"}, "isLargeValue": {"type": "boolean"}}, "description": "Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes."}}, "eventCancelled": {"type": "boolean"}, "eventOrganizer": {"type": "string"}, "eventUrl": {"type": "string"}, "eventDescription": {"type": "string"}, "eventName": {"type": "string"}, "eventType": {"type": "string"}, "endDateTime": {"type": "string", "format": "date-time"}, "objectId": {"type": "string"}}}}}}',
    "DELETEMARKETINGEVENTS": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["objectId"], "type": "object", "properties": {"objectId": {"type": "string"}}}}}}',
    "REMOVEMARKETINGEVENTS": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "items": {"required": ["appId", "externalAccountId", "externalEventId"], "type": "object", "properties": {"externalAccountId": {"type": "string", "description": "The accountId that is associated with this marketing event in the external event application."}, "externalEventId": {"type": "string", "description": "The id of the marketing event in the external event application."}, "appId": {"type": "integer", "description": "The id of the application that created the marketing event in HubSpot.", "format": "int32"}}}}}}',
    "RECORDSUBSCRIBERSTATE": '{"required": ["inputs"], "type": "object", "properties": {"inputs": {"type": "array", "description": "List of marketing event details to create or update", "items": {"required": ["email", "interactionDateTime"], "type": "object", "properties": {"contactProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "properties": {"type": "object", "additionalProperties": {"type": "string"}}, "email": {"type": "string", "description": "The email address of the contact in HubSpot to associate with the event."}, "interactionDateTime": {"type": "integer", "description": "Timestamp in milliseconds at which the contact subscribed to the event.", "format": "int64"}}}}}}',
    "CREATEMARKETINGEVENT": '{"required": ["eventName", "eventOrganizer", "externalAccountId", "externalEventId"], "type": "object", "properties": {"startDateTime": {"type": "string", "description": "The start date and time of the marketing event.", "format": "date-time"}, "customProperties": {"type": "array", "description": "A list of PropertyValues. These can be whatever kind of property names and values you want. However, they must already exist on the HubSpot account\'s definition of the MarketingEvent Object. If they don\'t they will be filtered out and not set.\nIn order to do this you\'ll need to create a new PropertyGroup on the HubSpot account\'s MarketingEvent object for your specific app and create the Custom Property you want to track on that HubSpot account. Do not create any new default properties on the MarketingEvent object as that will apply to all HubSpot accounts.\n", "items": {"required": ["name", "sourceUpstreamDeployable", "value"], "type": "object", "properties": {"sourceId": {"type": "string", "description": "The ID of the property source indicating where it was created.", "example": ""}, "selectedByUser": {"type": "boolean", "description": "Whether the value was selected by a user.", "example": false}, "sourceLabel": {"type": "string", "description": "A human-readable label.", "example": ""}, "sourceUpstreamDeployable": {"type": "string"}, "source": {"type": "string", "description": "The origin of the property value, such as "IMPORT" or "API".", "example": "", "enum": ["UNKNOWN", "IMPORT", "API", "FORM", "ANALYTICS", "MIGRATION", "SALESFORCE", "INTEGRATION", "CONTACTS_WEB", "WAL_INCREMENTAL", "TASK", "EMAIL", "WORKFLOWS", "CALCULATED", "SOCIAL", "BATCH_UPDATE", "SIGNALS", "BIDEN", "DEFAULT", "COMPANIES", "DEALS", "ASSISTS", "PRESENTATIONS", "TALLY", "SIDEKICK", "CRM_UI", "MERGE_CONTACTS", "PORTAL_USER_ASSOCIATOR", "INTEGRATIONS_PLATFORM", "BCC_TO_CRM", "FORWARD_TO_CRM", "ENGAGEMENTS", "SALES", "HEISENBERG", "LEADIN", "GMAIL_INTEGRATION", "ACADEMY", "SALES_MESSAGES", "AVATARS_SERVICE", "MERGE_COMPANIES", "SEQUENCES", "COMPANY_FAMILIES", "MOBILE_IOS", "MOBILE_ANDROID", "CONTACTS", "ASSOCIATIONS", "EXTENSION", "SUCCESS", "BOT", "INTEGRATIONS_SYNC", "AUTOMATION_PLATFORM", "CONVERSATIONS", "EMAIL_INTEGRATION", "CONTENT_MEMBERSHIP", "QUOTES", "BET_ASSIGNMENT", "QUOTAS", "BET_CRM_CONNECTOR", "MEETINGS", "MERGE_OBJECTS", "RECYCLING_BIN", "ADS", "AI_GROUP", "COMMUNICATOR", "SETTINGS", "PROPERTY_SETTINGS", "PIPELINE_SETTINGS", "COMPANY_INSIGHTS", "BEHAVIORAL_EVENTS", "PAYMENTS", "GOALS", "PORTAL_OBJECT_SYNC", "APPROVALS", "FILE_MANAGER", "MARKETPLACE", "INTERNAL_PROCESSING", "FORECASTING", "SLACK_INTEGRATION", "CRM_UI_BULK_ACTION", "WORKFLOW_CONTACT_DELETE_ACTION", "ACCEPTANCE_TEST", "PLAYBOOKS", "CHATSPOT", "FLYWHEEL_PRODUCT_DATA_SYNC", "HELP_DESK", "BILLING", "DATA_ENRICHMENT", "AUTOMATION_JOURNEY", "MICROAPPS", "INTENT", "PROSPECTING_AGENT", "CENTRAL_EXCHANGE_RATES", "HELP_DESK_AI", "CONVERSATIONAL_ENRICHMENT", "CRM_PROCESSES_PLATFORM", "CLONE_OBJECTS", "MARKET_SOURCING", "DATASET", "PROPERTY_RESTORE"]}, "updatedByUserId": {"type": "integer", "description": "The ID of the user who updated the property.", "format": "int32"}, "persistenceTimestamp": {"type": "integer", "format": "int64"}, "sourceMetadata": {"type": "string", "description": "Source metadata encoded as a base64 string. For example: `ZXhhbXBsZSBzdHJpbmc=`", "example": ""}, "dataSensitivity": {"type": "string", "description": "The sensitivity level of the property, such as "non_sensitive", "sensitive", and "highly_sensitive".", "example": "", "enum": ["none", "standard", "high"]}, "sourceVid": {"type": "array", "description": "The unique identifier associated with the source.", "example": "", "items": {"type": "integer", "format": "int64"}}, "unit": {"type": "string", "description": "The unit of measurement or context for the value.", "example": ""}, "requestId": {"type": "string", "description": "A unique ID associated with this request.", "example": ""}, "isEncrypted": {"type": "boolean", "description": "Whether the property value is encrypted.", "example": false}, "name": {"type": "string", "description": "Name of custom property", "example": ""}, "useTimestampAsPersistenceTimestamp": {"type": "boolean"}, "value": {"type": "string", "description": "Custom property value", "example": ""}, "selectedByUserTimestamp": {"type": "integer", "description": "The timestamp when the value was selected by a user, if applicable.", "format": "int64"}, "timestamp": {"type": "integer", "description": "When the value was set, as a 64-bit integer.", "format": "int64"}, "isLargeValue": {"type": "boolean"}}, "description": "Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes."}}, "externalAccountId": {"type": "string", "description": "The accountId that is associated with this marketing event in the external event application."}, "eventCancelled": {"type": "boolean", "description": "Indicates if the marketing event has been cancelled.  Defaults to `false`"}, "eventOrganizer": {"type": "string", "description": "The name of the organizer of the marketing event."}, "eventUrl": {"type": "string", "description": "A URL in the external event application where the marketing event can be managed."}, "externalEventId": {"type": "string", "description": "The id of the marketing event in the external event application."}, "eventDescription": {"type": "string", "description": "The description of the marketing event."}, "eventName": {"type": "string", "description": "The name of the marketing event."}, "eventType": {"type": "string", "description": "Describes what type of event this is.  For example: `WEBINAR`, `CONFERENCE`, `WORKSHOP`"}, "eventCompleted": {"type": "boolean"}, "endDateTime": {"type": "string", "description": "The end date and time of the marketing event.", "format": "date-time"}}}',
    "SENDMARKETINGEMAIL": '{"required": ["emailId", "message"], "type": "object", "properties": {"customProperties": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}, "description": "The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}.\nNote: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property."}, "emailId": {"type": "integer", "description": "The content ID for the email, which can be found in email tool UI.", "format": "int64"}, "message": {"required": ["to"], "type": "object", "properties": {"cc": {"type": "array", "description": "List of email addresses to send as Cc.", "items": {"type": "string"}}, "sendId": {"type": "string", "description": "ID for a particular send. No more than one email will be sent per sendId."}, "bcc": {"type": "array", "description": "List of email addresses to send as Bcc.", "items": {"type": "string"}}, "replyTo": {"type": "array", "description": "List of Reply-To header values for the email.", "items": {"type": "string"}}, "from": {"type": "string", "description": "The From header for the email."}, "to": {"type": "string", "description": "The recipient of the email."}}, "description": "A JSON object containing anything you want to override."}, "contactProperties": {"type": "object", "additionalProperties": {"type": "string"}, "description": "The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you\u2019re sending the email. For example, when sending a receipt you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment."}}, "description": "A request to send a single email asynchronously."}',
    "SENDTRANSACTIONALEMAIL": '{"required": ["emailId", "message"], "type": "object", "properties": {"customProperties": {"type": "object", "additionalProperties": {"type": "object", "properties": {}}, "description": "The customProperties field is a map of property values. Each property value contains a name and value property. Each property will be visible in the template under {{ custom.NAME }}.\nNote: Custom properties do not currently support arrays. To provide a listing in an email, one workaround is to build an HTML list (either with tables or ul) and specify it as a custom property."}, "emailId": {"type": "integer", "description": "The content ID for the transactional email, which can be found in email tool UI.", "format": "int32"}, "message": {"required": ["to"], "type": "object", "properties": {"cc": {"type": "array", "description": "List of email addresses to send as Cc.", "items": {"type": "string"}}, "sendId": {"type": "string", "description": "ID for a particular send. No more than one email will be sent per sendId."}, "bcc": {"type": "array", "description": "List of email addresses to send as Bcc.", "items": {"type": "string"}}, "replyTo": {"type": "array", "description": "List of Reply-To header values for the email.", "items": {"type": "string"}}, "from": {"type": "string", "description": "The From header for the email."}, "to": {"type": "string", "description": "The recipient of the email."}}, "description": "A JSON object containing anything you want to override."}, "contactProperties": {"type": "object", "additionalProperties": {"type": "string"}, "description": "The contactProperties field is a map of contact property values. Each contact property value contains a name and value property. Each property will get set on the contact record and will be visible in the template under {{ contact.NAME }}. Use these properties when you want to set a contact property while you\u2019re sending the email. For example, when sending a reciept you may want to set a last_paid_date property, as the sending of the receipt will have information about the last payment."}}, "description": "A request to send a single transactional email asynchronously."}',
}
