Update a layout

Request

Updates an existing layout. API keys can only update shared layouts.

Security

ApiKey(Required scopes: layouts.update)

Path

idstringrequired

Layout ID

Bodyapplication/jsonrequired

namestring

folderNamestring^[^/]*$

The folder name used to organize layouts in the UI. It cannot contain forward slashes. "" will unset the folderName.

permissionstring(LayoutPermission)

Enum:"CREATOR_WRITE""ORG_READ""ORG_WRITE"

dataobject

Layout contents. The format may change. Treat it as opaque and preserve values returned by the API.

Payload

{
  "name": "string",
  "folderName": "string",
  "permission": "CREATOR_WRITE",
  "data": {}
}

Responses

Success

Bodyapplication/json

idstringrequired

ID of the layout

namestringrequired

Name of the layout

createdAtstring, (date-time)required

Timestamp when the layout was created on the server

updatedAtstring, (date-time)required

Timestamp when the layout was last updated on the server

savedAtstring, (date-time)

Timestamp when the layout was last saved locally

folderNamestring

Name of the folder the layout belongs to.

permissionstring(LayoutPermission)required

Enum:"CREATOR_WRITE""ORG_READ""ORG_WRITE"

dataobject

Layout contents. The format may change. Treat it as opaque and preserve values returned by the API.

Response

{
  "id": "string",
  "name": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "savedAt": "2019-08-24T14:15:22Z",
  "folderName": "string",
  "permission": "CREATOR_WRITE",
  "data": {}
}