Endpoints
Launch Study
Publish a draft study and get its self-recruit link
POST
/api/public/v1/studies/{studyId}/launchRequest
Response
JSON
Authorization
x-api-keystringheaderrequiredYour workspace API key. See Authentication.
Path parameters
studyIdstring<uuid>requiredBodyapplication/json
walletIdstring<uuid>Wallet to bill this study from; must be granted to the API key's workspace (see GET /api/public/v1/wallets). Omit to auto-select the workspace's wallet when it has exactly one, or exactly one on its current billing entity.
Responses
Launched
idstring<uuid>requiredlinkIdstringrequiredselfRecruitLinkstring<uri>requiredstatusstringrequiredOne of: live
walletWalletThe wallet this launch is billed to. Omitted when no wallet is bound (workspace without wallet billing).