Approve a review and publish a study
Approves the study's pending review and publishes it. This spends money and opens the study to participants, which is why it needs the studies:launch scope rather than the ordinary study write.
Send review_id — the review you are approving: the identifier carried on the publish-requested message a partner portal received, or the pending review a person looked at. If the review it names is no longer the one awaiting a decision — a researcher resubmitted before your approval landed, or an earlier attempt of this same call already approved it — you get 409 rather than an approval of a review nobody at your end saw.
With a user-delegated token the approval is the token's person's, as it would be in the app, and only an organization admin may give it: any other role is refused with 403. A partner's approval names no person.
A study set to recruit participants through Outset is published by launching that recruitment, charged to the researcher who requested the review. The approval counts as accepting the warning that estimated screen-out costs may exceed the workspace budget.
Refusals to expect: 400 when the study has no review awaiting a decision or is not in a publishable state (including recruitment that can't launch, such as insufficient funds, a recruitment cost above the workspace budget, or an unfinished recruitment title or description), 409 for the conflict above, for a study that is already terminally closed, or for an Outset-recruited study with no recruitment the approval can launch (outset_recruitment_not_launchable), 404 for a study outside your credential's reach. Note that some preparation runs before the publish validators, so a refused publish is not guaranteed to have changed nothing.
Refused while the organization is suspended, and on a plan that does not include authoring studies. Already-published studies are returned unchanged with their review approved.
Requires the studies:launch scope, on a user-delegated token or a partner credential.
Request
- Base URL: https://api.outset.ai
- URL: https://api.outset.ai/v2/studies/{study_id}/publish/
- Auth: one of:
- OAuth 2 (authorization code, authorization URL https://outset.ai/oauth/authorize, token URL https://api.outset.ai/users/oauth/token/, scopes: studies:launch)
- HTTP bearer
Path parameters
Request body
Response
Changes
No recorded changes to this operation across all 1 revision of this API.