Sign in
Documents

Use document as a site or update the existing site

Use document as a site or update the existing site by the given document <strong>{id}</strong>. <br> The <strong>{id}</strong> must be an ID of existing document

post/pimcore-studio/api/documents/site/{id}

Request

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

Path parameters

idinteger required
Example:83

Id of the document

Request body

mainDomainstring required

Main domain

domainsstring[] required

Domains

errorDocumentstring required

Error document

localizedErrorDocumentsobject required

Localized error documents

redirectToMainDomainboolean required

Redirect to main domain

Example request

{
  "mainDomain": "main_site",
  "domains": [
    "other_domain"
  ],
  "errorDocument": "path/to/error/document",
  "localizedErrorDocuments": {
    "en": "path/to/en/error/document",
    "de": "path/to/de/error/document"
  }
}

Response

Successfully created/updated site

Changes

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