Change requests
Review and collaborate on proposed documentation changes before merging.
This API helps you keep your space clean by letting contributors propose changes, review them, and then merge or discard as needed.
Type of Object, always equals to "change-request"
Unique identifier for the change request
Incremental identifier of the change request
Subject of the change request
ID of the space in which the change request was created.
ID of the active revision in the change request.
ID of the initial revision in the space from which the change request was created.
ID of the latest revision when updating from main space content.
When merged, ID of the revision resulting from the merge.
Count of opened comments on the change request.
If true, the change request is not up-to-date with latest changes in the main content.
The ChangeRequest object
Returns a paginated list of change requests for the given space. Use this to discover existing change requests before creating a new one, or to find change requests assigned to a specific user for review.
A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
If defined, only change requests matching this status will be returned.
openPossible values: If defined, only change requests created by this user will be returned.
If defined, only change requests with contributions from this user will be returned.
If defined, only change requests with a requested reviewer for this user will be returned.
If defined, only change requests linked to this site topic will be returned.
The field to sort change requests by. Defaults to 'updatedAt'.
updatedAtPossible values: List of the space's change requests
Total count of objects in the list
List of the space's change requests
Creates a new change request, which is a draft working copy of the space's content — similar to a Git branch or pull request. Use this before making content edits to avoid modifying the live published content directly. Optionally supply a subject and a template to pre-populate the change request with content. Once created, use the change-request content endpoints to read and modify pages within the draft, then merge it when ready.
A unique entity identifier
^[a-zA-Z0-9_-]+$Subject of the change request
Change Request Created
Change Request Created
Retrieves the full details of a single change request, including its status, subject, description, and metadata. Use this to check the current state of a change request before deciding to merge, update, or request a review.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$The matching change request
Type of Object, always equals to "change-request"
Unique identifier for the change request
Incremental identifier of the change request
Subject of the change request
ID of the space in which the change request was created.
ID of the active revision in the change request.
ID of the initial revision in the space from which the change request was created.
ID of the latest revision when updating from main space content.
When merged, ID of the revision resulting from the merge.
Count of opened comments on the change request.
If true, the change request is not up-to-date with latest changes in the main content.
The change request could not be found.
Updates the metadata of a change request. Use this to rename a change request, add context before requesting a review, or change the workflow status without merging. To update page content within the change request, use the content endpoint instead.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Subject of the change request
The change request has been updated
Type of Object, always equals to "change-request"
Unique identifier for the change request
Incremental identifier of the change request
Subject of the change request
ID of the space in which the change request was created.
ID of the active revision in the change request.
ID of the initial revision in the space from which the change request was created.
ID of the latest revision when updating from main space content.
When merged, ID of the revision resulting from the merge.
Count of opened comments on the change request.
If true, the change request is not up-to-date with latest changes in the main content.
The change request has been updated
Merges the change request's draft content into the space's primary (published) content, making all changes live. If the result is "conflicts", the merge was still applied but the space may need manual conflict resolution. Consider running updateChangeRequest first to sync with the latest live content and reduce conflicts.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$OK
ID of the resulting revision
OK
Rebases the change request onto the latest primary revision of the space, pulling in any changes that were merged to the live space since this change request was created. Run this before merging to minimise conflicts, especially if the change request has been open for a while.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$OK
ID of the resulting revision
OK
Generates a temporary URL (valid for 1 hour) to download the change request's draft content as a PDF. Optionally scope the export to a single page using the page and only parameters. Use this to share or archive the draft content before merging.
A unique entity identifier
^[a-zA-Z0-9_-]+$A unique entity identifier
^[a-zA-Z0-9_-]+$Generate a PDF only for the provided page.
ID of a specific page to generate a PDF for.
URL of the PDF
Temporary URL to print the content. The URL will work for 1h.
URL of the PDF
Returns a paginated list of change requests across all spaces in the organization. Use this for an organization-wide view of open drafts — for example, to find all change requests needing a specific reviewer's attention. For a single space's change requests, use the space-scoped endpoint instead.
A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
If defined, only change requests created by this user will be returned.
If defined, only change requests with contributions from this user will be returned.
If defined, only change requests with a requested reviewer for this user will be returned.
If defined, only change requests linked to this site will be returned.
If defined, only change requests from this space will be returned.
If defined, only change requests linked to this site topic will be returned.
Controls whether change requests from triage are included. Pass none to exclude change requests from triage, or all to include them. Default is none.
The field to sort change requests by. Defaults to 'updatedAt'.
updatedAtPossible values: List of the organization's change requests
Total count of objects in the list
List of the organization's change requests
Last updated
Was this helpful?