Skip to main content
POST
Create a draft Study

Authorizations

Authorization
string
header
required

Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.

Body

application/json

Input for creating a draft Survey or in-product Survey Study.

name
string
required
Minimum string length: 1
type
enum<string>
required

Creates a shareable Survey Study.

Available options:
SURVEY
responseSettings
object

Response settings for a SURVEY Study. Omission defaults to a fixed limit of 10,000 responses.

Response

Created

A Study discriminated by its public type.

id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
DRAFT,
IN_PROGRESS,
PAUSED,
COMPLETED,
ARCHIVED
version
integer
required
Required range: x >= 1
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
studyUrl
string<uri>
required

Link to this Study in the Sprig dashboard for authors.

type
enum<string>
required

A shareable Survey Study.

Available options:
SURVEY
responseSettings
object
required
shareUrl
string<uri> | null
required

The respondent URL, or null until the Study can be shared.