# Save object preview Creates or updates a preview for a specific object. The preview type is determined by the 'name' path variable. Depending on the preview type (e.g., 'detail', 'flow', 'pill', or 'page'), the request body will be mapped to the corresponding PreviewDTO and converted to the appropriate Preview model. Endpoint: POST /api/v2/objects/{uuid}/previews/{name} Version: 1.0 Security: BearerAuthentication ## Path parameters: - `uuid` (string, required) - `name` (string, required) ## Request fields (application/json): - `description` (string) Description of the preview Example: "Preview description example" - `object` (object) The Caraer object associated with this preview - `object.uuid` (string, required) Unique identifier for the entity - `object.name` (string) Unique identifier name for the object - `object.label` (string) Display label for the object - `object.createdAt` (integer) Unix timestamp when the entity was created - `object.createdBy` (object) Identifier of the user who created the entity - `object.createdBy.name` (string, required) - `object.createdBy.label` (string) - `object.createdBy.createdAt` (integer) - `object.createdBy.updatedAt` (integer) - `object.createdBy.deletedAt` (integer) - `object.createdBy.createdByUuid` (string) - `object.createdBy.updatedByUuid` (string) - `object.createdBy.deletedByUuid` (string) - `object.createdBy.index` (integer) - `object.createdBy.complete` (boolean) - `object.createdBy.deleted` (boolean) - `object.createdBy.uuid` (string, required) - `object.createdBy.objects` (object) - `object.createdBy.properties` (array) - `object.createdBy.properties.value` (any) - `object.createdBy.properties.type` (string) - `object.createdBy.properties.icon` (string) - `object.createdBy.user` (object) - `object.createdBy.user.email` (string) - `object.createdBy.user.firstname` (string) - `object.createdBy.user.lastname` (string) - `object.createdBy.user.initials` (string) - `object.createdBy.user.scopes` (array) - `object.createdBy.user.filters` (object) - `object.createdBy.user.role` (string) - `object.createdBy.user.record` (object) - `object.updatedAt` (integer) Unix timestamp when the entity was last updated - `object.updatedBy` (object) Identifier of the user who last updated the entity - `object.deletedAt` (integer) Unix timestamp when the entity was deleted (null if not deleted) - `object.deletedBy` (object) Identifier of the user who deleted the entity - `object.index` (integer) Index number for ordering objects - `object.plural` (string) Plural form of the object's name, used for display purposes - `object.description` (string) Detailed description of the object's purpose and usage - `object.groups` (array) Collection of group names this object belongs to - `object.icon` (string) Icon identifier for visual representation of the object - `object.showInMenu` (boolean) Indicates if this object should be displayed in navigation menus - `object.defaultTrait` (string) Name of the default trait applied to this object - `object.traits` (array) List of trait names associated with this object - `object.views` (array) List of view configurations for displaying this object - `object.views.label` (string) Display label for the entity, can be different from name - `object.views.index` (integer) Index number for ordering entities - `object.views.favorite` (boolean) - `object.views.team` (boolean) - `object.views.shared` (boolean) - `object.views.personal` (boolean) - `object.views.trait` (string) - `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. - `object.views.filters.groups` (array) A collection of filter groups. - `object.views.filters.groups.items` (object) A set of filter items included in the group. - `object.views.filters.groups.items.object` (string) The name of the object to which this pagination item belongs. Example: "User" - `object.views.filters.groups.items.relation` (string) The relationship between objects. Example: "hasProperty" - `object.views.filters.groups.items.property` (string) The name of the property within the object. Example: "email" - `object.views.filters.groups.items.relationIncluded` (boolean) Specifies whether the relation is included. Example: true - `object.views.filters.groups.items.operator` (string) Defines the operator used in the filter. Available operators are defined in the API documentation. Example: "EQUALS" - `object.views.filters.groups.items.value` (any) Represents the value to filter against. Example: 12345 - `object.views.shows` (array) - `object.views.shows.separator` (string) Separator string used to visually separate this item. Example: "|" - `object.views.shows.sticky` (boolean) Flag indicating whether this item is sticky and will stay fixed in the list. - `object.views.sorts` (array) - `object.views.sorts.direction` (string) The direction for sorting. Can be ASC (ascending) or DESC (descending). Enum: "ASC", "DESC" - `object.views.limit` (integer) - `object.views.showIcons` (boolean) - `object.views.groupProperty` (object) Represents a sortable item, including object, relation, property, and sort direction. - `object.views.rowHeight` (string) - `object.views.calculations` (array) - `object.views.calculations.property` (object) DTO representing an item with properties defined for displaying and handling in UI related operations. - `object.views.calculations.calculation` (string) - `object.views.query` (string) - `object.views.flowProperty` (string) - `object.views.defaultView` (boolean) - `object.views.isInternallyPublic` (boolean) - `object.properties` (array) List of properties defined for this object - `object.properties.name` (string) The name identifier of the property - `object.properties.label` (string) Display label for the property - `object.properties.description` (string) Detailed description of the property's purpose and usage - `object.properties.type` (string) The data type of the property (e.g., 'string', 'number', 'date', etc.) - `object.properties.options` (array) List of predefined options for properties that support selection - `object.properties.options.color` (string) - `object.properties.options.disabled` (boolean) - `object.properties.options.usedIn` (object) - `object.properties.options.usedIn.recordUuids` (array) - `object.properties.options.usedIn.count` (integer) - `object.properties.group` (string) Group name for organizing related properties - `object.properties.format` (any) Format configuration for the property's display and validation - `object.properties.rules` (array) Collection of validation rules applied to the property - `object.properties.immutable` (boolean) Indicates if the property value cannot be modified after initial creation - `object.properties.hidden` (boolean) Indicates if the property should be hidden from view - `object.properties.nonPublic` (boolean) Indicates if the property should be excluded from public APIs - `object.properties.indexed` (boolean) Indicates if the property should be indexed for searching - `object.properties.editable` (boolean) Indicates if the property value can be modified - `object.properties.formatSettings` (object) Additional format-specific settings for the property - `object.properties.usedIn` (object) Information about where this property is used in the system - `object.properties.icon` (string) Icon identifier for visual representation of the property - `object.properties.webpagePublic` (boolean) Indicates if the property can be used in webpages - `object.properties.embeddable` (boolean) Indicates if the property can be embedded in other properties - `object.properties.minAndMaxValue` (object) The minimum and maximum value of the property - `object.properties.minAndMaxValue.t1` (integer) - `object.properties.minAndMaxValue.t2` (integer) - `object.relations` (array) List of relations this object has with other objects - `object.relations.name` (string) Unique identifier name for the relation - `object.relations.label` (string) Display label for the relation - `object.relations.description` (string) Detailed description of the relation's purpose and usage - `object.relations.objects` (array) Set of Caraer objects that are part of this relation - `object.suites` (array) List of suite names this object belongs to - `recordUuid` (string) UUID of the associated record Example: "abcdef12-3456-7890-abcd-ef1234567890" - `primary` (boolean) Indicates whether this preview is the primary one Example: true - `previewType` (string) Type of preview (detail, flow, pill, custom) Example: "detail" - `grid` (array) Rows of the preview grid - `grid.property` (object) The property details associated with the preview item. - `grid.text` (string) The text content associated with the preview item. Example: "Sample text" - `grid.value` (any) The value associated with the preview item. This can hold custom data. - `grid.relatedObject` (object) The related object information for the preview item. - `grid.relatedObject.object` (object) The related object data. - `grid.relatedObject.relation` (object) The type of relation between objects. - `grid.relatedObjectValue` (any) The related object value associated with this preview item. - `grid.divider` (string) Whether the preview item is a divider. (solid, dashed, dotted) Example: "solid" - `grid.buttonText` (string) The button text associated with the preview item. Example: "Sample text" - `grid.buttonUrl` (string) The button url associated with the preview item. Example: "https://www.google.com" - `grid.buttonTextValue` (any) The button text value associated with the preview item. - `grid.buttonUrlValue` (any) The button value associated with the preview item. - `grid.settings` (object) The settings associated with the preview item. - `grid.settings.showIcon` (boolean) Whether the preview item should show the icon. - `grid.settings.iconPadding` (number) The padding of the icon. - `grid.settings.iconColor` (string) The color of the icon. - `grid.settings.iconSize` (number) The size of the icon. - `grid.settings.defaultValue` (string) The default value of the preview item. - `grid.settings.helpText` (string) The help text of the preview item. - `grid.settings.paragraph` (string) The paragraph of the preview item p, h1, h2, h3, h4, h5, h6. - `grid.settings.showColor` (boolean) Whether the preview item should show the color of the select option. - `grid.settings.showBorder` (boolean) Whether the preview item should show the border around the select option. - `grid.settings.buttonType` (string) What type the button should be (primary, secondary or tertiary) - `grid.styling` (object) The styling associated with the preview item. - `grid.styling.all` (object) The style set for all devices - `grid.styling.all.hide` (boolean) - `grid.styling.all.customID` (string) - `grid.styling.all.customClass` (string) - `grid.styling.all.customAnchor` (string) - `grid.styling.all.spacing` (number) - `grid.styling.all.directionLTR` (boolean) - `grid.styling.all.alignContent` (string) - `grid.styling.all.alignItems` (string) - `grid.styling.all.justifyContent` (string) - `grid.styling.all.alignSelf` (string) - `grid.styling.all.flexWrap` (string) - `grid.styling.all.flexDirection` (string) - `grid.styling.all.overflow` (string) - `grid.styling.all.topMargin` (number) - `grid.styling.all.bottomMargin` (number) - `grid.styling.all.leftMargin` (number) - `grid.styling.all.rightMargin` (number) - `grid.styling.all.topPadding` (number) - `grid.styling.all.bottomPadding` (number) - `grid.styling.all.leftPadding` (number) - `grid.styling.all.rightPadding` (number) - `grid.styling.all.fullWidthEnabled` (boolean) - `grid.styling.all.maxWidth` (number) - `grid.styling.all.minWidth` (number) - `grid.styling.all.width` (number) - `grid.styling.all.flex` (integer) - `grid.styling.all.minHeight` (number) - `grid.styling.all.maxHeight` (number) - `grid.styling.all.height` (number) - `grid.styling.all.borderRadiusTopLeft` (number) - `grid.styling.all.borderRadiusTopRight` (number) - `grid.styling.all.borderRadiusBottomLeft` (number) - `grid.styling.all.borderRadiusBottomRight` (number) - `grid.styling.all.borderWidthTop` (number) - `grid.styling.all.borderWidthBottom` (number) - `grid.styling.all.borderWidthLeft` (number) - `grid.styling.all.borderWidthRight` (number) - `grid.styling.all.borderColorTop` (string) - `grid.styling.all.borderColorBottom` (string) - `grid.styling.all.borderColorLeft` (string) - `grid.styling.all.borderColorRight` (string) - `grid.styling.all.borderStyleTop` (string) - `grid.styling.all.borderStyleBottom` (string) - `grid.styling.all.borderStyleLeft` (string) - `grid.styling.all.borderStyleRight` (string) - `grid.styling.all.backgroundVideo` (string) - `grid.styling.all.backgroundImage` (string) - `grid.styling.all.backgroundMediaRepeat` (string) - `grid.styling.all.backgroundMediaFit` (string) - `grid.styling.all.backgroundMediaSizeWidth` (number) - `grid.styling.all.backgroundMediaSizeHeight` (number) - `grid.styling.all.backgroundMediaPosition` (string) - `grid.styling.all.backgroundMediaScroll` (string) - `grid.styling.all.backgroundMediaParallax` (boolean) - `grid.styling.all.backgroundMediaAutoPlay` (boolean) - `grid.styling.all.backgroundMediaMuted` (boolean) - `grid.styling.all.backgroundMediaLoop` (boolean) - `grid.styling.all.backgroundColorOverlayColor` (string) - `grid.styling.all.backgroundColorOverlayOpacity` (number) - `grid.styling.all.backgroundGradientOverlayColors` (array) - `grid.styling.all.backgroundGradientOverlayOpacity` (number) - `grid.styling.all.backgroundGradientOverlayDirection` (string) - `grid.styling.all.backgroundColor` (string) - `grid.styling.all.backgroundColorOffsetBottom` (number) - `grid.styling.all.backgroundColorOffsetLeft` (number) - `grid.styling.all.backgroundColorOffsetRight` (number) - `grid.styling.all.backgroundColorOffsetTop` (number) - `grid.styling.all.backgroundGradientColors` (array) - `grid.styling.all.backgroundGradientOpacity` (number) - `grid.styling.all.backgroundGradientDirection` (string) - `grid.styling.all.animationDelay` (number) - `grid.styling.all.animationDuration` (number) - `grid.styling.all.animationIn` (string) - `grid.styling.all.animationOut` (string) - `grid.styling.all.animationRepeat` (string) - `grid.styling.all.animationDirection` (string) - `grid.styling.all.animationTimingFunction` (string) - `grid.styling.all.animationFillMode` (string) - `grid.styling.all.mediaHover` (string) - `grid.styling.all.mediaAlignment` (string) - `grid.styling.all.mediaFit` (string) - `grid.styling.all.mediaPosition` (string) - `grid.styling.all.enlargeOnClickBorderRadiusTopLeft` (number) - `grid.styling.all.enlargeOnClickBorderRadiusTopRight` (number) - `grid.styling.all.enlargeOnClickBorderRadiusBottomLeft` (number) - `grid.styling.all.enlargeOnClickBorderRadiusBottomRight` (number) - `grid.styling.all.enlargeOnClickBorderWidthTop` (number) - `grid.styling.all.enlargeOnClickBorderWidthBottom` (number) - `grid.styling.all.enlargeOnClickBorderWidthLeft` (number) - `grid.styling.all.enlargeOnClickBorderWidthRight` (number) - `grid.styling.all.enlargeOnClickBorderColorTop` (string) - `grid.styling.all.enlargeOnClickBorderColorBottom` (string) - `grid.styling.all.enlargeOnClickBorderColorLeft` (string) - `grid.styling.all.enlargeOnClickBorderColorRight` (string) - `grid.styling.all.enlargeOnClickBorderStyleTop` (string) - `grid.styling.all.enlargeOnClickBorderStyleBottom` (string) - `grid.styling.all.enlargeOnClickBorderStyleLeft` (string) - `grid.styling.all.enlargeOnClickBorderStyleRight` (string) - `grid.styling.all.enlargeOnClickShadowOffsetX` (number) - `grid.styling.all.enlargeOnClickShadowOffsetY` (number) - `grid.styling.all.enlargeOnClickShadowBlur` (number) - `grid.styling.all.enlargeOnClickShadowColor` (string) - `grid.styling.all.enlargeOnClickShadowSpread` (number) - `grid.styling.all.enlargeOnClickShadowInset` (boolean) - `grid.styling.all.enlargeOnClickShadowOpacity` (number) - `grid.styling.all.enlargeOnClickScale` (number) - `grid.styling.all.shadowOffsetX` (number) - `grid.styling.all.shadowOffsetY` (number) - `grid.styling.all.shadowBlur` (number) - `grid.styling.all.shadowBorderRadiusTopLeft` (number) - `grid.styling.all.shadowBorderRadiusTopRight` (number) - `grid.styling.all.shadowBorderRadiusBottomLeft` (number) - `grid.styling.all.shadowBorderRadiusBottomRight` (number) - `grid.styling.all.shadowColor` (string) - `grid.styling.all.shadowSpread` (number) - `grid.styling.all.shadowInset` (boolean) - `grid.styling.all.shadowOpacity` (number) - `grid.styling.all.textGradientOverlayColors` (array) - `grid.styling.all.textGradientOverlayOpacity` (number) - `grid.styling.all.textGradientOverlayDirection` (string) - `grid.styling.all.darkTextEnabled` (boolean) - `grid.styling.all.textAlign` (string) - `grid.styling.all.transitionScrollSpeed` (number) - `grid.styling.all.autoRotate` (boolean) - `grid.styling.all.autoRotateInterval` (number) - `grid.styling.all.buttonIcon` (string) - `grid.styling.all.buttonIconPosition` (string) - `grid.styling.all.buttonIconColor` (string) - `grid.styling.all.openInNewWindow` (boolean) - `grid.styling.all.sidebar` (boolean) - `grid.styling.all.sidebarPosition` (string) - `grid.styling.all.sidebarAnimation` (string) - `grid.styling.all.sidebarAnimationDuration` (number) - `grid.styling.all.sidebarAnimationTimingFunction` (string) - `grid.styling.all.fontFamily` (string) - `grid.styling.all.fontSize` (number) - `grid.styling.all.fontWeight` (string) - `grid.styling.all.fontDecoration` (string) - `grid.styling.all.fontTextTransform` (string) - `grid.styling.all.fontLineHeight` (number) - `grid.styling.all.fontLetterSpacing` (number) - `grid.styling.all.fontColorLight` (string) - `grid.styling.all.fontColorDark` (string) - `grid.styling.all.h1FontFamily` (string) - `grid.styling.all.h1FontSize` (number) - `grid.styling.all.h1FontWeight` (string) - `grid.styling.all.h1FontDecoration` (string) - `grid.styling.all.h1TextTransform` (string) - `grid.styling.all.h1LineHeight` (number) - `grid.styling.all.h1LetterSpacing` (number) - `grid.styling.all.h1ColorLight` (string) - `grid.styling.all.h1ColorDark` (string) - `grid.styling.all.h2FontFamily` (string) - `grid.styling.all.h2FontSize` (number) - `grid.styling.all.h2FontWeight` (string) - `grid.styling.all.h2FontDecoration` (string) - `grid.styling.all.h2TextTransform` (string) - `grid.styling.all.h2LineHeight` (number) - `grid.styling.all.h2LetterSpacing` (number) - `grid.styling.all.h2ColorLight` (string) - `grid.styling.all.h2ColorDark` (string) - `grid.styling.all.h3FontFamily` (string) - `grid.styling.all.h3FontSize` (number) - `grid.styling.all.h3FontWeight` (string) - `grid.styling.all.h3FontDecoration` (string) - `grid.styling.all.h3TextTransform` (string) - `grid.styling.all.h3LineHeight` (number) - `grid.styling.all.h3LetterSpacing` (number) - `grid.styling.all.h3ColorLight` (string) - `grid.styling.all.h3ColorDark` (string) - `grid.styling.all.h4FontFamily` (string) - `grid.styling.all.h4FontSize` (number) - `grid.styling.all.h4FontWeight` (string) - `grid.styling.all.h4FontDecoration` (string) - `grid.styling.all.h4TextTransform` (string) - `grid.styling.all.h4LineHeight` (number) - `grid.styling.all.h4LetterSpacing` (number) - `grid.styling.all.h4ColorLight` (string) - `grid.styling.all.h4ColorDark` (string) - `grid.styling.all.h5FontFamily` (string) - `grid.styling.all.h5FontSize` (number) - `grid.styling.all.h5FontWeight` (string) - `grid.styling.all.h5FontDecoration` (string) - `grid.styling.all.h5TextTransform` (string) - `grid.styling.all.h5LineHeight` (number) - `grid.styling.all.h5LetterSpacing` (number) - `grid.styling.all.h5ColorLight` (string) - `grid.styling.all.h5ColorDark` (string) - `grid.styling.all.h6FontFamily` (string) - `grid.styling.all.h6FontSize` (number) - `grid.styling.all.h6FontWeight` (string) - `grid.styling.all.h6FontDecoration` (string) - `grid.styling.all.h6TextTransform` (string) - `grid.styling.all.h6LineHeight` (number) - `grid.styling.all.h6LetterSpacing` (number) - `grid.styling.all.h6ColorLight` (string) - `grid.styling.all.h6ColorDark` (string) - `grid.styling.all.navigationFontFamily` (string) - `grid.styling.all.navigationFontSize` (number) - `grid.styling.all.navigationFontWeight` (string) - `grid.styling.all.navigationFontDecoration` (string) - `grid.styling.all.navigationTextTransform` (string) - `grid.styling.all.navigationLineHeight` (number) - `grid.styling.all.navigationLetterSpacing` (number) - `grid.styling.all.navigationColorLight` (string) - `grid.styling.all.navigationColorDark` (string) - `grid.styling.all.subNavigationFontFamily` (string) - `grid.styling.all.subNavigationFontSize` (number) - `grid.styling.all.subNavigationFontWeight` (string) - `grid.styling.all.subNavigationFontDecoration` (string) - `grid.styling.all.subNavigationTextTransform` (string) - `grid.styling.all.subNavigationLineHeight` (number) - `grid.styling.all.subNavigationLetterSpacing` (number) - `grid.styling.all.subNavigationColorLight` (string) - `grid.styling.all.subNavigationColorDark` (string) - `grid.styling.all.bodyFontFamily` (string) - `grid.styling.all.bodyFontSize` (number) - `grid.styling.all.bodyFontWeight` (string) - `grid.styling.all.bodyFontDecoration` (string) - `grid.styling.all.bodyTextTransform` (string) - `grid.styling.all.bodyLineHeight` (number) - `grid.styling.all.bodyLetterSpacing` (number) - `grid.styling.all.bodyColorLight` (string) - `grid.styling.all.bodyColorDark` (string) - `grid.styling.all.hyperlinkFontFamily` (string) - `grid.styling.all.hyperlinkFontSize` (number) - `grid.styling.all.hyperlinkFontWeight` (string) - `grid.styling.all.hyperlinkFontDecoration` (string) - `grid.styling.all.hyperlinkTextTransform` (string) - `grid.styling.all.hyperlinkLineHeight` (number) - `grid.styling.all.hyperlinkLetterSpacing` (number) - `grid.styling.all.hyperlinkColorLight` (string) - `grid.styling.all.hyperlinkColorDark` (string) - `grid.styling.mobile` (object) The style set for the mobile device - `grid.styling.tablet` (object) The style set for the tablet device - `grid.styling.desktop` (object) The style set for the desktop device - `profileImage` (object) Profile image property - `profileImagePosition` (string) Profile image position (top, left, right, bottom, background) Example: "top" - `profileImageStyling` (object) Style set for the profile image - `firstInitialProperty` (object) First initial property - `secondInitialProperty` (object) Second initial property - `whatsAppProperty` (object) WhatsApp property - `phoneProperty` (object) Phone property - `emailProperty` (object) Email property - `profileImageValue` (string) Value of the profile image - `firstInitialPropertyValue` (string) Value of the first initial property - `secondInitialPropertyValue` (string) Value of the second initial property - `whatsAppPropertyValue` (string) Value of the whatsApp property - `phonePropertyValue` (string) Value of the phone property - `emailPropertyValue` (string) Value of the email property - `customCss` (string) Custom CSS styles for the preview - `url` (string) URL of the preview - `styling` (object) The styling of the preview - `name` (string, required) The name of the entity ## 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): - `message` (string) The error message providing details about the failure. Example: "Resource not found." - `errors` (object) A list of error types providing further details about the error. Example: [{"field":"name","message":"Name is required.","correctionSuggestion":"Please provide a name."}] - `errors.correctionSuggestion` (string, required) A suggestion on how to correct the error. Example: "Try uploading a different 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" - `status` (integer) The HTTP status code associated with the error. Example: 400 - `stackTrace` (string) - `roles` (array) Enum: "USER", "ADMIN", "RESELLER", "DEVELOPER", "SUPER_ADMIN" - `scopes` (array) ## Response 500 fields (application/json): - `message` (string) The error message providing details about the failure. Example: "Resource not found." - `errors` (object) A list of error types providing further details about the error. Example: [{"field":"name","message":"Name is required.","correctionSuggestion":"Please provide a name."}] - `errors.correctionSuggestion` (string, required) A suggestion on how to correct the error. Example: "Try uploading a different 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" - `status` (integer) The HTTP status code associated with the error. Example: 400 - `stackTrace` (string) - `roles` (array) Enum: "USER", "ADMIN", "RESELLER", "DEVELOPER", "SUPER_ADMIN" - `scopes` (array)