API Docs / Operations / Design Theme - Background Images / Add Background Image

Add Background Image

POST /tenants/{tenant}/designthemes/{designThemeCode}/backgroundimages

Adds a new background image to the specified design theme.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code
designThemeCode* path string

Request Body*

BackgroundImageRequest
{
  "imageAssetCode": "string",
  "pageSelection": "None",
  "position": "FullPage",
  "offsetXMm": 0,
  "offsetYMm": 0
}

Responses

201 Created
401 Unauthorized – Invalid or missing API key
404 Not Found

Try it

Related Schemas

BackgroundImageRequest

Request DTO for creating or updating a background image on a design theme.

BackgroundImageDto

A background image configured on a design theme for PDF rendering.