Skip to content

Create Review Playbook

POST /review-playbooks

The playbook and its revision 1, in one act. A playbook with no revision resolves to nothing, so creating one without instructions would be creating a row that never applies.

FieldTypeNotes
slugstringrequiredmin length 1 max length 120
namestringrequiredmin length 1 max length 200
descriptionstring | nulloptionalmax length 4000
templatesobjectoptional—
scopeworkspace | organization | platform | nulloptional—
is_defaultbooleanoptionalDefault false.
change_notestring | nulloptionalmax length 500
StatusDescriptionBody
201Successful ResponseReviewPlaybookView
422Validation ErrorHTTPValidationError

The body shows the fields the schema always carries. Which combination is legal is a service rule the schema cannot express, so read the description above before copying this.

Terminal window
curl -X POST https://your-deployment.example.com/review-playbooks \
-H "Authorization: Bearer $COBRE_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"slug": "string",
"name": "string"
}'
FieldTypeNotes
idstring (uuid)required—
slugstringrequired—
namestringrequired—
descriptionstring | nullrequired, nullable—
scopeworkspace | organization | platformrequired—
is_defaultbooleanrequired—
is_activebooleanrequired—
active_revision_idstring (uuid) | nullrequired, nullable—
revision_numberintegerrequired—
templatesobjectrequired—
organization_idstring (uuid) | nullrequired, nullable—
workspace_idstring (uuid) | nullrequired, nullable—
created_atstring (date-time)required—
updated_atstring (date-time)required—