Skip to main content
POST
/
v1
/
cases
/
{case_token}
/
reviewers
Add reviewer to case
curl --request POST \
  --url https://instance.prod.onboardapp.io/v1/cases/{case_token}/reviewers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "user_id": "<string>",
  "role": "Approver"
}
'
{
  "data": {
    "token": "<string>",
    "user_id": "<string>",
    "name": "<string>",
    "role": "Approver",
    "status": "Invited",
    "notes": "<string>",
    "invited_at": "2023-11-07T05:31:56Z",
    "responded_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Headers

​
Idempotency-Key
string<uuid>

Unique key for idempotent request handling. If a request with the same key was already processed within the last 24 hours, the original response is returned.

Path Parameters

​
case_token
string
required

Case token.

Body

application/json
​
user_id
string
required

User ID of the reviewer to add.

​
role
enum<string>
default:Approver

Reviewer role.

Available options:
Approver

Response

Reviewer added.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object

A reviewer assigned to a case for approval or oversight.

​
meta
object