Upload a variant's preview image
POST
/cms/pagebuilder/variants/{blockType}/{key}/thumbnail
const url = 'https://api.example.com/cms/pagebuilder/variants/example/example/thumbnail';const form = new FormData();form.append('file', 'file');
const options = {method: 'POST', headers: {'API-Key': '<API-Key>'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.example.com/cms/pagebuilder/variants/example/example/thumbnail \ --header 'API-Key: <API-Key>' \ --header 'Content-Type: multipart/form-data' \ --form file=@fileSets the preview image editors see when choosing this display. PNG, JPEG, WebP or GIF, up to 5 MB, sent as multipart/form-data field file. The variant must already be registered.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”blockType
required
string
key
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typemultipart/form-data
object
file
required
string format: binary
Responses
Section titled “Responses”Thumbnail stored
Media typeapplication/json
object
blockType
string
key
string
thumbnailId
integer
thumbnail
Image URL
string
Example generated
{ "blockType": "example", "key": "example", "thumbnailId": 1, "thumbnail": "example"}Missing or invalid image
API key not linked to a CMS user with the required permission
Variant not registered