---
title: "Notify Review Ready"
method: POST
path: "/voyager/review-ready"
tags: ["voyager"]
---

# Notify Review Ready

`POST /voyager/review-ready`

## Request

- Base URL: `https://api.moda.app/v1`
- URL: `https://api.moda.app/v1/voyager/review-ready`
- Auth: HTTP bearer

Send a review alert to your own account email. Needs a paid Voyager plan (402
``paid_plan_required`` on Free or no plan).

## Headers

- `Moda-Version` '2026-04-12' | '2026-05-01'

## Request body

- VoyagerReviewReadyRequest
  - `kind` 'version_ready' | 'approval_needed' | 'test', required: `test` sends a fixed confirmation (the Settings "Send test" button) and ignores share_url.
  - `share_url` string, nullable: https://share.voyager.site/<token> review link. Required unless kind is `test`.
  - `channel` 'email' | 'telegram', nullable: Ignored: alerts always go to email. `"telegram"` is still accepted from older clients.
  - `version` integer, nullable
  - `title` string, nullable
  - `note_count` integer, nullable
  - `note_author` string, nullable: Display name of the reviewer behind a single approval_needed note. Omitted reads "A reviewer".
  - `idempotency_key` string, nullable: Optional client-minted submission key. Reuse for retries within 24 hours; the original result is replayed.

## Response `200`

Successful Response

- VoyagerReviewReadyResponse
  - `sent` true
  - `channel` 'email'

## Other responses

- `401`: Authentication required.
- `402`: paid_plan_required: the workspace has no paid Voyager plan.
- `403`: Permission denied for this scope.
- `404`: Resource not found.
- `409`: Conflict (idempotency / resource state).
- `422`: Request validation failed.
- `429`: Rate limit exceeded.
- `500`: Internal error.
- `502`: Review notification delivery failed or could not be confirmed.

## Changes

- **2026-11-03** `9ac6a3abc0f8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/moda/apis/moda-public-api/changes/voyager/review-ready/post.md)

---

[API](https://skmtc.dev/moda/apis/moda-public-api.md) - [All operations](https://skmtc.dev/moda/apis/moda-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/moda/apis/moda-public-api/revisions/9ac6a3abc0f8?raw)