Sign in
Bundle Headless Documents

Create a new brick

Create a new brick with the specified name. <br> The name must be unique and not already used by an existing brick.

post/pimcore-studio/api/bundle/headless-documents/bricks

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/bundle/headless-documents/bricks
  • Auth: none declared

Request body

namestring required

Name of the template

Example request

{
  "name": "Simple"
}

Response

Created brick details as JSON

additionalAttributesobject

AdditionalAttributes

idstring required

Id of brick

namestring required

Name of brick

contentstring required

YAML-formatted string of brick content configuration

writeableboolean required

Is configuration writeable

Example response

{
  "id": "Simple",
  "name": "Simple",
  "content": "\"type: brick\\ngroup: null\\nitems:\\n\"",
  "writeable": true
}

Changes

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