Placeholders

Edit Project Placeholder

Required scopes: project.placeholder (Read and Write).

Updates the settings a custom placeholder has in this project. The placeholder definition itself is not edited here, so the change reaches no other project.

patch/projects/{projectId}/placeholders/{projectPlaceholderId}

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

projectPlaceholderIdinteger required

Project Placeholder identifier

Request body

op'replace' | 'test' required

Patch operation to perform

path'/index' | '/type' | '/isBlocking' | '/formats' json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Response

Project Placeholder was successfully updated

Example response

{
  "data": {
    "id": 1,
    "customPlaceholderId": 1,
    "type": "high",
    "index": 1,
    "formats": [
      "docbook",
      "adoc"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.