Skip to content
Documentation

Create Review Group

POST
/api/v1/review_groups
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/review_groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "reusable": true, "stages": [ { "position": 1, "approval_type": "one_of", "members": [ { "user_id": 1 } ] } ] }'

Creates a new review group

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name
required
string
reusable
required

Whether this review group appears in the review group picker for future reviews. If false, the group is a one-off created for a single review.

boolean
Example
true
stages
required
Array<object>
object
position
integer
approval_type
string
Allowed values: one_of all_of
members
Array<object>
object
user_id
integer

Responses

Section titled “Responses”

201

Section titled “201”

Successful

Media typeapplication/json
object
id
required
integer
name
required
string
reusable
required
boolean
stages
required
Array<object>
object
position
required
integer
approval_type
required
string
Allowed values: one_of all_of
members
required
Array<object>
object
user_id
required
integer
user
required
One of:
object
type
required
string
Allowed values: User
id
required
integer
first_name
required
string
last_name
required
string
profile_image_url
required
string
nullable
Example
{
  "id": 12345,
  "name": "My Review Group",
  "reusable": false,
  "stages": [
    {
      "position": 1,
      "approval_type": "one_of",
      "members": [
        {
          "user_id": 12345,
          "user": {
            "type": "User",
            "id": 12345,
            "first_name": "John",
            "last_name": "Smith",
            "profile_image_url": "https://example.com/profile.jpg"
          }
        }
      ]
    }
  ]
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}