Skip to content

Update a layout

PUT
/api/tenant/{tenantId}/Layouts/{id}
curl --request PUT \
--url https://api.nimles.com/cms/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Layouts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "elements": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "type": "example", "children": [], "properties": { "additionalProperty": "example" }, "styles": { "additionalProperty": "example" }, "css": "example", "content": "example", "text": "example", "contentLocalized": { "additionalProperty": "example" }, "contentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "uniqueName": "example", "classNames": "example" } ], "width": 1, "name": "example", "description": "example", "uniqueName": "example", "styles": { "additionalProperty": "example" }, "css": "example", "themeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "template": "example", "insertJs": "example", "integrations": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "enabled": true, "name": "example", "properties": { "additionalProperty": "example" } } ], "hostName": "example", "classNames": "example" }'
id
required
string format: uuid
tenantId
required
string format: uuid

Your tenant id.

Media typeapplication/json
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
elements
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
type
required
string
nullable
children
Array<object> recursive
properties
object
key
additional properties
styles
object
key
additional properties
css
string
nullable
content
string
nullable
text
string
nullable
contentLocalized
object
key
additional properties
string
contentId
string format: uuid
nullable
uniqueName
required
string
nullable
classNames
string
nullable
width
integer format: int32
name
required
string
nullable
description
string
nullable
uniqueName
required
string
nullable
styles
object
key
additional properties
css
string
nullable
themeId
string format: uuid
nullable
template
string
nullable
insertJs
string
nullable
integrations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
enabled
boolean
name
required
string
nullable
properties
object
key
additional properties
string
hostName
string
nullable
classNames
string
nullable

Example generated

{
"fields": {
"additionalProperty": {
"value": "example",
"valueType": "example"
}
},
"accessibility": "example",
"elements": [
{
"fields": {
"additionalProperty": {
"value": "example",
"valueType": "example"
}
},
"accessibility": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"type": "example",
"children": [],
"properties": {
"additionalProperty": "example"
},
"styles": {
"additionalProperty": "example"
},
"css": "example",
"content": "example",
"text": "example",
"contentLocalized": {
"additionalProperty": "example"
},
"contentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"uniqueName": "example",
"classNames": "example"
}
],
"width": 1,
"name": "example",
"description": "example",
"uniqueName": "example",
"styles": {
"additionalProperty": "example"
},
"css": "example",
"themeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"template": "example",
"insertJs": "example",
"integrations": [
{
"fields": {
"additionalProperty": {
"value": "example",
"valueType": "example"
}
},
"accessibility": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"enabled": true,
"name": "example",
"properties": {
"additionalProperty": "example"
}
}
],
"hostName": "example",
"classNames": "example"
}

No Content: done, with no item to return.

Unauthorized: no bearer token, or one that is expired or not for this API.

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}

Not found: no such item in the tenant.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}

Conflict: the item kept changing under concurrent writes; read it again and retry.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}

Unprocessable: the body or the change is invalid. The errors are keyed by member.

Media typeapplication/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object
errors
object
key
additional properties
Array<string>
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
"errors": {
"additionalProperty": [
"example"
]
},
"status": 1,
"title": "example",
"type": "example"
}