updateLayoutPreviewImage

PUT

/api/v1/layouts/{id}/preview-image

const url = 'https://example.com/api/v1/layouts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview-image?draftRevision=1';
const options = {method: 'PUT'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url 'https://example.com/api/v1/layouts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview-image?draftRevision=1'

Requires an authenticated dashboard session. Stores an aspect-preserving JPEG of at most 500 KB when draftRevision still matches the current Layout draft.

Parameters

Path Parameters

required

string format: uuid

Query Parameters

draftRevision

required

integer format: int64

>= 1

Responses

204

Preview image stored

409

Draft revision conflict

413

Preview exceeds 500 KB

422

Invalid JPEG dimensions or canvas aspect ratio