--- title: "Create new personalization" method: POST path: "/personalizations" tags: ["Personalization"] --- # Create new personalization `POST /personalizations` Create new personalization with given parameters ## Request body - Personalization - `attributionWindow` integer - `baseURL` string, required — URL of the website to load in editor and preview mode - `cappingPerVisitorConvertGoal` boolean — If true, cease exposing the same visitor when the goal is reached - `cappingPerVisitorExposedVisits` boolean — If true, cease exposing the same visitor when the number of visits exceeds this limit - `cappingPerVisitorExpositions` boolean — If true, cease exposing the same visitor when total exposures exceed this limit. - `cappingPerVisitorGoalId` integer — Cease exposing the same visitor when the goal with this Id is reached - `category` string - `checkConditionsRule` 'ALL_CONDITIONS' | 'CUMULATIVE_WEIGHT' — Kameleoon’s behavior in determining whether a visitor is targeted or not. - `collectingDataEnabled` boolean - `createdBy` integer — Account Id of the creator of this personalization - `cssCode` string — CSS code to be integrated into the source code of the page - `customExpositionRate` number, double — Percentage of the segment exposed to a personalization - `dateCollectingDataStopped` string, date-time — Date of the latest data collection - `dateCreated` string, date-time — Date when personalization was created - `dateEnded` string, date-time — Date when personalization was ceased - `dateModified` string, date-time — Date and time when the personalization was last modified - `dateStarted` string, date-time — Date when personalization was started - `dateStatusModified` string, date-time — Timestamp of the last update - `description` string — Description of the personalization - `exposedVisitsSameVisitorMax` integer — Cease exposing the same visitor when the number of visits exceed this limit - `expositionFrequencyDelay` integer — Frequency of exposure for different visitors - `format` string - `globalCappingGoalId` integer — Threshold goal for the total number of exposed visitors - `globalCappingNumberVisitors` boolean — Option to allow capping visitors for a configuration - `globalCappingVisitorsConfig` 'NUMBER_VISITORS' | 'NUMBER_VISITORS_CONVERT_GOAL' | 'NUMBER_VISITORS_NOT_CONVERT_GOAL' — Visitors configuration for the capped number of exposed visitors - `globalScript` string — JavaScript code that will be applied only to the selected personalization and executed in the end of the Global custom script - `goals` integer[] — Selected goals - `id` integer — Unique Id of the personalization - `imageInPage` ImageInPage — Settings of an image in page - `domElementSelector` string - `height` string - `htmlContent` string - `image` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `mainPageUrl` string - `positionDefinition` 'EDITOR' | 'SELECTOR' - `positionSelectorRelative` 'REPLACE' | 'BEFORE' | 'AFTER' | 'NULL' - `redirectURL` string - `width` string - `isArchived` boolean — Indicates if the personalization is archived - `javaScriptCode` string — JavaScript code to add in the page - `location` string - `mainGoalId` integer — Id of the main goal - `market` string - `maxNumberVisitorsExposed` integer — Limit of the total number of exposed visitors - `metaReadOnly` string — Personalization in READ_ONLY mode for sub-personalization - `multiExpositionFrequencyDelay` integer — Minimum delay between each exposure - `name` string, required — Name of the personalization - `personalizationConfiguration` 'CUSTOM' | 'HTML_IN_PAGE' | 'IMAGE_IN_PAGE' | 'INFOBULLE_ABOVE' | 'NEWS_LETTER' | 'NONE' | 'POPIN' | 'STICKY_BLOCK' | 'TEMPLATE' | 'VARIATION' — Personalization configuration - `popIn` PopIn — Pop-In settings - `animationDirection` 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'CENTER' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT' | 'CUSTOM' - `animationTrigger` 'ON_OPEN' | 'ON_CLOSE' | 'ON_OPEN_AND_CLOSE' | 'CONTINUOUSLY' - `animationType` 'NONE' | 'FADE' | 'SLIDER' | 'ZOOM_IN' | 'ZOOM_OUT' | 'BOUNCE' - `backgroundColor` string - `closeWithClickOnOverlay` boolean - `customPositionAxisX` string - `customPositionAxisY` string - `displayImageConfiguration` 'DISPLAY_ALL_DEVICES' | 'DISPLAY_ONLY_DESKTOP' | 'DISPLAY_ONLY_TABLET' | 'DISPLAY_ONLY_MOBILE' | 'DISPLAY_DESKTOP_TABLET' | 'DISPLAY_DESKTOP_MOBILE' | 'DISPLAY_TABLET_MOBILE' - `fontSize` string - `height` string - `heightImageDesktop` string - `heightImageMobile` string - `heightImageTablet` string - `htmlContent` string - `idTarget2Sell` string - `image` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `imageDesktop` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `imageMobile` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `imageTablet` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `name` string - `position` 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'CENTER' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT' | 'CUSTOM' - `redirectURL` string - `targetBlank` boolean - `template` boolean - `textColor` string - `textContent` string - `type` 'SINGLE_IMAGE' | 'FULL_IMAGE_TEXT' | 'FULL_TEXT_IMAGE' | 'HTML' | 'TARGET2SELL' - `width` string - `widthImageDesktop` string - `widthImageMobile` string - `widthImageTablet` string - `withOverlay` boolean - `priority` integer — Priority of the personalization - `siteId` integer, required — Site Id of the project the personalization belongs to - `status` string — Status of the personalization - `stickyBlock` StickyBlock — Sticky block settings - `animationDirection` 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'CENTER' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT' | 'CUSTOM' - `animationTrigger` 'ON_OPEN' | 'ON_CLOSE' | 'ON_OPEN_AND_CLOSE' | 'CONTINUOUSLY' - `animationType` 'NONE' | 'FADE' | 'SLIDER' | 'ZOOM_IN' | 'ZOOM_OUT' | 'BOUNCE' - `backgroundColor` string - `customPositionAxisX` string - `customPositionAxisY` string - `displayImageConfiguration` 'DISPLAY_ALL_DEVICES' | 'DISPLAY_ONLY_DESKTOP' | 'DISPLAY_ONLY_TABLET' | 'DISPLAY_ONLY_MOBILE' | 'DISPLAY_DESKTOP_TABLET' | 'DISPLAY_DESKTOP_MOBILE' | 'DISPLAY_TABLET_MOBILE' - `fontSize` string - `height` string - `heightImageDesktop` string - `heightImageMobile` string - `heightImageTablet` string - `htmlContent` string - `idTarget2Sell` string - `image` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `imageDesktop` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `imageMobile` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `imageTablet` Image - `altText` string - `baseColor` integer — Image base color - `colorDepth` integer - `createdById` integer — Account Id of the image uploader - `date` string, date-time — Date the image was uploaded - `description` string - `fileName` string — Image file name - `fileWeight` integer — Image file size in KB - `format` 'PNG' | 'JPEG' | 'GIF' | 'SVG' | 'MVG' | 'WEB' — Image format (formats accepted: JPG, JPEG, PNG, GIF, WEBP, SVG, MVG) - `height` integer — Image height in pixels - `id` integer — Unique Id of the image - `keywords` string[] — Keyword(s) associated with the image - `name` string — Image name - `path` string — Image path - `shared` boolean — Indicates if the image has been shared - `siteId` integer — Unique Id of the site your project is associated with - `size` integer — Image size in bytes. Image file size should be maximum 5242880 bytes - `source` string — Image source - `sourceUrl` string — URL or the image source - `tags` string[] - `width` integer — Image width in pixels - `name` string - `position` 'TOP' | 'BOTTOM' | 'LEFT' | 'RIGHT' | 'CENTER' | 'TOP_LEFT' | 'TOP_RIGHT' | 'BOTTOM_LEFT' | 'BOTTOM_RIGHT' | 'CUSTOM' - `redirectURL` string - `shiftContent` boolean - `shouldScrollTo` boolean - `targetBlank` boolean - `template` boolean - `textColor` string - `textContent` string - `type` 'SINGLE_IMAGE' | 'FULL_IMAGE_TEXT' | 'FULL_TEXT_IMAGE' | 'HTML' | 'TARGET2SELL' - `width` string - `widthImageDesktop` string - `widthImageMobile` string - `widthImageTablet` string - `tags` string[] — List of tags - `targetingRule` TargetingRule — Targeting Rule defines the conditions for displaying content to specific user groups based on segments and triggers - `id` integer — Unique Id of the targeting rule - `segmentConfiguration` 'ALL_VISITORS' | 'AUTOPROMO_AUTODEFINED' | 'GRAPHICAL_PAGES' | 'HEAT_SLICE' | 'PAGE' | 'SAVED_TEMPLATE' | 'SITE' | 'URL' — Configuration defining how the segment should be applied - `segmentId` integer — Id of the associated segment (user group) for targeting. If segment is deprecated, no trigger will be available for this rule. - `siteId` integer, required — Id of the project this targeting rule belongs to - `targetingConfigurationParam` string — Additional parameters for trigger configuration. For SAVED_TEMPLATE/HEAT_SLICE - contains segment Id. For PAGE - contains full URL. For URL - contains URL fragment. - `triggerConfiguration` 'ALL_VISITORS' | 'AUTOPROMO_AUTODEFINED' | 'GRAPHICAL_PAGES' | 'HEAT_SLICE' | 'PAGE' | 'SAVED_TEMPLATE' | 'SITE' | 'URL' — Configuration defining how the trigger should be applied. ALL_VISITORS configuration is not allowed for this trigger type - `triggerId` integer — Id of the associated trigger (activation condition) - `targetingRuleId` integer — Deprecated. Use TargetingRule instead. - `targetingSegmentId` integer — Selected targeting segment - `trackingTools` TrackingTool[] — List of tracking tools - `adobeOmnitureObject` string - `comScoreCustomerId` string - `comScoreDomain` string - `contentSquareUrl` string - `customIntegrations` string[] - `customVariable` integer - `eulerianUserCentricParameter` string - `name` 'GOOGLE_ANALYTICS4' | 'GOOGLE_ANALYTICS4_AUDIENCES' | 'GOOGLE_UNIVERSAL_ANALYTICS' | 'ECONDA' | 'SMART_TAG' | 'PIANO' | 'ADOBE_OMNITURE' | 'EULERIAN' | 'WEBTRENDS' | 'KISSMETRICS' | 'PIWIK' | 'CRAZY_EGG' | 'COM_SCORE' | 'TEALIUM' | 'YSANCE' | 'M_PATHY' | 'SMARTFOCUS' | 'EMARSYS' | 'EXPERTSENDER' | 'TAG_COMMANDER' | 'CONTENT_SQUARE' | 'WEBTREKK' | 'CUSTOM_INTEGRATIONS' | 'HEAP' | 'HEAP_COHORTS' | 'KLAVIYO_COHORTS' | 'SEGMENT' | 'MIXPANEL' | 'CLARITY' | 'IABTCF' | 'DATABRICKS' | 'REDSHIFT' | 'SMARTLOOK' | 'MOUSEFLOW' | 'KLAVIYO' | 'FULLSTORY' | 'AMPLITUDE' | 'SNOWPLOW' | 'JUNE' | 'MPARTICLE' | 'BIGQUERY' | 'RUDDERSTACK' | 'SNOWFLAKE' | 'GLASSBOX' | 'HUBSPOT' | 'AIR360' | 'DATADOG' | 'QUANTUM_METRIC' | 'GLASSBOX_V2' | 'BRAZE' | 'KAMELEOON_TRACKING' | 'CUSTOM_TRACKING' | 'VERCEL' | 'AKAMAI' - `reportingScript` string - `universalAnalyticsDimension` integer - `type` 'AUTOPROMO' | 'BUILDER' | 'CLASSIC' | 'IA' | 'PERSO_RULE' — Type of personalization - `variationId` integer — Variation Id of the personalization - `variationIds` integer[] — List of variation ids for this personalization. Includes variations from other personalizations (variation.personalizationId != this ID). Variations with personalizationId can only be deleted via 'Delete variation' operation. - `visitExpositionFrequency` integer — Frequency of exposure during a unique visit - `visitorExpositionFrequency` integer — Frequency of exposure for a unique visitor - `visitorExpositionFrequencyMax` integer — Cease exposing to this visitor once their exposure exceeds this limit. - `widget` Template - `config` string — Widget editor configuration field linked to the translation locales field in JSON format. - `cssCode` string — CSS that belongs to this template. - `dateActivated` string, date-time — Date when the widget was activated. - `dateCreated` string, date-time — Date when this widget was created - `dateModified` string, date-time — Date when this widget was modified - `description` string — Description of the template. - `htmlCode` string — UI text that belongs to this template. - `id` integer — Unique Id of the template - `isCustomTemplate` boolean — Indicates if this is a custom template. - `name` string — Name of the template. - `siteId` integer, required — Web Id of the studio template. - `status` 'DRAFT' | 'ACTIVE' | 'PAUSED' — Template status. - `tags` string[] — Tags that belong to this template. - `templateCssCode` string — CSS code that belongs to this template. - `templateHtmlCode` string — HTML code that belongs to this template. - `templateJavaScriptCode` string — JavaScript code that belongs to this template. - `themeId` integer — Id of the theme linked to the widget. - `type` 'TEMPLATE' | 'EDITOR' | 'PBX' — Type of template. - `url` string — Url associated with this template. - `useCustomData` boolean — Indicates if custom data is being used. - `widgetEditorTemplate` string — Widget editor code that belongs to this template. ## Response `201` Created ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `422` — Unprocessable Entity - `423` — Locked - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.net/kameleoon/apis/openapi-definition-for-automation-api.md) · [All operations](https://skmtc.net/kameleoon/apis/openapi-definition-for-automation-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kameleoon/openapi-definition-for-automation-api/versions/09f2abcea0b5/schema)