Sign in

v1

latestOpenAPI 3.1.02026-08-04222461539.5 KB
canvas-areas

Update a canvas area

Updates an existing canvas area

patch/canvas-areas/{canvasAreaId}

Path parameters

canvasAreaIdstring required

Canvas Area ID

Headers

Authorizationstring required

Bearer authentication

X-Disable-Hooks'true' required

Request body

type'mapping' | 'header' | 'agent' | 'form' | 'sheet' | 'sheets' | 'workbook' | 'document' | 'file' | 'iframe'
position'top' | 'left' | 'right' | 'middle' | 'bottom'
visibility'visible' | 'hidden' | 'optional' | 'skeleton'
layout'split' | 'drawer' | 'modal'
{"stackTrail":"paths:/canvas-areas/{canvasAreaId}:patch:requestBody:content:application/json:schema:properties:overlay","oasType":"schema","type":"unknown","description":"Any type"}
{"stackTrail":"paths:/canvas-areas/{canvasAreaId}:patch:requestBody:content:application/json:schema:properties:config","oasType":"schema","type":"unknown","description":"Any type"}
{"stackTrail":"paths:/canvas-areas/{canvasAreaId}:patch:requestBody:content:application/json:schema:properties:metadata","oasType":"schema","type":"unknown","description":"Any type"}
parentIdstring

Canvas Area ID

canvasIdstring

Canvas ID

Response

Response with status 200