Sign in
Website Settings

Add a new website setting

Add a new website setting with the provided name and type. The following types are supported: <strong>text</strong>, <strong>document</strong>, <strong>asset</strong>, <strong>object</strong>, <strong>bool</strong>. <br>

post/pimcore-studio/api/website-settings/add

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/add
  • Auth: none declared

Request body

namestring required

Name

typestring required

Type

Example request

{
  "name": "New Custom Setting",
  "type": "document"
}

Response

Successfully added 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.