# Create or update template webpage Creates a new or updates an existing template webpage for the specified object. An event is published after the template is changed. Returns an UpdateResponse or CreateResponse with the template webpage details. Endpoint: POST /api/v2/webpages/template/{objectName}/{environment} Version: 1.0 Security: BearerAuthentication ## Path parameters: - `objectName` (string, required) - `environment` (string, required) ## Request fields (application/json): - `uuid` (string, required) Unique identifier for the entity - `name` (string, required) The name of the entity - `label` (string) Display label for the entity, can be different from name - `createdAt` (integer) Unix timestamp when the entity was created - `createdBy` (object) Identifier of the user who created the entity - `createdBy.name` (string, required) - `createdBy.label` (string) - `createdBy.createdAt` (integer) - `createdBy.updatedAt` (integer) - `createdBy.deletedAt` (integer) - `createdBy.createdByUuid` (string) - `createdBy.updatedByUuid` (string) - `createdBy.deletedByUuid` (string) - `createdBy.index` (integer) - `createdBy.complete` (boolean) - `createdBy.deleted` (boolean) - `createdBy.uuid` (string, required) - `createdBy.objects` (object) - `createdBy.properties` (array) - `createdBy.properties.value` (any) - `createdBy.properties.type` (string) - `createdBy.properties.icon` (string) - `createdBy.user` (object) - `createdBy.user.email` (string) - `createdBy.user.firstname` (string) - `createdBy.user.lastname` (string) - `createdBy.user.initials` (string) - `createdBy.user.scopes` (array) - `createdBy.user.filters` (object) - `createdBy.user.role` (string) - `createdBy.user.record` (object) - `updatedAt` (integer) Unix timestamp when the entity was last updated - `updatedBy` (object) Identifier of the user who last updated the entity - `deletedAt` (integer) Unix timestamp when the entity was deleted (null if not deleted) - `deletedBy` (object) Identifier of the user who deleted the entity - `index` (integer) Index number for ordering entities - `environment` (string) The environment of the webpage. - `title` (string) The title of the webpage. Example: "Homepage" - `excerpt` (string) Short summary or excerpt displayed for the webpage. Example: "This is a summary of the webpage." - `slug` (string) URL-friendly identifier for the webpage. Example: "homepage" - `image` (string) URL or identifier of the image associated with the webpage. Example: "https://example.com/image.jpg" - `customCss` (string) Custom CSS for the webpage. - `customJsHead` (string) Custom JS for the webpage. - `customJsBody` (string) Custom JS for the webpage. - `content` (object) Content of the webpage - `content.category` (string) Category of the content - `content.parentUuid` (string) Unique identifier for the parent content - `content.type` (string) Type of the content ('box' or 'component') - `content.display` (string) Display of the content for box ('column', 'row' or 'wrap') and for component () - `content.text` (string) Text content of the content - `content.styling` (object) Styling of the content - `content.styling.all` (object) The style set for all devices - `content.styling.all.hide` (boolean) - `content.styling.all.customID` (string) - `content.styling.all.customClass` (string) - `content.styling.all.customAnchor` (string) - `content.styling.all.spacing` (number) - `content.styling.all.directionLTR` (boolean) - `content.styling.all.alignContent` (string) - `content.styling.all.alignItems` (string) - `content.styling.all.justifyContent` (string) - `content.styling.all.alignSelf` (string) - `content.styling.all.flexWrap` (string) - `content.styling.all.flexDirection` (string) - `content.styling.all.overflow` (string) - `content.styling.all.topMargin` (number) - `content.styling.all.bottomMargin` (number) - `content.styling.all.leftMargin` (number) - `content.styling.all.rightMargin` (number) - `content.styling.all.topPadding` (number) - `content.styling.all.bottomPadding` (number) - `content.styling.all.leftPadding` (number) - `content.styling.all.rightPadding` (number) - `content.styling.all.fullWidthEnabled` (boolean) - `content.styling.all.maxWidth` (number) - `content.styling.all.minWidth` (number) - `content.styling.all.width` (number) - `content.styling.all.flex` (integer) - `content.styling.all.minHeight` (number) - `content.styling.all.maxHeight` (number) - `content.styling.all.height` (number) - `content.styling.all.borderRadiusTopLeft` (number) - `content.styling.all.borderRadiusTopRight` (number) - `content.styling.all.borderRadiusBottomLeft` (number) - `content.styling.all.borderRadiusBottomRight` (number) - `content.styling.all.borderWidthTop` (number) - `content.styling.all.borderWidthBottom` (number) - `content.styling.all.borderWidthLeft` (number) - `content.styling.all.borderWidthRight` (number) - `content.styling.all.borderColorTop` (string) - `content.styling.all.borderColorBottom` (string) - `content.styling.all.borderColorLeft` (string) - `content.styling.all.borderColorRight` (string) - `content.styling.all.borderStyleTop` (string) - `content.styling.all.borderStyleBottom` (string) - `content.styling.all.borderStyleLeft` (string) - `content.styling.all.borderStyleRight` (string) - `content.styling.all.backgroundVideo` (string) - `content.styling.all.backgroundImage` (string) - `content.styling.all.backgroundMediaRepeat` (string) - `content.styling.all.backgroundMediaFit` (string) - `content.styling.all.backgroundMediaSizeWidth` (number) - `content.styling.all.backgroundMediaSizeHeight` (number) - `content.styling.all.backgroundMediaPosition` (string) - `content.styling.all.backgroundMediaScroll` (string) - `content.styling.all.backgroundMediaParallax` (boolean) - `content.styling.all.backgroundMediaAutoPlay` (boolean) - `content.styling.all.backgroundMediaMuted` (boolean) - `content.styling.all.backgroundMediaLoop` (boolean) - `content.styling.all.backgroundColorOverlayColor` (string) - `content.styling.all.backgroundColorOverlayOpacity` (number) - `content.styling.all.backgroundGradientOverlayColors` (array) - `content.styling.all.backgroundGradientOverlayOpacity` (number) - `content.styling.all.backgroundGradientOverlayDirection` (string) - `content.styling.all.backgroundColor` (string) - `content.styling.all.backgroundColorOffsetBottom` (number) - `content.styling.all.backgroundColorOffsetLeft` (number) - `content.styling.all.backgroundColorOffsetRight` (number) - `content.styling.all.backgroundColorOffsetTop` (number) - `content.styling.all.backgroundGradientColors` (array) - `content.styling.all.backgroundGradientOpacity` (number) - `content.styling.all.backgroundGradientDirection` (string) - `content.styling.all.animationDelay` (number) - `content.styling.all.animationDuration` (number) - `content.styling.all.animationIn` (string) - `content.styling.all.animationOut` (string) - `content.styling.all.animationRepeat` (string) - `content.styling.all.animationDirection` (string) - `content.styling.all.animationTimingFunction` (string) - `content.styling.all.animationFillMode` (string) - `content.styling.all.mediaHover` (string) - `content.styling.all.mediaAlignment` (string) - `content.styling.all.mediaFit` (string) - `content.styling.all.mediaPosition` (string) - `content.styling.all.enlargeOnClickBorderRadiusTopLeft` (number) - `content.styling.all.enlargeOnClickBorderRadiusTopRight` (number) - `content.styling.all.enlargeOnClickBorderRadiusBottomLeft` (number) - `content.styling.all.enlargeOnClickBorderRadiusBottomRight` (number) - `content.styling.all.enlargeOnClickBorderWidthTop` (number) - `content.styling.all.enlargeOnClickBorderWidthBottom` (number) - `content.styling.all.enlargeOnClickBorderWidthLeft` (number) - `content.styling.all.enlargeOnClickBorderWidthRight` (number) - `content.styling.all.enlargeOnClickBorderColorTop` (string) - `content.styling.all.enlargeOnClickBorderColorBottom` (string) - `content.styling.all.enlargeOnClickBorderColorLeft` (string) - `content.styling.all.enlargeOnClickBorderColorRight` (string) - `content.styling.all.enlargeOnClickBorderStyleTop` (string) - `content.styling.all.enlargeOnClickBorderStyleBottom` (string) - `content.styling.all.enlargeOnClickBorderStyleLeft` (string) - `content.styling.all.enlargeOnClickBorderStyleRight` (string) - `content.styling.all.enlargeOnClickShadowOffsetX` (number) - `content.styling.all.enlargeOnClickShadowOffsetY` (number) - `content.styling.all.enlargeOnClickShadowBlur` (number) - `content.styling.all.enlargeOnClickShadowColor` (string) - `content.styling.all.enlargeOnClickShadowSpread` (number) - `content.styling.all.enlargeOnClickShadowInset` (boolean) - `content.styling.all.enlargeOnClickShadowOpacity` (number) - `content.styling.all.enlargeOnClickScale` (number) - `content.styling.all.shadowOffsetX` (number) - `content.styling.all.shadowOffsetY` (number) - `content.styling.all.shadowBlur` (number) - `content.styling.all.shadowBorderRadiusTopLeft` (number) - `content.styling.all.shadowBorderRadiusTopRight` (number) - `content.styling.all.shadowBorderRadiusBottomLeft` (number) - `content.styling.all.shadowBorderRadiusBottomRight` (number) - `content.styling.all.shadowColor` (string) - `content.styling.all.shadowSpread` (number) - `content.styling.all.shadowInset` (boolean) - `content.styling.all.shadowOpacity` (number) - `content.styling.all.textGradientOverlayColors` (array) - `content.styling.all.textGradientOverlayOpacity` (number) - `content.styling.all.textGradientOverlayDirection` (string) - `content.styling.all.darkTextEnabled` (boolean) - `content.styling.all.textAlign` (string) - `content.styling.all.transitionScrollSpeed` (number) - `content.styling.all.autoRotate` (boolean) - `content.styling.all.autoRotateInterval` (number) - `content.styling.all.buttonIcon` (string) - `content.styling.all.buttonIconPosition` (string) - `content.styling.all.buttonIconColor` (string) - `content.styling.all.openInNewWindow` (boolean) - `content.styling.all.sidebar` (boolean) - `content.styling.all.sidebarPosition` (string) - `content.styling.all.sidebarAnimation` (string) - `content.styling.all.sidebarAnimationDuration` (number) - `content.styling.all.sidebarAnimationTimingFunction` (string) - `content.styling.all.fontFamily` (string) - `content.styling.all.fontSize` (number) - `content.styling.all.fontWeight` (string) - `content.styling.all.fontDecoration` (string) - `content.styling.all.fontTextTransform` (string) - `content.styling.all.fontLineHeight` (number) - `content.styling.all.fontLetterSpacing` (number) - `content.styling.all.fontColorLight` (string) - `content.styling.all.fontColorDark` (string) - `content.styling.all.h1FontFamily` (string) - `content.styling.all.h1FontSize` (number) - `content.styling.all.h1FontWeight` (string) - `content.styling.all.h1FontDecoration` (string) - `content.styling.all.h1TextTransform` (string) - `content.styling.all.h1LineHeight` (number) - `content.styling.all.h1LetterSpacing` (number) - `content.styling.all.h1ColorLight` (string) - `content.styling.all.h1ColorDark` (string) - `content.styling.all.h2FontFamily` (string) - `content.styling.all.h2FontSize` (number) - `content.styling.all.h2FontWeight` (string) - `content.styling.all.h2FontDecoration` (string) - `content.styling.all.h2TextTransform` (string) - `content.styling.all.h2LineHeight` (number) - `content.styling.all.h2LetterSpacing` (number) - `content.styling.all.h2ColorLight` (string) - `content.styling.all.h2ColorDark` (string) - `content.styling.all.h3FontFamily` (string) - `content.styling.all.h3FontSize` (number) - `content.styling.all.h3FontWeight` (string) - `content.styling.all.h3FontDecoration` (string) - `content.styling.all.h3TextTransform` (string) - `content.styling.all.h3LineHeight` (number) - `content.styling.all.h3LetterSpacing` (number) - `content.styling.all.h3ColorLight` (string) - `content.styling.all.h3ColorDark` (string) - `content.styling.all.h4FontFamily` (string) - `content.styling.all.h4FontSize` (number) - `content.styling.all.h4FontWeight` (string) - `content.styling.all.h4FontDecoration` (string) - `content.styling.all.h4TextTransform` (string) - `content.styling.all.h4LineHeight` (number) - `content.styling.all.h4LetterSpacing` (number) - `content.styling.all.h4ColorLight` (string) - `content.styling.all.h4ColorDark` (string) - `content.styling.all.h5FontFamily` (string) - `content.styling.all.h5FontSize` (number) - `content.styling.all.h5FontWeight` (string) - `content.styling.all.h5FontDecoration` (string) - `content.styling.all.h5TextTransform` (string) - `content.styling.all.h5LineHeight` (number) - `content.styling.all.h5LetterSpacing` (number) - `content.styling.all.h5ColorLight` (string) - `content.styling.all.h5ColorDark` (string) - `content.styling.all.h6FontFamily` (string) - `content.styling.all.h6FontSize` (number) - `content.styling.all.h6FontWeight` (string) - `content.styling.all.h6FontDecoration` (string) - `content.styling.all.h6TextTransform` (string) - `content.styling.all.h6LineHeight` (number) - `content.styling.all.h6LetterSpacing` (number) - `content.styling.all.h6ColorLight` (string) - `content.styling.all.h6ColorDark` (string) - `content.styling.all.navigationFontFamily` (string) - `content.styling.all.navigationFontSize` (number) - `content.styling.all.navigationFontWeight` (string) - `content.styling.all.navigationFontDecoration` (string) - `content.styling.all.navigationTextTransform` (string) - `content.styling.all.navigationLineHeight` (number) - `content.styling.all.navigationLetterSpacing` (number) - `content.styling.all.navigationColorLight` (string) - `content.styling.all.navigationColorDark` (string) - `content.styling.all.subNavigationFontFamily` (string) - `content.styling.all.subNavigationFontSize` (number) - `content.styling.all.subNavigationFontWeight` (string) - `content.styling.all.subNavigationFontDecoration` (string) - `content.styling.all.subNavigationTextTransform` (string) - `content.styling.all.subNavigationLineHeight` (number) - `content.styling.all.subNavigationLetterSpacing` (number) - `content.styling.all.subNavigationColorLight` (string) - `content.styling.all.subNavigationColorDark` (string) - `content.styling.all.bodyFontFamily` (string) - `content.styling.all.bodyFontSize` (number) - `content.styling.all.bodyFontWeight` (string) - `content.styling.all.bodyFontDecoration` (string) - `content.styling.all.bodyTextTransform` (string) - `content.styling.all.bodyLineHeight` (number) - `content.styling.all.bodyLetterSpacing` (number) - `content.styling.all.bodyColorLight` (string) - `content.styling.all.bodyColorDark` (string) - `content.styling.all.hyperlinkFontFamily` (string) - `content.styling.all.hyperlinkFontSize` (number) - `content.styling.all.hyperlinkFontWeight` (string) - `content.styling.all.hyperlinkFontDecoration` (string) - `content.styling.all.hyperlinkTextTransform` (string) - `content.styling.all.hyperlinkLineHeight` (number) - `content.styling.all.hyperlinkLetterSpacing` (number) - `content.styling.all.hyperlinkColorLight` (string) - `content.styling.all.hyperlinkColorDark` (string) - `content.styling.mobile` (object) The style set for the mobile device - `content.styling.tablet` (object) The style set for the tablet device - `content.styling.desktop` (object) The style set for the desktop device - `content.settings` (object) Settings for the content - `content.settings.form` (object) The form associated with the content - `content.settings.form.object` (object) The associated Caraer object that this form belongs to - `content.settings.form.object.name` (string) Unique identifier name for the object - `content.settings.form.object.label` (string) Display label for the object - `content.settings.form.object.index` (integer) Index number for ordering objects - `content.settings.form.object.plural` (string) Plural form of the object's name, used for display purposes - `content.settings.form.object.description` (string) Detailed description of the object's purpose and usage - `content.settings.form.object.groups` (array) Collection of group names this object belongs to - `content.settings.form.object.icon` (string) Icon identifier for visual representation of the object - `content.settings.form.object.showInMenu` (boolean) Indicates if this object should be displayed in navigation menus - `content.settings.form.object.defaultTrait` (string) Name of the default trait applied to this object - `content.settings.form.object.traits` (array) List of trait names associated with this object - `content.settings.form.object.views` (array) List of view configurations for displaying this object - `content.settings.form.object.views.favorite` (boolean) - `content.settings.form.object.views.team` (boolean) - `content.settings.form.object.views.shared` (boolean) - `content.settings.form.object.views.personal` (boolean) - `content.settings.form.object.views.trait` (string) - `content.settings.form.object.views.filters` (object) DTO representing a filter composed of filter groups for querying records. The filter groups are combined using a logical OR operation. The filter items within each group are combined using a logical AND operation. - `content.settings.form.object.views.filters.groups` (array) A collection of filter groups. - `content.settings.form.object.views.filters.groups.items` (object) A set of filter items included in the group. - `content.settings.form.object.views.filters.groups.items.object` (string) The name of the object to which this pagination item belongs. Example: "User" - `content.settings.form.object.views.filters.groups.items.relation` (string) The relationship between objects. Example: "hasProperty" - `content.settings.form.object.views.filters.groups.items.property` (string) The name of the property within the object. Example: "email" - `content.settings.form.object.views.filters.groups.items.relationIncluded` (boolean) Specifies whether the relation is included. Example: true - `content.settings.form.object.views.filters.groups.items.operator` (string) Defines the operator used in the filter. Available operators are defined in the API documentation. Example: "EQUALS" - `content.settings.form.object.views.filters.groups.items.value` (any) Represents the value to filter against. Example: 12345 - `content.settings.form.object.views.shows` (array) - `content.settings.form.object.views.shows.separator` (string) Separator string used to visually separate this item. Example: "|" - `content.settings.form.object.views.shows.sticky` (boolean) Flag indicating whether this item is sticky and will stay fixed in the list. - `content.settings.form.object.views.sorts` (array) - `content.settings.form.object.views.sorts.direction` (string) The direction for sorting. Can be ASC (ascending) or DESC (descending). Enum: "ASC", "DESC" - `content.settings.form.object.views.limit` (integer) - `content.settings.form.object.views.showIcons` (boolean) - `content.settings.form.object.views.groupProperty` (object) Represents a sortable item, including object, relation, property, and sort direction. - `content.settings.form.object.views.rowHeight` (string) - `content.settings.form.object.views.calculations` (array) - `content.settings.form.object.views.calculations.property` (object) DTO representing an item with properties defined for displaying and handling in UI related operations. - `content.settings.form.object.views.calculations.calculation` (string) - `content.settings.form.object.views.query` (string) - `content.settings.form.object.views.flowProperty` (string) - `content.settings.form.object.views.defaultView` (boolean) - `content.settings.form.object.views.isInternallyPublic` (boolean) - `content.settings.form.object.properties` (array) List of properties defined for this object - `content.settings.form.object.properties.name` (string) The name identifier of the property - `content.settings.form.object.properties.label` (string) Display label for the property - `content.settings.form.object.properties.description` (string) Detailed description of the property's purpose and usage - `content.settings.form.object.properties.type` (string) The data type of the property (e.g., 'string', 'number', 'date', etc.) - `content.settings.form.object.properties.options` (array) List of predefined options for properties that support selection - `content.settings.form.object.properties.options.color` (string) - `content.settings.form.object.properties.options.disabled` (boolean) - `content.settings.form.object.properties.options.usedIn` (object) - `content.settings.form.object.properties.options.usedIn.recordUuids` (array) - `content.settings.form.object.properties.options.usedIn.count` (integer) - `content.settings.form.object.properties.group` (string) Group name for organizing related properties - `content.settings.form.object.properties.format` (any) Format configuration for the property's display and validation - `content.settings.form.object.properties.rules` (array) Collection of validation rules applied to the property - `content.settings.form.object.properties.immutable` (boolean) Indicates if the property value cannot be modified after initial creation - `content.settings.form.object.properties.hidden` (boolean) Indicates if the property should be hidden from view - `content.settings.form.object.properties.nonPublic` (boolean) Indicates if the property should be excluded from public APIs - `content.settings.form.object.properties.indexed` (boolean) Indicates if the property should be indexed for searching - `content.settings.form.object.properties.editable` (boolean) Indicates if the property value can be modified - `content.settings.form.object.properties.formatSettings` (object) Additional format-specific settings for the property - `content.settings.form.object.properties.usedIn` (object) Information about where this property is used in the system - `content.settings.form.object.properties.icon` (string) Icon identifier for visual representation of the property - `content.settings.form.object.properties.webpagePublic` (boolean) Indicates if the property can be used in webpages - `content.settings.form.object.properties.embeddable` (boolean) Indicates if the property can be embedded in other properties - `content.settings.form.object.properties.minAndMaxValue` (object) The minimum and maximum value of the property - `content.settings.form.object.properties.minAndMaxValue.t1` (integer) - `content.settings.form.object.properties.minAndMaxValue.t2` (integer) - `content.settings.form.object.relations` (array) List of relations this object has with other objects - `content.settings.form.object.relations.name` (string) Unique identifier name for the relation - `content.settings.form.object.relations.label` (string) Display label for the relation - `content.settings.form.object.relations.description` (string) Detailed description of the relation's purpose and usage - `content.settings.form.object.relations.objects` (array) Set of Caraer objects that are part of this relation - `content.settings.form.object.suites` (array) List of suite names this object belongs to - `content.settings.form.grids` (array) List of form items that make up the form's structure. Each grid represents a section or group of form elements - `content.settings.form.grids.aiprompt` (string) - `content.settings.form.grids.title` (string) The title or heading of this form section - `content.settings.form.grids.description` (string) Additional descriptive text explaining the purpose or instructions for this section - `content.settings.form.grids.type` (string) The type of form section (e.g., 'grid', 'section', etc.) - `content.settings.form.grids.AIPrompt` (string) The AI prompt for the form section. Only applicable to steps. - `content.settings.form.grids.grid` (array) A two-dimensional array representing the layout of form elements. Each inner list represents a row of elements - `content.settings.form.grids.grid.property` (object) The property associated with this grid item, typically representing a form field or input - `content.settings.form.grids.grid.text` (string) Static text content to be displayed in this grid cell - `content.settings.form.grids.grid.form` (object) A nested form that can be embedded within this grid cell - `content.settings.form.grids.grid.submitButton` (string) The text of the submit button for this grid item - `content.settings.form.grids.grid.settings` (object) Configuration settings for this grid item, including display and validation rules - `content.settings.form.grids.grid.settings.relation` (object) Defines the relationship between this form field and other entities or forms - `content.settings.form.grids.grid.settings.record` (object) UUID of a record to be pre-filled in this form field - `content.settings.form.grids.grid.settings.label` (string) The display label for the form field - `content.settings.form.grids.grid.settings.defaultValue` (string) The default value to be pre-filled in the form field - `content.settings.form.grids.grid.settings.isRequired` (boolean) Indicates whether this field must be filled out before form submission - `content.settings.form.grids.grid.settings.hidden` (boolean) Indicates whether this field should be hidden from view - `content.settings.form.grids.grid.settings.placeholder` (string) The placeholder text for the form field - `content.settings.form.grids.grid.settings.helpText` (string) The help text for the form field - `content.settings.form.grids.grid.settings.AIPrompt` (string) The AI prompt for the form field. Only applicable to text fields. - `content.settings.form.grids.grid.settings.styling` (string) The styling for the form field. Can be 'dropdown', 'grid' or 'boxes' - `content.settings.form.grids.grid.settings.stretch` (boolean) Whether the form field should be stretched to the full width of the form - `content.settings.form.grids.grid.settings.align` (string) The alignment of the form field. Can be 'left', 'center' or 'right' - `content.settings.form.grids.grid.settings.rangeMin` (integer) The minimum value for the slider field - `content.settings.form.grids.grid.settings.rangeMax` (integer) The maximum value for the slider field - `content.settings.form.grids.grid.value` (string) The value of this grid item, used for form submissions - `content.settings.form.description` (string) Descriptive text providing additional information about the form - `content.settings.form.styling` (string) The styling of the form. Can be 'standard', 'underline' or 'plain' - `content.settings.form.leadscores` (array) List of lead scoring rules associated with this form. Used to evaluate and score form submissions - `content.settings.form.leadscores.smart_value` (boolean) Whether the value is a smart value Example: true - `content.settings.form.leadscores.score` (integer) The score to assign if the rule is met Example: 10 - `content.settings.form.relations` (array) List of form relations that define the relationships between this form conversion record and other records in the system - `content.settings.form.relations.type` (string) The type of the form relation. The options are: CONVERSION_PAGE_RECORD, RELATED_RECORD_TO_CONVERSION_PAGE_RECORD, STATIC Example: "CONVERSION_PAGE_RECORD" - `content.settings.form.relations.relation` (object) The relation to be created. - `content.settings.form.relations.relatedRelation` (object) The related relation associated with conversion page record - `content.settings.form.relations.relatedObject` (object) The related object associated with conversion page record or for static - `content.settings.form.relations.recordUuid` (string) UUID of the record for the static connection. Example: "fc453abc-123e-4567-890a-6789abcd1234" - `content.settings.form.relations.relatedObjectConnection` (string) The connection type for the related object. The options are: PRIMARY, ALL Example: "PRIMARY" - `content.settings.form.wizard` (boolean) Indicates if the form should be displayed as a step-by-step wizard interface - `content.settings.form.metadata` (object) Metadata associated with the form - `content.settings.form.thankYouMessage` (string) Thank you message to be displayed after the form is submitted - `content.settings.form.redirectUrl` (string) Redirect URL to be displayed after the form is submitted - `content.settings.openIcon` (string) The icon to display when the accordion is open - `content.settings.closeIcon` (string) The icon to display when the accordion is closed - `content.settings.alt` (string) The alt text of the image - `content.settings.key` (string) The key of the image - `content.settings.playVideo` (boolean) Whether the video should play automatically - `content.settings.startMuted` (boolean) Whether the image should start muted - `content.settings.loopVideo` (boolean) Whether the video should loop - `content.settings.startOffset` (integer) The start offset of the video - `content.settings.link` (string) The link of the button - `content.settings.style` (string) The style of the button. Primary, secondary, tertiary or custom - `content.settings.openInNewWindow` (boolean) Whether the link should open in a new window - `content.settings.sliderType` (string) The slider type. Dots, arrows and swipe - `content.settings.carouselSpeed` (number) The carousel speed. - `content.settings.previewObject` (object) The object of the previews - `content.settings.previews` (object) The previews associated with the layouts - `content.settings.previewLayoutOrder` (array) The order of preview layouts - `content.settings.filter` (object) The filter associated with the settings - `content.settings.orderBy` (object) The order by property associated with the settings - `content.settings.orderByDirection` (string) The order by direction associated with the settings. ASC or DESC, default is ASC - `content.settings.asWebpages` (boolean) Whether the previews should be shown as webpages - `content.settings.loop` (boolean) Whether the previews should loop - `content.settings.limit` (integer) The limit associated with the settings - `content.settings.groupBy` (object) The group by property associated with the settings - `content.settings.filterType` (string) The type of the filter block. left_bar or top_search - `content.settings.searchResultSingleString` (string) The single result string of the filter block - `content.settings.searchResultPluralString` (string) The Plural result string of the filter block - `content.settings.noResultsString` (string) The no results string of the filter block - `content.settings.searchFieldEnabled` (boolean) Whether the search field should be enabled - `content.settings.searchFieldPlaceholder` (string) The placeholder of the search field - `content.settings.filterBlockEnabled` (boolean) Whether the filter block should be enabled - `content.settings.filterTitle` (string) The title of the filter block - `content.settings.filterSubtitle` (string) The subtitle of the filter block - `content.settings.filterProperties` (array) The properties of the filter block - `content.settings.enableFilterTiles` (boolean) Whether the filter tiles should be enabled - `content.settings.enableFilterQuery` (boolean) Whether the filter query should be enabled - `content.settings.enableRemoveAllFiltersButton` (boolean) Whether the remove all filters button should be enabled - `content.settings.ctaEnabled` (boolean) Whether the CTA should be enabled - `content.settings.ctaTitle` (string) The title of the CTA - `content.settings.ctaText` (string) The text of the CTA - `content.settings.ctaButtonText` (string) The button text of the CTA - `content.settings.ctaButtonLink` (string) The button link of the CTA - `content.settings.platforms` (array) The platforms shown in the share component - `content.children` (array) Children of the content - `sidebar` (object) Preview of the sidebar - `sidebar.description` (string) Description of the preview Example: "Preview description example" - `sidebar.object` (object) The Caraer object associated with this preview - `sidebar.recordUuid` (string) UUID of the associated record Example: "abcdef12-3456-7890-abcd-ef1234567890" - `sidebar.primary` (boolean) Indicates whether this preview is the primary one Example: true - `sidebar.previewType` (string) Type of preview (detail, flow, pill, custom) Example: "detail" - `sidebar.grid` (array) Rows of the preview grid - `sidebar.grid.property` (object) The property details associated with the preview item. - `sidebar.grid.text` (string) The text content associated with the preview item. Example: "Sample text" - `sidebar.grid.value` (any) The value associated with the preview item. This can hold custom data. - `sidebar.grid.relatedObject` (object) The related object information for the preview item. - `sidebar.grid.relatedObject.object` (object) The related object data. - `sidebar.grid.relatedObject.relation` (object) The type of relation between objects. - `sidebar.grid.relatedObjectValue` (any) The related object value associated with this preview item. - `sidebar.grid.divider` (string) Whether the preview item is a divider. (solid, dashed, dotted) Example: "solid" - `sidebar.grid.buttonText` (string) The button text associated with the preview item. Example: "Sample text" - `sidebar.grid.buttonUrl` (string) The button url associated with the preview item. Example: "https://www.google.com" - `sidebar.grid.buttonTextValue` (any) The button text value associated with the preview item. - `sidebar.grid.buttonUrlValue` (any) The button value associated with the preview item. - `sidebar.grid.settings` (object) The settings associated with the preview item. - `sidebar.grid.settings.showIcon` (boolean) Whether the preview item should show the icon. - `sidebar.grid.settings.iconPadding` (number) The padding of the icon. - `sidebar.grid.settings.iconColor` (string) The color of the icon. - `sidebar.grid.settings.iconSize` (number) The size of the icon. - `sidebar.grid.settings.defaultValue` (string) The default value of the preview item. - `sidebar.grid.settings.helpText` (string) The help text of the preview item. - `sidebar.grid.settings.paragraph` (string) The paragraph of the preview item p, h1, h2, h3, h4, h5, h6. - `sidebar.grid.settings.showColor` (boolean) Whether the preview item should show the color of the select option. - `sidebar.grid.settings.showBorder` (boolean) Whether the preview item should show the border around the select option. - `sidebar.grid.settings.buttonType` (string) What type the button should be (primary, secondary or tertiary) - `sidebar.grid.styling` (object) The styling associated with the preview item. - `sidebar.profileImage` (object) Profile image property - `sidebar.profileImagePosition` (string) Profile image position (top, left, right, bottom, background) Example: "top" - `sidebar.profileImageStyling` (object) Style set for the profile image - `sidebar.firstInitialProperty` (object) First initial property - `sidebar.secondInitialProperty` (object) Second initial property - `sidebar.whatsAppProperty` (object) WhatsApp property - `sidebar.phoneProperty` (object) Phone property - `sidebar.emailProperty` (object) Email property - `sidebar.profileImageValue` (string) Value of the profile image - `sidebar.firstInitialPropertyValue` (string) Value of the first initial property - `sidebar.secondInitialPropertyValue` (string) Value of the second initial property - `sidebar.whatsAppPropertyValue` (string) Value of the whatsApp property - `sidebar.phonePropertyValue` (string) Value of the phone property - `sidebar.emailPropertyValue` (string) Value of the email property - `sidebar.customCss` (string) Custom CSS styles for the preview - `sidebar.url` (string) URL of the preview - `sidebar.styling` (object) The styling of the preview - `sidebarRelation` (object) Relation of the sidebar - `sidebarObject` (object) Object of the sidebar - `options` (object) Custom options and configurations specific to the webpage. - `options.relatedToTemplate` (boolean, required) Indicates if the webpage is related to a template. Example: true - `metaData` (object) Map of additional metadata and attributes for the webpage. Example: {"author":"John Doe","category":"blog"} - `object` (object) Represents the associated Caraer object ## Response 200 fields (application/json): - `message` (string) A message detailing the result of the operation. Example: "Success" - `data` (any) The data payload of the response, if any. ## Response 201 fields (application/json): - `message` (string) A message detailing the result of the operation. Example: "Success" - `data` (any) The data payload of the response, if any. ## Response 404 fields (application/json): - `cause` (object) - `cause.stackTrace` (array) - `cause.stackTrace.classLoaderName` (string) - `cause.stackTrace.moduleName` (string) - `cause.stackTrace.moduleVersion` (string) - `cause.stackTrace.methodName` (string) - `cause.stackTrace.fileName` (string) - `cause.stackTrace.lineNumber` (integer) - `cause.stackTrace.nativeMethod` (boolean) - `cause.stackTrace.className` (string) - `cause.message` (string) - `cause.localizedMessage` (string) - `errors` (array) The error message providing details about the failure. Example: "Resource not found." - `errors.correctionSuggestion` (string, required) A suggestion on how to correct the error. Example: "Try uploading a different file type." - `errors.message` (string, required) The error message providing details about the failure. Example: "Invalid file type." - `errors.type` (string, required) The type of error. Enum: "VALIDATION", "NOT_FOUND", "TEST", "RELATION_NOT_ALLOWED", "INVALID_VALUE", "GENERAL", "INVALID_FILE_TYPE", "INTERNAL_SERVER_ERROR", "CARAER_ERROR", "INVALID_EMAIL", "INVALID_DATE" - `code` (integer) The HTTP status code associated with the error. Example: 404 - `suppressed` (array) - `uuid` (string) ## Response 500 fields (application/json): - `cause` (object) - `cause.stackTrace` (array) - `cause.stackTrace.classLoaderName` (string) - `cause.stackTrace.moduleName` (string) - `cause.stackTrace.moduleVersion` (string) - `cause.stackTrace.methodName` (string) - `cause.stackTrace.fileName` (string) - `cause.stackTrace.lineNumber` (integer) - `cause.stackTrace.nativeMethod` (boolean) - `cause.stackTrace.className` (string) - `cause.message` (string) - `cause.localizedMessage` (string) - `errors` (array) The error message providing details about the failure. Example: "Resource not found." - `errors.correctionSuggestion` (string, required) A suggestion on how to correct the error. Example: "Try uploading a different file type." - `errors.message` (string, required) The error message providing details about the failure. Example: "Invalid file type." - `errors.type` (string, required) The type of error. Enum: "VALIDATION", "NOT_FOUND", "TEST", "RELATION_NOT_ALLOWED", "INVALID_VALUE", "GENERAL", "INVALID_FILE_TYPE", "INTERNAL_SERVER_ERROR", "CARAER_ERROR", "INVALID_EMAIL", "INVALID_DATE" - `code` (integer) The HTTP status code associated with the error. Example: 404 - `suppressed` (array) - `uuid` (string)