Added

New Documentation: External Reviewer Suggestions via Relay API

We've published new documentation for submitting and managing third-party reviewer suggestions through the Relay API. This guide covers the addJSONData endpoint (type "4") that lets integrated reviewer-matching providers push candidate reviewers directly into the editor's reviewer selection workflow in ScholarOne Manuscripts.


Read the full reference here: External Reviewer Suggestions via Relay API

The documentation covers:

  • The four supported operations - submit, add, update, and delete - for creating and maintaining a suggestion batch over a manuscript's peer review lifecycle

  • The full Candidate Field Reference, including required fields, character limits, and validation behavior for email, orcid, country, relevanceScore, and more

  • How person matching resolves candidates to existing ScholarOne user records via email, ORCID, or an optional personId hint

  • The allowed HTML tag list for rich-text fields like matchReason and matchDetails

  • Recognized providerData keys (relevantWorks / relatedWorks) that render as a formatted "Most Relevant Works" list in the candidate detail view

  • Batch lifecycle statuses, idempotency behavior on submit retries, and per-candidate vs. request-level failure handling

  • Candidate ordering, operation ordering, and concurrency guidance for providers sending suggestions asynchronously