---
title: "Add a taggable user or register an agent alias for the current user."
method: POST
path: "/api/v1/review/participants"
tags: ["Review participants"]
---

# Add a taggable user or register an agent alias for the current user.

`POST /api/v1/review/participants`

## Request

- Base URL: `https://commentary.dev`
- URL: `https://commentary.dev/api/v1/review/participants`
- Auth: HTTP bearer

Provider-backed users are taggable metadata only. Draft Review user additions create a user share link.

## Headers

- `X-Commentary-Workspace-Id` string
- `X-Correlation-Id` string

## Request body

- AddReviewParticipantRequest
  - `provider` 'github'
  - `owner` string
  - `repo` string
  - `prNumber` integer
  - `branchRef` string
  - `draftSessionId` string
  - `webAppReviewId` string
  - `kind` 'user' | 'agent'
  - `providerLogin` string
  - `providerUserId` string
  - `userId` string
  - `agentAlias` string
  - `displayName` string
  - `mentionHandle` string
  - `recipient` string

## Response `201`

Successful response.

- object
  - `ok` unknown
  - `participant` ReviewParticipant
    - `id` string
    - `kind` 'user' | 'agent'
    - `providerLogin` string, nullable
    - `providerUserId` string, nullable
    - `viewerId` string, nullable
    - `agentAlias` string, nullable
    - `displayName` string
    - `mentionHandle` string
    - `source` string
    - `taggable` boolean
  - `participants` ReviewParticipant[]
    - `id` string
    - `kind` 'user' | 'agent'
    - `providerLogin` string, nullable
    - `providerUserId` string, nullable
    - `viewerId` string, nullable
    - `agentAlias` string, nullable
    - `displayName` string
    - `mentionHandle` string
    - `source` string
    - `taggable` boolean

## Other responses

- `400`: The request was invalid.
- `401`: Authentication is required.
- `403`: The token or session does not have permission for this resource.
- `404`: The resource was not found.
- `429`: The request was rate limited.

---

[API](https://skmtc.dev/commentary/apis/commentary-public-api.md) · [All operations](https://skmtc.dev/commentary/apis/commentary-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/commentary/apis/commentary-public-api/revisions/7aaafc198c52?raw)
