Reviews

Generate a review-link token

Mints a single-use token and URL path (/r/{token}) that lets an unauthenticated reviewer decide this review. Requires the template to have enable_review_links: true and the review to be pending.

post/api/v1/reviews/{id}/token

Request

  • Base URL: https://api.gatewerk.com
  • URL: https://api.gatewerk.com/api/v1/reviews/{id}/token
  • Auth: HTTP bearer

Request body

purposestring required

Short, operator-supplied reason this token is being minted. Surfaced in the audit trail.

recipient_labelstring required

Human-readable label for the recipient (e.g., name or email). Surfaced in the audit trail and inbox.

notestring nullable

Optional free-form note attached to the token.

auth_level'public' | 'email_otp' | 'account'

Auth tier required to consume the token. All three tiers are fully supported. 'public' asks nothing of the recipient and leaves the decision unattributed beyond recipient_label. 'email_otp' requires auth_email and makes the recipient prove control of that address with a 6 digit code before deciding. 'account' requires auth_user_id and makes the recipient sign in. The wire default stays 'public' for back-compat; the Inbox share dialog defaults to 'email_otp'.

auth_emailstring email nullable

Email pinned to the token when auth_level is email_otp.

auth_user_idstring nullable

Reviewer id pinned to the token when auth_level is account.

expiryHoursinteger

Hours until the token expires. Defaults to 48.

Response

Token created

object'review_token' required
tokenstring required

Raw token. Returned once — store it client-side.

review_idstring required
expires_atstring date-time nullable
urlstring required

Path component (e.g. /r/{token}). Prefix with your UI origin.

Changes

No recorded changes to this operation across all 1 revision of this API.