Skip to content
CARP Docs
Ask AISystemLightDark

Enable or reconfigure self-signup

Copy MarkdownOpen inView as MarkdownOpen in Scira AIOpen in ChatGPTOpen in ClaudeOpen in Cursor
PUT
/api/studies/{study-id}/self-signup

Enables Kahoot-style self-signup for the study, or reconfigures it if already enabled or ended before. The study must be live and the given participant role must exist on its protocol. A short code is generated once, on first enable, and is never regenerated by later calls - it survives an enable -> end -> re-enable cycle. maxParticipants is a lifetime cap and may be raised or lowered on a later call.

bearer
headerAuthorizationBearer <token>

Provide the username and password of the user

study-id*string
application/json
  1. body
maxParticipants?integer
Formatint32
participantRoleName*string
Length1 <= length
clientId*string
Length1 <= length
redirectUri*string
Length1 <= length
subdomain?string|null
expirationSeconds?integer
Formatint64
Rangevalue <= 2592000

Response body

OK

*/*
  1. response
shortCode?string
enabled?boolean
participantRoleName?string
maxParticipants?integer
Formatint32
currentParticipantCount?integer
Formatint32
Example request
curl -X PUT 'https://dev.carp.dk/api/studies/string/self-signup' \  -H 'Content-Type: application/json' \  -d '{  "participantRoleName": "string",  "clientId": "string",  "redirectUri": "string"}'
Example response
{  "shortCode": "string",  "enabled": true,  "participantRoleName": "string",  "maxParticipants": 0,  "currentParticipantCount": 0}

Quick links

Page · DocumentationCARP DocumentationPage · DocumentationIntroductionPage · DocumentationQuickstartPage · DocumentationTerminologyPage · DocumentationArchitecture