{"openapi":"3.0.3","info":{"title":"Smartblocks API","description":"Manages Smartblocks within Dotdigital Personalization. Smartblocks are the reusable content and logic components that deliver personalised experiences within slots across web and email surfaces. Operations include listing all Smartblocks for a website, creating new Smartblocks, retrieving a specific Smartblock's configuration, and updating Smartblock properties.","version":"1.1.1"},"servers":[{"url":"https://{region}-api-freshrelevance.dotdigital.com/api","variables":{"region":{"description":"The region id your account belongs to","enum":["r1","r2","r3"],"default":"r1"}}}],"security":[{"apiTokenAuth":[]}],"paths":{"/{website_id}/smartblocks/":{"get":{"tags":["Smartblocks"],"summary":"Get Smartblocks","description":"Retrieves the Smartblocks for the website in JSON format.","operationId":"smartblocks_list_all","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"page","in":"query","description":"Which page of results you wish to return.","required":false,"schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"The limit of the amount of results to display per page.","required":false,"schema":{"type":"integer","default":25}},{"name":"filterByType","in":"query","description":"Filters by Smartblock type(s)","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["product","countdown","instagram","twitter","banner","coupon","pinterest","webcrop","reviews","popover"]}}},{"name":"tags","in":"query","description":"Filters by the specified tag(s)","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"folder_id","in":"query","description":"Filters by folder","required":false,"schema":{"type":"string"}},{"name":"search_string","in":"query","description":"Filters to only SmartBlocks that has the specified string in their `name`","required":false,"schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Include deleted Smartblocks in the results","required":false,"schema":{"type":"boolean","default":false}},{"name":"load_slot_list","in":"query","description":"Include a list of Slots that contain the SmartBlock in the results","required":false,"schema":{"type":"boolean","default":false}},{"name":"include_live_flag","in":"query","description":"Include the field `is_live` which indicates whether the Smartblock has recently recieved impressions in the results","required":false,"schema":{"type":"boolean","default":false}},{"name":"typeCount","in":"query","description":"Include a list of the counts of all Smartblock types in the results","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The Smartblock requested","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200"},"examples":{"Smartblocks example":{"value":{"links":{"next":"https://api.freshrelevance.com/api/ab55bjkl/smartblocks/?format=json&page=3","previous":"https://api.freshrelevance.com/api/ab55bjkl/smartblocks/?format=json"},"count":636,"total":636,"page":2,"results":[{"slug":"gi84j7e","name":"Email push2dd column test","type":"banner","dt":"2024-09-19T11:02:22.744000","personalised":true,"tags":["Banner"],"folder_id":"5f95ytrvghmq","active":true,"last_edited_by":"a.person","locked":false,"layout":"e1ocnvg","preview_url":"https://c1.dycdn.net/abc1234l/sb/gi84j7e/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/gi84j7e/?format=thumb&k=ocemgn4&version=5"},{"slug":"o1w8ji4","name":"Snap","type":"webcrop","dt":"2024-09-12T13:07:49.601000","personalised":true,"tags":["Web Crop"],"active":true,"last_edited_by":"a.person","locked":false,"preview_url":"https://c1.dycdn.net/abc1234l/sb/o1w8ji4/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/o1w8ji4/?format=thumb&k=ocemgn4&version=155&url=https%3A%2F%2Fdotdigital.com%2Fblog%2F"},{"slug":"e0za0b8","name":"Capture form","type":"popover","dt":"2024-09-12T09:54:40.078000","personalised":true,"tags":[],"folder_id":"5f95ytrvghmq","active":true,"last_edited_by":"a.person","locked":false,"layout":"7cxi6w8","preview_url":"https://c1.dycdn.net/abc1234l/sb/e0za0b8/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/e0za0b8/?&preview=true&format=thumb&k=ocemgn4&version=2"},{"slug":"6e60wq5","name":"Demo take 2","type":"popover","dt":"2024-09-11T16:07:17.301000","personalised":true,"tags":["Data Capture"],"active":true,"last_edited_by":"a.person","locked":false,"layout":"t6bd88c","preview_url":"https://c1.dycdn.net/abc1234l/sb/6e60wq5/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/6e60wq5/?&preview=true&format=thumb&k=ocemgn4&version=6"},{"slug":"ddbv047","name":"Data capture flow","type":"popover","dt":"2024-09-11T15:36:31.660000","personalised":true,"tags":["Data Capture"],"folder_id":"5f95ytrvghmq","active":true,"last_edited_by":"a.person","locked":false,"layout":"74i3b7e","preview_url":"https://c1.dycdn.net/abc1234l/sb/ddbv047/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/ddbv047/?&preview=true&format=thumb&k=ocemgn4&version=7"},{"slug":"bndudaq","name":"Push2DD - Merge Test","type":"product","dt":"2024-09-09T12:48:14.278000","personalised":true,"tags":[],"folder_id":"5f95ytrvghmq","active":true,"last_edited_by":"a.person","locked":false,"layout":"4xs7g9x","preview_url":"https://c1.dycdn.net/abc1234l/sb/bndudaq/?preview=true&k=ocemgn4&format=dynamichtml","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/bndudaq/?format=thumb&k=ocemgn4&version=2&curr=GBP&sbr=experiencedemo","crowd_source_window":168},{"slug":"rcp5rs4","name":"smart test","type":"popover","dt":"2024-09-05T17:17:49.766000","personalised":false,"tags":[],"active":true,"locked":false,"layout":"","preview_url":"https://c1.dycdn.net/abc1234l/sb/rcp5rs4/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/rcp5rs4/?&preview=true&format=thumb&k=ocemgn4&version=3"},{"slug":"dc2ibr2","name":"Demo data capture","type":"popover","dt":"2024-09-05T17:17:04.023000","personalised":true,"tags":["Data Capture"],"folder_id":"43jc5em6frj5","active":true,"last_edited_by":"a.person","layout":"1p2o6jv","preview_url":"https://c1.dycdn.net/abc1234l/sb/dc2ibr2/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/dc2ibr2/?&preview=true&format=thumb&k=ocemgn4&version=6"},{"slug":"95ooile","name":"Another test data capture","type":"popover","dt":"2024-09-05T16:50:37.833000","personalised":true,"tags":[],"folder_id":"43jc5em6frj5","active":true,"last_edited_by":"a.person","locked":false,"layout":"popover_web","preview_url":"https://c1.dycdn.net/abc1234l/sb/95ooile/?preview=true&k=ocemgn4&format=dynamicimage"},{"slug":"rvu4wgd","name":"Test data capture","type":"popover","dt":"2024-09-05T16:49:32.680000","personalised":true,"tags":["Data Capture"],"folder_id":"5f95ytrvghmq","active":true,"last_edited_by":"a.person","locked":false,"layout":"oz2mtww","preview_url":"https://c1.dycdn.net/abc1234l/sb/rvu4wgd/?preview=true&k=ocemgn4&format=dynamicimage","thumbnail_url":"https://c1.dycdn.net/abc1234l/sb/rvu4wgd/?&preview=true&format=thumb&k=ocemgn4&version=6"}]}},"TypeCount example":{"value":{"links":{},"count":1,"total":1,"page":1,"results":[{"banner":185,"countdown":38,"coupon":10,"custom":4,"instagram":5,"pinterest":1,"popover":96,"product":280,"reviews":1,"twitter":3,"webcrop":3}]}}}}}},"403":{"$ref":"#/components/responses/ForbiddenResponse"}}},"post":{"tags":["Smartblocks"],"summary":"Create Smartblock","description":"Creates a Smartblock.","operationId":"smartblocks_create","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/website_id_smartblocks_body"},"examples":{"banner":{"$ref":"#/components/examples/BannerCreateExample"},"countdown":{"$ref":"#/components/examples/CountdownCreateExample"},"instagram":{"$ref":"#/components/examples/InstagramCreateExample"},"product_recommendations":{"$ref":"#/components/examples/ProductRecommendationsBasic"},"product_recommendations_crowd_src":{"$ref":"#/components/examples/ProductRecommendationsCrowdSrc"},"coupon":{"$ref":"#/components/examples/CouponCreateExample"},"pinterest":{"$ref":"#/components/examples/PinterestCreateExample"},"webcrop":{"$ref":"#/components/examples/WebcropCreateExample"},"reviews":{"$ref":"#/components/examples/ReviewsCreateExample"},"popover":{"$ref":"#/components/examples/PopoverCreateExample"}}}},"required":true},"responses":{"201":{"description":"Details of the created Smartblock","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Smartblock"}}}},"400":{"$ref":"#/components/responses/ErrorResponse"}}}},"/{website_id}/smartblocks/{smartblock_slug}/":{"get":{"tags":["Edit Smartblock"],"summary":"Get Smartblock","description":"Retrieves details of an individual Smartblock","operationId":"smartblocks_retrieve","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"smartblock_slug","in":"path","required":true,"schema":{"minLength":1,"type":"string","description":"The Smartblocks slug/unique id"}},{"name":"page","in":"query","description":"Which page of results you wish to return.","required":false,"schema":{"type":"integer","default":1}},{"name":"limit","in":"query","description":"The limit of the amount of results to display per page.","required":false,"schema":{"type":"integer","default":25}}],"responses":{"200":{"description":"The result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_1"},"examples":{"smartblock":{"summary":"Smartblock","value":{"slug":"nx9hx5i","name":"Test block","type":"banner","dt":"2024-11-06T15:18:20.585000","personalised":false,"tags":[],"active":true,"locked":false,"layout":"x24dfgk","preview_url":"https://c8.dycdn.net/ab55bjkl/sb/nx9hx5i/?preview=true&k=odemgn4&format=dynamicimage","thumbnail_url":"https://c8.dycdn.net/ab55bjkl/sb/nx9hx5i/?format=thumb&k=odemgn4&version=2"}},"notFound":{"summary":"Smartblock not found","value":["No Smartblock Found"]}}}}}}},"post":{"tags":["Edit Smartblock"],"summary":"Update Smartblock","description":"Updates a Smartblock","operationId":"smartblocks_update","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"smartblock_slug","in":"path","required":true,"schema":{"minLength":1,"type":"string","description":"The Smartblocks slug/unique id"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Smartblock"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Smartblock"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Smartblock"}}},"required":true},"responses":{"200":{"description":"The result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_1"},"examples":{"smartblock":{"summary":"Smartblock","value":{"slug":"nx9hx5i","name":"Test block","type":"banner","dt":"2024-11-06T15:18:20.585000","personalised":false,"tags":[],"active":true,"locked":false,"layout":"x24dfgk","preview_url":"https://c8.dycdn.net/ab55bjkl/sb/nx9hx5i/?preview=true&k=odemgn4&format=dynamicimage","thumbnail_url":"https://c8.dycdn.net/ab55bjkl/sb/nx9hx5i/?format=thumb&k=odemgn4&version=2"}},"notFound":{"summary":"Smartblock not found","value":["No Smartblock Found"]}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenResponse"}}},"delete":{"tags":["Edit Smartblock"],"summary":"Delete Smartblock","description":"Deletes a Smartblock","operationId":"smartblocks_delete","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"smartblock_slug","in":"path","required":true,"schema":{"minLength":1,"type":"string","description":"The Smartblocks slug/unique id"}}],"responses":{"200":{"$ref":"#/components/responses/SmartblockNotFound"},"204":{"description":"No response body"}}}},"/{website_id}/smartblocks/{slugs}/bulk/":{"post":{"tags":["Bulk operations"],"summary":"Bulk update Smartblocks","description":"Allows multiple SmartBlocks to be edited at once for example, to update the folder id of multiple SmartBlocks.\nThis API supports updating the `folder_id`, `locked` and `active` fields only. The `active` field should be set to `true` to undelete the SmartBlocks.","operationId":"smartblocks_bulk_update","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"slugs","in":"path","description":"Smartblock slug(s), comma delimited list of slugs","required":true,"style":"simple","schema":{"type":"array","items":{"minLength":1,"type":"string","example":"wddaq4t"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/slugs_bulk_body"}}},"required":true},"responses":{"200":{"description":"Successful call","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_2"}}}},"403":{"$ref":"#/components/responses/ForbiddenResponse"}}},"delete":{"tags":["Bulk operations"],"summary":"Bulk delete Smartblocks","description":"Deletes mulitple Smartblocks at once.","operationId":"smartblocks_bulk_delete","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"slugs","in":"path","description":"Smartblock slug(s), comma delimited list of slugs","required":true,"style":"simple","schema":{"type":"array","items":{"minLength":1,"type":"string","example":"wddaq4t"}}}],"responses":{"204":{"description":"No response body"},"403":{"$ref":"#/components/responses/ForbiddenResponse"}}}},"/{website_id}/smartblocks/{smartblock_slug}/clone/":{"post":{"tags":["Bulk operations"],"summary":"Clone Smartblock","description":"Clones a Smartblock.","operationId":"smartblocks_clone","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"smartblock_slug","in":"path","required":true,"schema":{"minLength":1,"type":"string","description":"The Smartblocks slug/unique id"}}],"responses":{"200":{"description":"The result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_1"}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenResponse"}}}}},"components":{"schemas":{"active":{"type":"object","properties":{"active":{"type":"boolean","description":"Indicates whether the Smartblock is active or not","default":true}}},"TableNotFound":{"type":"object","properties":{"reason":{"type":"string","enum":["table not found"]}}},"ChannelNotFound":{"type":"object","properties":{"reason":{"type":"string","enum":["channel not found"]}}},"PostSortOrderEnum":{"type":"string","description":"* `asc` - desc","enum":["asc","desc"]},"ReviewTypeEnum":{"type":"string","description":"* `product` - product\n* `service` - service","enum":["product","service"]},"SortOrderEnum":{"type":"string","description":"* `asc` - desc","enum":["asc","desc"]},"absolute_expiry_date":{"type":"object","properties":{"absolute_expiry_date":{"type":"string","description":"The absolute expiry date for the coupon","format":"date-time","example":"2018-06-05T16:57:40Z"}}},"action_button_background_color":{"type":"object","properties":{"action_button_background_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"The HTML color code to use for the action button background"}}},"action_button_color":{"type":"object","properties":{"action_button_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"The HTML color code to use for the action button text"}}},"action_button_content":{"type":"object","properties":{"action_button_content":{"type":"string","description":"Text to display on the action (CTA) button","example":"Buy now"}}},"allowed_merges":{"type":"object","properties":{"allowed_merges":{"maxLength":500,"type":"string","description":"Comma-separated list of fields that you want to allow in the slot query string. For example to pass through the parameter *myref*, enter *myref* here and ensure the slot URL query string has the value you want to merge e.g. `?myref=abcd`. Merge this value into the layout using `{{merges.myref}}`.  Note: Unmetered smartblocks can only contain the merges: cat, sbr, lang, curr'","example":"myref"}}},"background_color":{"type":"object","properties":{"background_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"The HTML color code to use for the banner background"}}},"background_repeat":{"type":"object","properties":{"background_repeat":{"type":"boolean","description":"Enable if the background image is a texture or other repeating image.","default":false}}},"blockType":{"type":"object","properties":{"type":{"type":"string","description":"* `product` - product\n* `countdown` - countdown\n* `instagram` - instagram\n* `banner` - banner\n* `coupon` - coupon\n* `pinterest` - pinterest\n* `webcrop` - webcrop\n* `reviews` - reviews\n* `popover` - popover","enum":["product","countdown","instagram","banner","coupon","pinterest","webcrop","reviews","popover"]}}},"border_color":{"type":"object","properties":{"border_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the dashed cutout pattern around the coupon block"}}},"campaign_code":{"type":"object","properties":{"campaign_code":{"maxLength":5000,"type":"string","description":"Campaign code (utm_campaign) added to the query collection of the URL, when your shopper clicks on this SmartBlock"}}},"campaign_expired_content":{"type":"object","properties":{"campaign_expired_content":{"type":"string","description":"The text that shows when the coupon campaign has ended","default":"Sorry, the offer has ended."}}},"caption_bg_color":{"type":"object","properties":{"caption_bg_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Background color of the caption"}}},"caption_color":{"type":"object","properties":{"caption_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the caption"}}},"caption_font":{"type":"object","properties":{"caption_font":{"type":"string","description":"The font family to use for the caption","example":"Roboto","default":"Arial"}}},"caption_size":{"type":"object","properties":{"caption_size":{"type":"string","description":"The CSS size to use for the caption text","example":"12pt"}}},"countdown_expiry":{"type":"object","properties":{"countdown_expiry":{"maximum":100000,"minimum":1,"type":"integer","description":"The coupon will be displayed to the user for this many hours after first open time. After that, your alternative text will be displayed.","example":168}}},"coupon_code_background_color":{"type":"object","properties":{"coupon_code_background_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Coupon code background color"}}},"coupon_code_color":{"type":"object","properties":{"coupon_code_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Coupon code text color"}}},"coupon_expired_content":{"type":"object","properties":{"coupon_expired_content":{"type":"string","description":"The text that shows when the coupon has expired","default":"Sorry, the coupon has expired."}}},"coupon_expiry_content":{"type":"object","properties":{"coupon_expired_content":{"type":"string","description":"The message to display once the coupon has expired","default":"Sorry, the coupon has expired."}}},"coupon_message_color":{"type":"object","properties":{"coupon_message_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the dashed cutout pattern around the coupon block"}}},"coupon_message_content":{"type":"object","properties":{"coupon_message_content":{"type":"string","description":"The text that precedes the coupon expiry text","default":"Expires: "}}},"coupon_out_of_stock_content":{"type":"object","properties":{"coupon_out_of_stock_content":{"type":"string","description":"The text that shows if the coupon is out of stock","default":"Sorry, the coupon is not available any more."}}},"crowd_source_window":{"type":"object","properties":{"crowd_source_window":{"maximum":720,"minimum":1,"type":"integer"}}},"data_sources":{"type":"object","properties":{"data_sources":{"type":"array","description":"A list of data sources for the Smartblock to use","items":{"type":"string","description":"* `/products/recommended/after/prids/history/` - PEOPLE_LIKE_YOU_BUY * `/products/recommended/with/prids/` - PURCHASED_TOGETHER * `/products/recommended/after/prids/` - AFTER_VIEWING_THIS_PEOPLE_BUY * `/products/personalised/browsed/` - PERSONAL_FREQUENTLY_BROWSED_DYNAMIC  * `/products/personalised/carted/` - PERSONAL_FREQUENTLY_CARTED_DYNAMIC  * `/products/personalised/abandoned/` - PERSONAL_FREQUENTLY_ABANDONED_DYNAMIC  * `/products/personalised/purchased/` - PERSONAL_FREQUENTLY_PURCHASED_DYNAMIC  * `/products/personalised/custom/` - PERSONAL_FREQUENTLY_IN_CUSTOM_SIGNALS * `/products/personalised/targeted/` - PERSONAL_PRICE_STOCK_CHANGE * `/cart/current/` - CURRENT_CART * `/cart/purchased/` - LAST_PURCHASE * `/cart/abandoned/` - MOST_RECENT_ABANDONED_CART * `/wishlist/` - WISHLIST * `/products/trending/browsed/` - FREQUENTLY_BROWSED * `/products/trending/carted/` - FREQUENTLY_CARTED * `/products/trending/abandoned/` - FREQUENTLY_ABANDONED * `/products/trending/purchased/` - FREQUENTLY_PURCHASED * `/products/impulse/` - IMPULSE_BUYS * `/products/new/` - NEW_PRODUCTS * `/products/all/` - ALL_PRODUCTS * `/products/by_id/` - FIXED_IDS","example":"/products/trending/browsed/","enum":["/products/recommended/after/prids/history/","/products/recommended/with/prids/","/products/recommended/after/prids/","/products/personalised/browsed/","/products/personalised/carted/","/products/personalised/abandoned/","/products/personalised/purchased/","/products/personalised/custom/","/products/personalised/targeted/","/cart/current/","/cart/purchased/","/cart/abandoned/","/wishlist/","/products/trending/browsed/","/products/trending/carted/","/products/trending/abandoned/","/products/trending/purchased/","/products/impulse/","/products/new/","/products/all/","/products/by_id/"]}}}},"description_font":{"type":"object","properties":{"description_font":{"type":"string","description":"The font family to use for the description","example":"Roboto","default":"Arial"}}},"feed_url":{"type":"object","properties":{"feed_url":{"type":"string","description":"Optional product feed","example":"/%s/products/all/?"}}},"feed_json":{"type":"object","properties":{"feed_url":{"type":"object","additionalProperties":true,"description":"Optionally add filters to limit what is shown in your Recommendation SmartBlock","example":{"fbf0":true,"fineFilterControl":false,"datasources":["/products/recommended/after/prids/history/","/products/trending/purchased/"],"loadrelatedproducts":false,"oos":false,"dataSourcePriority":"person","k":"54tcpsn","m":3,"fbf2":true,"filters":[],"fbf1":true,"globalDedupe":false,"fbmi":3,"fbmo":"backfill","currentproductdata":false}}}},"filters":{"type":"object","properties":{"filters":{"type":"array","description":"Filters to apply","items":{"$ref":"#/components/schemas/filters_filters"}}}},"folder_id":{"type":"object","properties":{"folder_id":{"type":"string","description":"The folder id this Smartblock belongs to, if any","nullable":true}}},"geo_full_details":{"type":"object","properties":{"geo_full_details":{"type":"boolean","description":"Enable to load all data on locations associated with shown products for use in SmartBlock customization.","default":false}}},"geo_ip":{"type":"object","properties":{"geo_ip":{"type":"boolean","description":"Attempt to estimate the users location based on their IP address. Note that if `Imported Person Location` is selected as the preferred source on the location settings page, this will be prioritised over their IP address.","default":false}}},"gradient_color_left":{"type":"object","properties":{"gradient_color_left":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the first stripe"}}},"gradient_color_right":{"type":"object","properties":{"gradient_color_right":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the second stripe"}}},"hashtag":{"type":"object","properties":{"hashtag":{"type":"string","description":"Twitter/X: Filter tweets made by the twitter id account, to only those containing this hashtag"}}},"headline_align":{"type":"object","properties":{"headline_align":{"type":"string","description":"The text alignment for the headline","enum":["left","right","center","justify","inherit"],"default":"inherit"}}},"headline_color":{"type":"object","properties":{"headline_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"The HTML color code to use for the headline text"}}},"headline_font":{"type":"object","properties":{"headline_font":{"type":"string","description":"Web font family to use for the headline","example":"Roboto"}}},"headline_horizontal_offset":{"type":"object","properties":{"headline_horizontal_offset":{"type":"string","description":"Headlines horizontal offset","example":"10","default":"0"}}},"headline_size":{"type":"object","properties":{"headline_size":{"type":"string","description":"The size of the headline font","default":"32"}}},"headline_text":{"type":"object","properties":{"headline_text":{"type":"string","description":"Text to display for the headline of the Smartblock","example":"Sale now on"}}},"headline_vertical_offset":{"type":"object","properties":{"headline_vertical_offset":{"type":"string","description":"Headlines vertical offset (positive is upwards)","example":"-10","default":"0"}}},"height":{"type":"object","properties":{"height":{"type":"string","description":"Height of the banner","example":"70px"}}},"icon_colour":{"type":"object","properties":{"icon_colour":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"The HTML color code to use for the icon"}}},"image_border_radius":{"type":"object","properties":{"image_border_radius":{"type":"string","description":"The image border radius","default":"15"}}},"image_format":{"type":"object","properties":{"image_format":{"type":"string","description":"The format the image is in","enum":["PNG","JPG"]}}},"individual_review_score_color":{"type":"object","properties":{"individual_review_score_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Review score font color"}}},"individual_review_score_font":{"type":"object","properties":{"individual_review_score_font":{"type":"string","description":"The font family to use for the review","default":"Roboto"}}},"individual_review_score_size":{"type":"object","properties":{"individual_review_score_size":{"type":"integer","description":"The size to use for the score text","example":25}}},"instagram_id":{"type":"object","properties":{"instagram_id":{"type":"string","description":"Instagram Username for the feed you want to show","example":"frelevance"}}},"item_count":{"type":"object","properties":{"item_count":{"minimum":1,"type":"integer","description":"Number of items to display","default":4}}},"left":{"type":"object","properties":{"left":{"type":"integer","description":"Left offset in pixels"}}},"location_set_id":{"type":"object","properties":{"location_set_id":{"type":"string","description":"Find the closest location in this location set. Note:\n* Requires \"Geocode by IP\" and \"Personalised\" to be enabled\n* If used in conjunction with radius this method will take precedence"}}},"location_set_radius":{"type":"object","properties":{"location_set_radius":{"minimum":0,"type":"integer","description":"Find the closest location within this radius in km","example":10}}},"locked":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether the Smartblock is locked to read-only","example":false}}},"max_stars":{"type":"object","properties":{"max_stars":{"maximum":10,"minimum":1,"type":"integer","description":"The maximum number of stars a reviewer can give a product","default":5}}},"medium":{"type":"object","properties":{"medium":{"maxLength":100,"type":"string","description":"Tracking medium (utm_medium) added to the query collection of the URL, when your shopper clicks on this SmartBlock"}}},"message_align":{"type":"object","properties":{"message_align":{"type":"string","description":"Alignment of main message text","enum":["inherit","left","center","right"],"default":"left"}}},"message_background_color":{"type":"object","properties":{"message_background_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Background color of the message"}}},"message_color":{"type":"object","properties":{"message_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"The HTML color code to use for the message text"}}},"message_font":{"type":"object","properties":{"message_font":{"type":"string","description":"Web font family to use for the message text","example":"Roboto"}}},"message_horizontal_offset":{"type":"object","properties":{"message_horizontal_offset":{"type":"string","description":"Messages horizontal offset","example":"10","default":"0"}}},"message_size":{"type":"object","properties":{"message_size":{"type":"string","description":"The font size of the message text","default":"15px"}}},"message_text":{"type":"object","properties":{"message_text":{"type":"string","description":"The message to display","example":"To celebrate our 10th anniversary, we are having a flash sale on a selected range of products."}}},"message_vertical_offset":{"type":"object","properties":{"message_vertical_offset":{"type":"string","description":"Messages vertical offset (positive is upwards)","example":"-10","default":"0"}}},"number_of_columns":{"type":"object","properties":{"number_of_columns":{"maximum":10,"minimum":1,"type":"integer","description":"Number of columns to show","default":3}}},"pin_bg_color":{"type":"object","properties":{"pin_bg_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Pin background color"}}},"pinterest_board":{"type":"object","properties":{"pinterest_board":{"type":"string","description":"Name of the Pinterest Board you want to display pins from (lower case and separated by hyphens)","example":"tech-products"}}},"pinterest_id":{"type":"object","properties":{"pinterest_id":{"type":"string","description":"The name of the pinner","example":"cartcontents"}}},"post_sort_by":{"type":"object","properties":{"post_sort_by":{"type":"string","description":"Field to sort within the results"}}},"post_sort_order":{"$ref":"#/components/schemas/PostSortOrderEnum"},"primary_background_color":{"type":"object","properties":{"primary_background_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the coupon background"}}},"redirect_url":{"type":"object","properties":{"redirect_url":{"type":"string","description":"Twitter/X: Redirect to this URL when somebody clicks on the Twitter feed. (Supports personalization). Defaults to the twitter page"}}},"review_author_font_color":{"type":"object","properties":{"review_author_font_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Review author font color"}}},"review_author_font_family":{"type":"object","properties":{"review_author_font_family":{"type":"string","description":"The font family to use for the review author","default":"Roboto"}}},"review_author_font_size":{"type":"object","properties":{"review_author_font_size":{"type":"integer","description":"The size to use for the review author","example":14}}},"review_date_font_color":{"type":"object","properties":{"review_date_font_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Review date font color"}}},"review_date_font_family":{"type":"object","properties":{"review_date_font_family":{"type":"string","description":"The font family to use for the review date","default":"Roboto"}}},"review_date_font_size":{"type":"object","properties":{"review_date_font_size":{"type":"integer","description":"The size to use for the review date","example":14}}},"review_score_background_color":{"type":"object","properties":{"review_score_background_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Review score background color"}}},"review_sub_score_font_color":{"type":"object","properties":{"review_sub_score_font_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Review sub score font color"}}},"review_sub_score_font_family":{"type":"object","properties":{"review_sub_score_font_family":{"type":"string","description":"The font family to use for the review sub score","default":"Roboto"}}},"review_type":{"$ref":"#/components/schemas/ReviewTypeEnum"},"ribbon_background_color":{"type":"object","properties":{"ribbon_background_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the ribbon background"}}},"ribbon_color":{"type":"object","properties":{"ribbon_color":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"Color of the ribbon text"}}},"selector":{"type":"object","properties":{"selector":{"type":"string","description":"The selector"}}},"show_caption":{"type":"object","properties":{"show_caption":{"type":"boolean","description":"Display the caption associated with the item.","default":true}}},"shuffle":{"type":"object","properties":{"shuffle":{"type":"boolean","description":"Return a random selection of posts to display. The selection will be different each time the block is generated.","default":true}}},"smartBlockCommon":{"allOf":[{"$ref":"#/components/schemas/active"},{"required":["name"],"type":"object","properties":{"background_image_url":{"type":"string","description":"Image to display in the Smartblocks background","format":"url","example":"www.example.come/this_is_an_example_image.png"},"layout":{"type":"string","description":"The layout for this SmartBlock"},"layout_id":{"maxLength":256,"type":"string"},"name":{"maxLength":256,"minLength":1,"type":"string","description":"Unique name for the Smartblock","example":"Summer sale"},"personalised":{"type":"boolean","description":"Enable personalised Dynamic SmartBlock.  Dynamic SmartBlocks can use all available data about an individual, and are cached separately for each person; non-Dynamic SmartBlocks are the same for everyone.","default":true}}}]},"sort_by":{"type":"object","properties":{"sort_by":{"type":"string","description":"Field to sort within the results"}}},"sort_order":{"$ref":"#/components/schemas/SortOrderEnum"},"source":{"type":"object","properties":{"source":{"maxLength":100,"type":"string","description":"Campaign source (utm_source) added to the query collection of the URL, when your shopper clicks on this SmartBlock"}}},"steps":{"type":"object","properties":{"steps":{"type":"array","description":"Steps for the countdown campaign","items":{"$ref":"#/components/schemas/steps_steps"}}}},"styles":{"type":"object","properties":{"styles":{"type":"string","description":"Additional CSS styles"}}},"tags":{"type":"object","properties":{"tags":{"type":"string","description":"Comma seperated SmartBlock tags, so you can find your smartblocks later","example":"2024 06,Joan Smith,summer sale"}}},"top":{"type":"object","properties":{"top":{"minimum":0,"type":"integer","description":"Top offset in pixels"}}},"truncate_review":{"type":"object","properties":{"truncate_review":{"minimum":1,"type":"integer","description":"Truncate reviews longer than the specified number of characters (leave blank to always show full text)"}}},"url":{"properties":{"url":{"type":"string","description":"URL to import, requires the protocol (HTTP or HTPPS)","example":"https://www.freshrelevance.com"}}},"viewport":{"type":"object","properties":{"viewport":{"type":"string","description":"The viewport","default":"None"}}},"weather_day":{"type":"object","properties":{"weather_day":{"type":"string","description":"Day to show weather for","enum":["plus0days","plus1days","plus2days","plus3days","plus4days"],"default":"plus1days"}}},"webcrop_height":{"type":"object","properties":{"webcrop_height":{"minimum":1,"type":"integer","description":"The height in pixels to crop in web view (defaults to full height)"}}},"webcrop_width":{"type":"object","properties":{"webcrop_width":{"minimum":1,"type":"integer","description":"The width in pixels to crop in web view (defaults to full width)"}}},"width":{"type":"object","properties":{"width":{"type":"string","description":"The width of the banner","example":"570px"}}},"Smartblock":{"allOf":[{"required":["dt","folder_id","last_edited_by","layout","locked","name","personalised","preview_url","slug","tags","thumbnail_url","type"]},{"type":"object","properties":{"slug":{"minLength":1,"type":"string","description":"The unique id for the Smartblock","example":"e0za0b9"},"dt":{"type":"string","description":"Last modified date time in ISO-8601 format","format":"date-time"},"last_edited_by":{"type":"string","description":"Who last edited the Smartblock","example":"Joe Bloggs"},"preview_url":{"type":"string","description":"A link to preview the Smartblock as an image","format":"url"},"thumbnail_url":{"type":"string","description":"A link to the Smartblock's thumbnail image","format":"url"}}},{"$ref":"#/components/schemas/locked"},{"$ref":"#/components/schemas/smartBlockCommon"},{"$ref":"#/components/schemas/blockType"},{"$ref":"#/components/schemas/folder_id"},{"$ref":"#/components/schemas/tags"},{"$ref":"#/components/schemas/crowd_source_window"}]},"Product_Smartblock":{"example":{"$ref":"#/components/examples/ProductRecommendationsCrowdSrc"},"allOf":[{"type":"object","additionalProperties":true},{"description":"Product Recommendations Smartblock"},{"required":["active","data_sources","filters","item_count","layout_id","personalised","tags","type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["product"]}}},{"$ref":"#/components/schemas/feed_url"},{"$ref":"#/components/schemas/feed_json"},{"$ref":"#/components/schemas/filters"},{"$ref":"#/components/schemas/campaign_code"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/medium"},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/geo_ip"},{"$ref":"#/components/schemas/geo_full_details"},{"$ref":"#/components/schemas/location_set_id"},{"$ref":"#/components/schemas/location_set_radius"},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/tags"},{"$ref":"#/components/schemas/item_count"},{"$ref":"#/components/schemas/data_sources"},{"$ref":"#/components/schemas/headline_text"},{"$ref":"#/components/schemas/headline_align"},{"$ref":"#/components/schemas/headline_font"},{"$ref":"#/components/schemas/headline_color"},{"$ref":"#/components/schemas/headline_size"},{"$ref":"#/components/schemas/headline_horizontal_offset"},{"$ref":"#/components/schemas/headline_vertical_offset"},{"$ref":"#/components/schemas/crowd_source_window"}]},"Banner_Smartblock":{"example":{"$ref":"#/components/examples/BannerCreateExample"},"allOf":[{"type":"object","additionalProperties":true},{"description":"Banner Smartblock"},{"required":["action_button_content","background_image_url","headline_text","message_text","redirect_url","type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["banner"]}}},{"$ref":"#/components/schemas/action_button_background_color"},{"$ref":"#/components/schemas/action_button_color"},{"$ref":"#/components/schemas/action_button_content"},{"$ref":"#/components/schemas/background_color"},{"$ref":"#/components/schemas/background_repeat"},{"$ref":"#/components/schemas/campaign_code"},{"$ref":"#/components/schemas/geo_ip"},{"$ref":"#/components/schemas/geo_full_details"},{"$ref":"#/components/schemas/location_set_id"},{"$ref":"#/components/schemas/location_set_radius"},{"$ref":"#/components/schemas/headline_align"},{"$ref":"#/components/schemas/headline_color"},{"$ref":"#/components/schemas/headline_font"},{"$ref":"#/components/schemas/headline_horizontal_offset"},{"$ref":"#/components/schemas/headline_size"},{"$ref":"#/components/schemas/headline_text"},{"$ref":"#/components/schemas/headline_vertical_offset"},{"$ref":"#/components/schemas/height"},{"$ref":"#/components/schemas/icon_colour"},{"$ref":"#/components/schemas/medium"},{"$ref":"#/components/schemas/message_text"},{"$ref":"#/components/schemas/message_align"},{"$ref":"#/components/schemas/message_color"},{"$ref":"#/components/schemas/message_font"},{"$ref":"#/components/schemas/message_size"},{"$ref":"#/components/schemas/message_horizontal_offset"},{"$ref":"#/components/schemas/message_vertical_offset"},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/styles"},{"$ref":"#/components/schemas/tags"},{"$ref":"#/components/schemas/weather_day"},{"$ref":"#/components/schemas/width"}]},"Countdown_Smartblock":{"example":{"$ref":"#/components/examples/CountdownCreateExample"},"allOf":[{"type":"object","additionalProperties":true},{"description":"Countdown Smartblock"},{"required":["active","personalised","type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["countdown"]}}},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/medium"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/steps"},{"$ref":"#/components/schemas/tags"}]},"Instagram_Smartblock":{"example":{"$ref":"#/components/examples/InstagramCreateExample"},"allOf":[{"type":"object","additionalProperties":true},{"description":"Instagram Smartblock"},{"required":["instagram_id","layout","redirect_url","type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["instagram"]},"show_video_thumbnails":{"type":"string","description":"Video thumbnails option\n* 'all' - Image and Video thumbnails\n* 'img' - Image thumbnails only\n* 'video' - Video thumbnails only","enum":["all","img","video"]}}},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/hashtag"},{"$ref":"#/components/schemas/instagram_id"},{"$ref":"#/components/schemas/number_of_columns"},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/shuffle"},{"$ref":"#/components/schemas/medium"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/campaign_code"},{"$ref":"#/components/schemas/item_count"},{"$ref":"#/components/schemas/tags"}]},"Coupon_Smartblock":{"example":{"$ref":"#/components/examples/CouponCreateExample"},"allOf":[{"type":"object","additionalProperties":true},{"description":"Coupon Smartblock"},{"required":["type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["coupon"]}}},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/campaign_code"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/medium"},{"$ref":"#/components/schemas/countdown_expiry"},{"$ref":"#/components/schemas/absolute_expiry_date"},{"$ref":"#/components/schemas/tags"},{"$ref":"#/components/schemas/coupon_code_background_color"},{"$ref":"#/components/schemas/coupon_code_color"},{"$ref":"#/components/schemas/coupon_expired_content"},{"$ref":"#/components/schemas/coupon_expiry_content"},{"$ref":"#/components/schemas/coupon_message_color"},{"$ref":"#/components/schemas/coupon_message_content"},{"$ref":"#/components/schemas/coupon_out_of_stock_content"},{"$ref":"#/components/schemas/primary_background_color"},{"$ref":"#/components/schemas/headline_color"},{"$ref":"#/components/schemas/border_color"},{"$ref":"#/components/schemas/campaign_expired_content"},{"$ref":"#/components/schemas/ribbon_color"},{"$ref":"#/components/schemas/ribbon_background_color"},{"$ref":"#/components/schemas/gradient_color_left"},{"$ref":"#/components/schemas/gradient_color_right"}]},"Pinterest_Smartblock":{"example":{"$ref":"#/components/examples/PinterestCreateExample"},"allOf":[{"type":"object","additionalProperties":true},{"description":"Pinterest Smartblock"},{"required":["active","item_count","personalised","pinterest_board","pinterest_id","redirect_url","type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["pinterest"]}}},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/pinterest_board"},{"$ref":"#/components/schemas/pinterest_id"},{"$ref":"#/components/schemas/item_count"},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/caption_color"},{"$ref":"#/components/schemas/caption_font"},{"$ref":"#/components/schemas/caption_size"},{"$ref":"#/components/schemas/caption_bg_color"},{"$ref":"#/components/schemas/message_background_color"},{"$ref":"#/components/schemas/message_color"},{"$ref":"#/components/schemas/message_font"},{"$ref":"#/components/schemas/message_size"},{"$ref":"#/components/schemas/description_font"},{"$ref":"#/components/schemas/number_of_columns"},{"$ref":"#/components/schemas/pin_bg_color"},{"$ref":"#/components/schemas/image_border_radius"},{"$ref":"#/components/schemas/shuffle"},{"$ref":"#/components/schemas/show_caption"},{"$ref":"#/components/schemas/medium"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/campaign_code"}]},"Webcrop_Smartblock":{"example":[{"$ref":"#/components/examples/WebcropCreateExample"}],"allOf":[{"type":"object","additionalProperties":true},{"description":"Webcrop Smartblock"},{"required":["active","personalised","redirect_url","type","url"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["webcrop"]}}},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/url"},{"$ref":"#/components/schemas/webcrop_height"},{"$ref":"#/components/schemas/webcrop_width"},{"$ref":"#/components/schemas/image_format"},{"$ref":"#/components/schemas/top"},{"$ref":"#/components/schemas/left"},{"$ref":"#/components/schemas/selector"},{"$ref":"#/components/schemas/viewport"},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/campaign_code"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/medium"}]},"Reviews_Smartblock":{"example":[{"$ref":"#/components/examples/ReviewsCreateExample"}],"allOf":[{"type":"object","additionalProperties":true},{"description":"Review Smartblock"},{"required":["active","data_sources","filters","personalised","redirect_url","type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["reviews"]}}},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/data_sources"},{"$ref":"#/components/schemas/filters"},{"$ref":"#/components/schemas/item_count"},{"$ref":"#/components/schemas/max_stars"},{"$ref":"#/components/schemas/ReviewTypeEnum"},{"$ref":"#/components/schemas/truncate_review"},{"$ref":"#/components/schemas/individual_review_score_color"},{"$ref":"#/components/schemas/individual_review_score_font"},{"$ref":"#/components/schemas/individual_review_score_size"},{"$ref":"#/components/schemas/review_author_font_color"},{"$ref":"#/components/schemas/review_author_font_family"},{"$ref":"#/components/schemas/review_author_font_size"},{"$ref":"#/components/schemas/review_date_font_color"},{"$ref":"#/components/schemas/review_date_font_family"},{"$ref":"#/components/schemas/review_date_font_size"},{"$ref":"#/components/schemas/review_sub_score_font_color"},{"$ref":"#/components/schemas/review_sub_score_font_family"},{"$ref":"#/components/schemas/review_score_background_color"},{"$ref":"#/components/schemas/post_sort_by"},{"$ref":"#/components/schemas/PostSortOrderEnum"},{"$ref":"#/components/schemas/sort_by"},{"$ref":"#/components/schemas/SortOrderEnum"},{"$ref":"#/components/schemas/shuffle"},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/campaign_code"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/medium"}]},"Popover_Smartblock":{"example":[{"$ref":"#/components/examples/PopoverCreateExample"}],"allOf":[{"type":"object","additionalProperties":true},{"description":"Popover Smartblock"},{"required":["active","personalised","type"]},{"$ref":"#/components/schemas/smartBlockCommon"},{"type":"object","properties":{"type":{"type":"string","description":"The type of Smartblock","enum":["popover"]},"popup_expiry":{"type":"integer","description":"Minimum time between pop-ups (in days)","default":90},"popup_min_time":{"type":"integer","description":"Minimum time before showing pop-up (in seconds)","default":1},"popup_show_after":{"type":"integer","description":"Show pop-up after fixed time period (in seconds)","default":30},"popup_exit_intent":{"type":"boolean","description":"Show on exit intent","default":true},"popup_display_delay":{"type":"integer","description":"Delay before exit intent pop-up appears (in milliseconds)","default":250},"popup_always_show":{"type":"boolean","description":"Show every time the page is loaded","default":false},"supportsReviews":{"type":"boolean","description":"Modified template contains support for reviews","default":false},"byReference":{"type":"boolean","description":"Reference the original template","default":false},"supportsSocialProof":{"type":"boolean","description":"Modified template contains support for social proof","default":false},"supportsRetina":{"type":"boolean","description":"Modified template contains support for retina","default":false},"defaultSocialProofOptions":{"type":"boolean","description":"Use default social proof options","default":false},"defaultReviewOptions":{"type":"boolean","description":"Use default review options","default":false},"blockedTactics":{"type":"array","description":"List of blocked tactics","example":["banner_content"],"items":{"type":"string"}},"placementFilter":{"minItems":1,"type":"array","description":"List of devices this can be placed","example":["web"],"items":{"type":"string","enum":["web","email","app"]}},"blockedContexts":{"type":"array","description":"A list of blocked contexts","items":{"type":"string","description":"An explanation about the purpose of this instance."}},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Popover_Smartblock_sections"}},"sortOrder":{"type":"integer","description":"The relative sort order position","example":10},"thumbnailURL":{"type":"string","description":"Full URL with protocol (HTTP or HTTPS) to a thumbnail image","example":"https://via.example.com/140x100"},"hoverText":{"type":"string","description":"Text to display when hovered over","example":"Something about this item"},"groupHoverText":{"type":"string","description":"Text to display when the group is hovered over","example":"Something else about this group"},"groupText":{"type":"string","description":"Text to display for the group","example":"About this group"},"implemented":{"type":"boolean","description":"Implemeted?","example":true}}},{"$ref":"#/components/schemas/allowed_merges"},{"$ref":"#/components/schemas/redirect_url"},{"$ref":"#/components/schemas/campaign_code"},{"$ref":"#/components/schemas/source"},{"$ref":"#/components/schemas/medium"},{"$ref":"#/components/schemas/tags"}]},"PaginatedData":{"required":["count","links","page","total"],"type":"object","properties":{"page":{"minimum":1,"type":"integer","description":"The index for the page of data returned.","example":1},"count":{"minimum":0,"type":"integer","description":"Number of records in the page.","example":12},"total":{"minimum":0,"type":"integer","description":"Total number of records in the set.","example":12},"links":{"$ref":"#/components/schemas/PaginatedData_links"}},"description":"Data page and pagination links"},"SmartblockNotFoundContent":{"type":"array","example":["No Smartblock Found"],"items":{"type":"string","enum":["No Smartblock Found"]}},"inline_response_200":{"allOf":[{"$ref":"#/components/schemas/PaginatedData"},{"required":["results"],"properties":{"results":{"oneOf":[{"type":"array","description":"The Smartblocks","items":{"$ref":"#/components/schemas/Smartblock"}},{"minItems":1,"type":"array","description":"Smartblocks type counts","items":{"type":"object","additionalProperties":{"minimum":0,"type":"integer"},"description":"Smartblock type count"}}]}},"description":"The Smartblocks for the website"}]},"website_id_smartblocks_body":{"oneOf":[{"$ref":"#/components/schemas/Banner_Smartblock"},{"$ref":"#/components/schemas/Countdown_Smartblock"},{"$ref":"#/components/schemas/Instagram_Smartblock"},{"$ref":"#/components/schemas/Product_Smartblock"},{"$ref":"#/components/schemas/Coupon_Smartblock"},{"$ref":"#/components/schemas/Pinterest_Smartblock"},{"$ref":"#/components/schemas/Webcrop_Smartblock"},{"$ref":"#/components/schemas/Reviews_Smartblock"},{"$ref":"#/components/schemas/Popover_Smartblock"}]},"inline_response_200_1":{"oneOf":[{"$ref":"#/components/schemas/Smartblock"},{"$ref":"#/components/schemas/SmartblockNotFoundContent"}]},"slugs_bulk_body":{"allOf":[{"description":"The properties to update on all blocks"},{"$ref":"#/components/schemas/active"},{"$ref":"#/components/schemas/locked"},{"$ref":"#/components/schemas/folder_id"}]},"inline_response_200_2":{"required":["errors","ok","results"],"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates if the call was successful or not.","example":true},"errors":{"type":"array","description":"Any error messages returned.","items":{"type":"string"}},"results":{"type":"array","description":"The updated details.","items":{"$ref":"#/components/schemas/Smartblock"}}}},"filters_filters":{"required":["field","op"],"type":"object","properties":{"applies":{"type":"array","description":"Which `date_sources` the filter applies to using the same ordering in the array for correlation, defaults to all date sources.","items":{"type":"boolean"}},"field":{"type":"string","description":"The field to filter against"},"op":{"type":"string","description":"Filter operator * `in` - is one of * `nin` - is not one of * `all` - is in all of * `pridin` - product id is one of * `pridnin - product id is not one of * `lastBrowseFilter` - from the Last Product Browsed (metered only) * `lastCartFilter` - from the Last Cart (metered only) * `lastPurchaseFilter` - from the Last Purchase (metered only) * `locationin` - location is one of * `locationnin` - location is not one of * `catin` - has one of these tag values (categories) * `catnin` - has none of these tag values (categories) * `catall` - has all of these tag values (categories) * `exists` - image variant exists * `eq` - equals a single value * `ne` - not equal to a single value * `cont` - contains * `ncont` - does not contain * `text` - matches this text * `streq` - equals a single value using string comparison * `strne` - does not equal a single value using string comparison * `lt` - is less than a single numeric value * `lte` - is less than or equal to a single numeric value * `gt` - is greater than a single numeric value * `gte` - is greater than or equal to a single numeric value * `range` - is between * `nrange` - is not between * `exists` - exists * `bool` - boolean match * `dteq` - date equals * `dtne` - date does not equal * `dtlt` - date is before * `dtgt` - date is after * `bis` - out of stock when browsed * `days` - reviewed within X days * `weeks` - reviewed within X weeks * `within` - APV is within value * `within_perc` - APV is within percentage","enum":["in","nin","all","pridin","pridnin","lastBrowseFilter","lastCartFilter","lastPurchaseFilter","locationin","locationnin","catin","catnin","catall","exists","eq","ne","cont","ncont","text","streq","strne","lt","lte","gt","gte","range","nrange","bool","dteq","dtne","dtlt","dtgt","days","weeks","within","within_perc"]},"val":{"description":"Value to use with the operation","oneOf":[{"type":"string"},{"type":"string","format":"date-time"},{"type":"number"},{"type":"array","items":{"type":"integer"}},{"type":"array","items":{"type":"string"}}]}}},"steps_steps":{"type":"object","properties":{"animated":{"type":"boolean","description":"Turn the Countdown into an animated GIF (email) or enable JavaScript count down (web). Note that in email only the seconds will animate","example":false},"font":{"type":"string","description":"The font family to use for the text","example":"Arial"},"fontColor":{"pattern":"^#[0-9a-f]{6}$","type":"string","description":"The HTML color code to use for the text"},"fontSize":{"type":"integer","description":"The size of the font","example":40},"secondsImage":{"type":"string","description":"The image to render the seconds with:\n* \"flipboard_withtext.gif\" - \"Flipboard\"\n* \"flipboard.gif\" - \"Flipboard (No layout text)\"\n* \"square_blue.gif\" - \"Square - Blue Background\"\n* \"square_blue_notext.gif\" - \"Square - Blue Background (No layout text)\"\n* \"square_white.gif\" - \"Square - White\"\n* \"square_white_notext.gif\" - \"Square - White (No layout text)\"\n* \"square_white_captioned.gif\" - \"Square - White (Captioned)\"\n* \"square_white_captioned_notext.gif\" - \"Square - White (Captioned) (No layout text)\"\n* \"radial_blue_captioned_35px.gif\" - \"Radial - Blue\"\n* \"radial_blue_captioned_notext.gif\" - \"Radial - Blue (No layout text)\"\n* \"radial_blue.gif\" - \"Radial - Blue (No caption)\"\n* \"radial_brown_captioned_35px.gif\" - \"Radial - Brown\"\n* \"radial_brown_captioned_notext.gif\" - \"Radial - Brown (No layout text)\"\n* \"radial_brown.gif\" - \"Radial - Brown (No caption)\"\n* \"radial_green_captioned_35px.gif\" - \"Radial - Green\"\n* \"radial_green_captioned_notext.gif\" - \"Radial - Green (No layout text)\"\n* \"radial_green.gif\" - \"Radial - Green (No caption)\"\n* \"radial_red_captioned_35px.gif\" - \"Radial - Red\"\n* \"radial_red_captioned_notext.gif\" - \"Radial - Red (No layout text)\"\n* \"radial_red.gif\" - \"Radial - Red (No caption)\"\n* \"radial_dark_lime_captioned_35px.gif\" - \"Radial Dark - Lime\"\n* \"radial_dark_lime_captioned_notext.gif\" - \"Radial Dark - Lime (No layout text)\"\n* \"radial_dark_lime.gif\" - \"Radial Dark - Lime (No caption)\"\n* \"radial_dark_yellow_captioned_35px.gif\" - \"Radial Dark - Yellow\"\n* \"radial_dark_yellow_captioned_notext.gif\",  \"Radial Dark - Yellow (No layout text)\"\n* \"radial_dark_yellow.gif\" - \"Radial Dark - Yellow (No caption)\"\n* \"circle_blue.gif\" - \"Circle - Blue\"\n* \"circle_blue_notext.gif\" - \"Circle - Blue (No layout text)\"\n* \"digital_green.gif\" - \"Digital - Green\"\n* \"digital_green_notext.gif\" - \"Digital - Green (No layout text)\"\n* \"digital_red.gif\" - \"Digital - Red\"\n* \"digital_red_notext.gif\" - \"Digital - Red (No layout text)\" ","enum":["flipboard_withtext.gif","flipboard.gif","square_blue.gif","square_blue_notext.gif","square_white.gif","square_white_notext.gif","square_white_captioned.gif","square_white_captioned_notext.gif","radial_blue_captioned_35px.gif","radial_blue_captioned_notext.gif","radial_blue.gif","radial_brown_captioned_35px.gif","radial_brown_captioned_notext.gif","radial_brown.gif","radial_green_captioned_35px.gif","radial_green_captioned_notext.gif","radial_green.gif","radial_red_captioned_35px.gif","radial_red_captioned_notext.gif","radial_red.gif","radial_dark_lime_captioned_35px.gif","radial_dark_lime_captioned_notext.gif","radial_dark_lime.gif","radial_dark_yellow_captioned_35px.gif","radial_dark_yellow_captioned_notext.gif","radial_dark_yellow.gif","circle_blue.gif","circle_blue_notext.gif","digital_green.gif","digital_green_notext.gif","digital_red.gif","digital_red_notext.gif"]},"start":{"type":"string","description":"ISO 8601 UTC timestamp for when the step starts","format":"date-time"},"text":{"type":"string","description":"The text to display for this step","example":"Sorry, you missed the sale"},"url":{"type":"string","description":"The URL for the action button (no protocol)","example":"example.com/buyNow"},"utm_campaign":{"maxLength":5000,"type":"string","description":"Campaign code (utm_campaign) added to the query collection of the URL, when your shopper clicks on this SmartBlock"}},"description":"Countdown step"},"Popover_Smartblock_fields":{"required":["id","type"],"type":"object","properties":{"type":{"type":"string","enum":["text","boolean","number","numeric","font","color","multiple_color","select","image_url","dimension","columns","italics","bold","custom","font_size","url","location_set_extra","location_set_image","custom_signal","padding","dateTime","timezone"]},"id":{"type":"string"}},"additionalProperties":true},"Popover_Smartblock_sections":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Popover_Smartblock_fields"}}}},"PaginatedData_links":{"type":"object","properties":{"next":{"type":"string","description":"URL of the next page.","format":"url","nullable":true},"previous":{"type":"string","description":"URL of the previous page.","format":"url","nullable":true}},"description":"Page navigation links"}},"responses":{"TableNotFound":{"description":"`tableId` not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableNotFound"}}}},"ChannelNotFound":{"description":"`channelId` not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelNotFound"}}}},"TableOrChannelNotFound":{"description":"`tableId` or `channelId` not found.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TableNotFound"},{"$ref":"#/components/schemas/ChannelNotFound"}]},"example":{"reason":"tableId and/or channelId not found"}}}},"PaginationParameterError":{"description":"There was an issue with the pagination parameters: `page` and/or `limit`.","content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","enum":["page was not a valid integer","limit was not a valid integer"]}}}}}},"ForbiddenResponse":{"description":"Unauthorized / forbidden","content":{"application/json":{"schema":{"required":["detail"],"type":"object","properties":{"detail":{"type":"string","description":"Indicates why the call failed","example":"Authentication credentials were not provided."}}}}}},"ErrorResponse":{"description":"An error occurred","content":{"application/json":{"schema":{"required":["error","ok"],"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates the call failed","enum":[false]},"error":{"oneOf":[{"type":"string","description":"The reason the call errored","example":"Validation error. No folder bd8eciompb7y, unable to delete"},{"type":"object","additionalProperties":{"minItems":1,"type":"array","items":{"type":"string","example":"This field may not be null."}},"description":"Fields with issues and their errors"}]}}}}}},"SmartblockNotFound":{"description":"Smartblock not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartblockNotFoundContent"}}}}},"parameters":{"ChannelId":{"name":"channelId","in":"path","description":"The channel ID with it's unique hash.","required":true,"schema":{"type":"string"},"example":"CustomDataTableImport:2qk7xzb"},"TableIdParameter":{"name":"tableId","in":"path","description":"The ID of the table you want to access or modify.","required":true,"schema":{"type":"string"}},"Limit":{"name":"limit","in":"query","description":"The limit of the amount of results to display per page.","required":false,"schema":{"type":"integer","default":25}},"Page":{"name":"page","in":"query","description":"Which page of results you wish to return.","required":false,"schema":{"type":"integer","default":1}},"WebsiteId":{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},"FormatJson":{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},"SmartblockSlug":{"name":"smartblock_slug","in":"path","required":true,"schema":{"minLength":1,"type":"string","description":"The Smartblocks slug/unique id"}}},"examples":{"PopoverCreateExample":{"summary":"Popover","value":{"name":"Popover","placementFilter":["web"],"blockedContexts":[],"sortOrder":100,"type":"popover","hoverText":"Creates a popover Data Capture SmartBlock.","groupHoverText":"Appears after a pre-determined amount of time and/or when the site visitor expresses intent to exit.","implemented":true,"groupText":"Both of the above","options":{"layout":{"tactic":"popover","displayOnExitIntent":true,"popoverFixedDelay":30,"daysBetweenPopovers":90}}}},"WebcropCreateExample":{"summary":"Webcrop","value":{"name":"TEST WEBCROP SMARTBLOCK","type":"webcrop","redirect_url":"example.com/redirect","url":"http://www.google.com","height":10,"width":10,"imgformat":"JPG","top":0,"left":0,"selector":"css_selector","allowed_merges":"test, test, test","medium":"test_medium","source":"test_source","tags":["tag"],"personalised":true,"active":true}},"ProductRecommendationsBasic":{"summary":"Product recommendation using layout","value":{"name":"TEST PRODUCT RECOMMENDATION SMARTBLOCK","type":"product","redirect_url":"exampe.com/redirect","data_sources":[],"filters":[],"layout_id":"t:product_60:product_52","item_count":3,"tags":["tag"],"personalised":true,"active":true}},"ProductRecommendationsCrowdSrc":{"summary":"Product recommendation using with crowd source","value":{"name":"TEST PRODUCT RECOMMENDATION SMARTBLOCK","type":"product","redirect_url":"example.com/redirect","data_sources":[],"filters":[],"layout_id":"t:product_60:product_52","item_count":3,"tags":["tag"],"personalised":true,"active":true,"crowd_source_window":720}},"BannerCreateExample":{"summary":"Banner","value":{"name":"TEST BANNER SMARTBLOCK","type":"banner","redirect_url":"www.example.com/redirect","headline_text":"test headline","message_text":"This is a test message","background_image_url":"www.example.com/this_is_an_example_image.png","action_button_content":"Click Me!","layout":"photo_grid_with_header","campaign_code":"test_campaign","headline_font":"Roboto","medium":"test_medium","source":"test_source","tags":["tag"],"personalised":true,"active":true}},"CountdownCreateExample":{"summary":"Countdown","value":{"name":"TEST COUNTDOWN SMARTBLOCK","type":"countdown","allowed_merges":"test, test, test","steps":[{"animated":true,"fontSize":30,"text":"Test Countdown"},{"animated":true,"fontSize":30,"text":"Test Countdown","start":"2024-10-31T17:19:41Z"},{"animated":true,"fontSize":30,"text":"Test Countdown","start":"2024-10-31T17:19:41Z"}],"tags":["tag"],"personalised":true,"active":true}},"InstagramCreateExample":{"summary":"Instagram","value":{"name":"TEST INSTAGRAM SMARTBLOCK","type":"instagram","allowed_merges":"test, test, test","instagram_id":"bbc","number_of_columns":5,"redirect_url":"example.com/redirect","shuffle":true,"medium":"test_medium","source":"test_source","campaign_code":"test_campaign","layout":"photo_grid_with_header","item_count":5,"tags":["tag"],"personalised":true,"active":true}},"TwitterCreateExample":{"summary":"Twitter/X create","value":{"name":"TEST TWITTER/X SMARTBLOCK","type":"twitter","allowed_merges":"test, test, test","layout":"photo_grid_with_header","max_tweets":10,"redirect_url":"example.com/redirect","retweets":true,"showImages":true,"showTitle":true,"title":"Example Title","twitter_id":"bbc","urls":"none","campaign_code":"test_campaign","medium":"test_medium","source":"test_source","tags":["tag"],"personalised":true,"active":true}},"CouponCreateExample":{"summary":"Coupon","value":{"name":"TEST COUPON SMARTBLOCK","type":"coupon","redirect_url":"example.com/redirect","absoluteExpiryDate":"2024-10-31T17:19:41Z","allowed_merges":"test, test, test","countdownExpiry":3,"campaignExpiredContent":"Sorry the test offer has ended","couponExpiredContent":"Sorry, the test coupon has expired","couponMessageContent":"test coupon message","couponOutOfStockContent":"too slow, test coupon has expired","layout":"photo_grid_with_header","medium":"test_medium","source":"test_source","tags":["tag"],"personalised":true,"active":true}},"PinterestCreateExample":{"summary":"Pinterest","value":{"name":"TEST PINTREST SMARTBLOCK","type":"pinterest","redirect_url":"example.com/redirect","pinterest_board":"test_board","pinterest_id":"bbc","shuffle":true,"item_count":3,"noOfCols":5,"caption_size":"40px","allowed_merges":"test, test, test","layout":"pinterest_board","medium":"test_medium","source":"test_source","tags":["tag"],"personalised":true,"active":true}},"ReviewsCreateExample":{"summary":"Review","value":{"name":"TEST RATINGS AND REVIEWS SMARTBLOCK","type":"reviews","redirect_url":"example.com/redirect","item_count":3,"layout":"product_review_1","data_sources":[],"filters":[],"allowed_merges":"test, test, test","medium":"test_medium","source":"test_source","tags":["tag"],"personalised":true,"active":true}}},"securitySchemes":{"apiTokenAuth":{"type":"apiKey","name":"x-api-key","in":"header"}}},"x-samples-languages":["curl","csharp","java","javascript","node","python","php","ruby"]}