Skip to main content
POST
Create a Review

Authentication and permissions

Token requirements: User-based token (OAuth). Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.
  • User: staged Catalyst draft: With draft.change_set_id, requires workspace session access and permission to view the originating Catalyst chat or agent session in your organization. Creates a review of the staged versions, including when approval-to-publish is off. Omit promotion and revision inputs. Retrying the same change set returns its review. This operation never publishes or applies changes.
  • User: create or revise promotion review: Requires author permission on the source and stage permission on the target, including retries. Retries are bound to the submitting user and workspace pair. New revisions require review revisions to be enabled, visibility of the existing review, the same workspace pair, and its current revision ID. Existing branch, link, validation, and receiving-approval checks remain enforced. This operation does not apply changes.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
draft
draft · object
required
title
string | null

Only supported when creating a new review, not a promotion revision.

description
string | null
requestId
string

Required for promotions. Reuse for retries; use a new value for different changes. Optional and unused for Catalyst drafts, where change_set_id identifies retries.

Response

200 - application/json

Success

data
data · object