Sign in
Studies

Create a study in a group

post/groups/{groupId}/studies

Request

  • Base URL: http://localhost:8080/api/v0
  • URL: http://localhost:8080/api/v0/groups/{groupId}/studies
  • Auth: HTTP bearer

Path parameters

groupIdstring uuid required

Request body

titlestring required

Study title (stored under en-US locale)

iconstring required

Icon identifier (e.g. SF Symbol name)

Example request

{
  "title": "My Heart Counts",
  "icon": "heart"
}

Response

Study created

idstring uuid required
localesLocalizationKey[] required

Supported locales for the study

iconstring required

Icon identifier (e.g. SF Symbol name)

detailsStudyDetailData required

Localized study details keyed by locale

consentStudyConsent required

Locale-keyed map of consent content

visibility'public' | 'unlisted' required

Whether a published study is listed publicly or only accessible via invitation code

enrollmentConditions'none' | 'requiresInvitationCode' required

Defines how enrollment into a study works

Example response

{
  "locales": [
    "en-US",
    "de-DE"
  ],
  "icon": "heart",
  "details": {
    "en-US": {
      "title": "My Heart Counts",
      "shortTitle": "MHC",
      "explanationText": "This study aims to...",
      "shortExplanationText": "A heart health study"
    }
  },
  "participationCriterion": {
    "type": "all",
    "criteria": [
      {
        "type": "ageAtLeast",
        "age": 18
      },
      {
        "type": "any",
        "criteria": [
          {
            "type": "isFromRegion",
            "region": "US"
          },
          {
            "type": "isFromRegion",
            "region": "DE"
          }
        ]
      }
    ]
  },
  "consent": {
    "en-US": {
      "title": "Study Consent Form",
      "content": "# Consent\n\nBy participating..."
    },
    "de-DE": {
      "title": "Einwilligungserklärung",
      "content": "# Einwilligung\n\nDurch die Teilnahme..."
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.