Skip to main content
POST
Launch a draft and return the self-recruit link

Authorizations

x-api-key
string
header
required

Path Parameters

studyId
string<uuid>
required

Body

application/json

Optional body; omit it entirely to auto-select the wallet.

walletId
string<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.

Response

Launched

id
string<uuid>
required
status
enum<string>
required
Available options:
live
wallet
object

The wallet this launch is billed to. Omitted when no wallet is bound (workspace without wallet billing).