Website Settings

Update a website setting

Update a website setting with the given <strong>{id}</strong>. The <strong>{id}</strong> must be an ID of an existing website setting. <br> Please note that <strong>all fields<strong> have to be provided.

put/pimcore-studio/api/website-settings/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/website-settings/{id}
  • Auth: none declared

Path parameters

idinteger required
Example:83

Id of the website setting

Request body

namestring required

Name

languagestring required

Language

siteIdinteger nullable required

Site ID

Example request

{
  "name": "Updated Setting Title",
  "language": "en",
  "data": {
    "id": 1020,
    "fullPath": "/path/to/object"
  },
  "siteId": 1
}

Response

Successfully updated website setting

additionalAttributesobject

AdditionalAttributes

idinteger required

ID

namestring required

Name

languagestring

Language

typestring nullable required

Type

siteIdinteger nullable

Site ID

creationDateinteger nullable

Creation date

modificationDateinteger nullable

Modification date

Example response

{
  "id": 1,
  "name": "site_title",
  "language": "en",
  "type": "text",
  "data": {
    "id": 1020,
    "fullPath": "/path/to/object"
  },
  "siteId": 1
}

Changes

No recorded changes to this operation across all 2 revisions of this API.