GuidesAPI Reference
API Reference
Select productLog inHelp centre

Create Smartblock

post
https://{region}-api-freshrelevance.dotdigital.com/api//smartblocks/

Creates a Smartblock.

Path Params
string
required

Website ID for the account you are posting data to.

Query Params
string
enum
required

Get data in JSON format.

Allowed:
Body Params

Banner Smartblock

boolean
Defaults to true

Indicates whether the Smartblock is active or not

url
required

Image to display in the Smartblocks background

string

The layout for this SmartBlock

string
length ≤ 256
string
required
length between 1 and 256

Unique name for the Smartblock

boolean
Defaults to true

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.

string
enum
required

The type of Smartblock

Allowed:
string

The HTML color code to use for the action button background

string

The HTML color code to use for the action button text

string
required

Text to display on the action (CTA) button

string

The HTML color code to use for the banner background

boolean
Defaults to false

Enable if the background image is a texture or other repeating image.

string
length ≤ 5000

Campaign code (utm_campaign) added to the query collection of the URL, when your shopper clicks on this SmartBlock

boolean
Defaults to false

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.

boolean
Defaults to false

Enable to load all data on locations associated with shown products for use in SmartBlock customization.

string

Find the closest location in this location set. Note:

  • Requires "Geocode by IP" and "Personalised" to be enabled
  • If used in conjunction with radius this method will take precedence
integer
≥ 0

Find the closest location within this radius in km

string
enum
Defaults to inherit

The text alignment for the headline

Allowed:
string

The HTML color code to use for the headline text

string

Web font family to use for the headline

string
Defaults to 0

Headlines horizontal offset

string
Defaults to 32

The size of the headline font

string
required

Text to display for the headline of the Smartblock

string
Defaults to 0

Headlines vertical offset (positive is upwards)

string

Height of the banner

string

The HTML color code to use for the icon

string
length ≤ 100

Tracking medium (utm_medium) added to the query collection of the URL, when your shopper clicks on this SmartBlock

string
required

The message to display

string
enum
Defaults to left

Alignment of main message text

Allowed:
string

The HTML color code to use for the message text

string

Web font family to use for the message text

string
Defaults to 15px

The font size of the message text

string
Defaults to 0

Messages horizontal offset

string
Defaults to 0

Messages vertical offset (positive is upwards)

string
required

Twitter/X: Redirect to this URL when somebody clicks on the Twitter feed. (Supports personalization). Defaults to the twitter page

string
length ≤ 100

Campaign source (utm_source) added to the query collection of the URL, when your shopper clicks on this SmartBlock

string

Additional CSS styles

string

Comma seperated SmartBlock tags, so you can find your smartblocks later

string
enum
Defaults to plus1days

Day to show weather for

Allowed:
string

The width of the banner

Responses

Updated about 6 hours ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 6 hours ago