Listen LabsDocs

    Endpoints

    Launch Study

    Publish a draft study and get its self-recruit link

    POST/api/public/v1/studies/{studyId}/launch
    Request
    curl -X POST 'https://listenlabs.ai/api/public/v1/studies/<studyId>/launch' \
      -H 'x-api-key: <api_key>' \
      -H 'Content-Type: application/json' \
      -d '{}'
    Response
    JSON
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "linkId": "string",
      "selfRecruitLink": "https://example.com",
      "status": "live",
      "wallet": {
        "walletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "recruitmentCreditBalance": {
          "balance": 0,
          "usage": 0
        },
        "projectCreditBalance": {
          "balance": 0,
          "usage": 0
        }
      }
    }

    Authorization

    x-api-keystringheaderrequired

    Your workspace API key. See Authentication.

    Path parameters

    studyIdstring<uuid>required

    Bodyapplication/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>required
    linkIdstringrequired
    selfRecruitLinkstring<uri>required
    statusstringrequired

    One of: live

    walletWallet

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