To personalize a web page or email, Fresh Relevance Slots are used. Each Slot is a location for content and can be used either on a web page or in an email to control where and what personalization SmartBlocks are displayed.

The Slots API is a REST API that allows you to access and create Slots from your systems in order to automate Slot provisioning and provide hyper personalization.

In order to call the API you must have your website ID from your Fresh Relevance account. To find this, expand the User menu and copy the Account ID value.

Endpoints

The API is available at a region specific API endpoint, for example, https:/r1-api-freshrelevance.dotdigital.com/api.

OAS / Swagger

Download OAS / Swagger specification

Authorization

You mut have an API token key for the type API with at least the following area access:

Read access
- content
Write access
- content

You can find out more about creating and editing API access tokens here.

Calls to the API are authorized by ensuring that a HTTP Header of x-api-key is included with the value of your API token.

Scoping

To ensure we scope the calls to the correct account/website you must pass your Website ID in the path of each call to the API in the website_id parameter.

Security

The API is served only by HTTPS using TLS 1.2 or higher for security.