Skip to content

Save Board Layout

PUT
/api/creative/visual-studio/projects/{project_id}/layout

Save the spatial mood board layout for a project.

project_id
required
Project Id
string
SaveBoardLayoutRequest

Request model for saving a board layout.

object
cards
Cards

Card positions

Array<object>
VisualCardPosition

Position and size of a card on the mood board.

object
assetId
required
Assetid

Asset ID

string
x
required
X

X position in pixels

number
y
required
Y

Y position in pixels

number
width
Width

Card width

number
default: 200
height
Height

Card height

number
default: 150
zIndex
Zindex

Z-index for stacking

integer
0
viewportX
Viewportx

Viewport X offset

number
0
viewportY
Viewporty

Viewport Y offset

number
0
zoom
Zoom

Zoom level

number
default: 1

Successful Response

VisualBoardLayoutOperationResponse

Response model for board layout save operations.

object
success
required
Success

Operation success status

boolean
error
Any of:
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object