To personalize a web page or email, Fresh Relevance layouts are used. Each layout is a block of HTML content and can be used on either in a web page or an email.
The Layout API is a REST API that allows you to access and create layouts from your systems in order to automate layout provisioning and provide hyper-personalization.
In order to call the API you must have your Account ID from Fresh Relevance. 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 must have an API token key for the type API with at least the following area access:
- Read access
- content
- Write access
- content
Learn more about creating and editing API access tokens.
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 Account/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.