Update a Question - Sprig Docs

PATCH

studies

{studyId}

questions

{questionId}

curl --request PATCH \
  --url https://api.sprig.com/v2/studies/{studyId}/questions/{questionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: <if-match>' \
  --data '
{
  "configuration": {
    "tasksPerRespondent": 10
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": {
    "html": "<string>",
    "variables": {}
  },
  "required": true,
  "displayLogic": {
    "source": {
      "type": "QUESTION_RESPONSE",
      "question": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    },
    "operator": "EQUALS",
    "value": "<string>"
  },
  "skipLogic": [
    {
      "when": {
        "source": {
          "type": "QUESTION_RESPONSE",
          "question": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        },
        "operator": "EQUALS",
        "value": "<string>"
      },
      "destination": {
        "type": "END"
      }
    }
  ],
  "aiFollowUp": {
    "userPrompt": "<string>"
  },
  "randomizePosition": true,
  "type": "OPEN_TEXT",
  "name": "<string>",
  "description": {
    "html": "<string>",
    "variables": {}
  },
  "image": {
    "url": "<string>",
    "altText": "<string>",
    "displaySize": "FIT",
    "alignment": "LEFT",
    "width": 123,
    "height": 123,
    "mediaType": "image/gif",
    "originalFilename": "<string>",
    "assetId": "<string>"
  },
  "responsePlaceholder": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Headers

If-Match

string

required

Quoted Study version last read from ETag or Study.version. Required on mutating Study writes.

Example:

"\"126300\""

Path Parameters

studyId

string<uuid>

required

questionId

string<uuid>

required

Query Parameters

cascade

enum<string>

Available options:

true,

false

Body

application/json

A partial Question update. Omitted fields retain their stored values.

name

string | null

A new unique name, or null to remove the existing name.

Required string length: 1 - 128

title

object

The authored title accepted when creating a Question.

Show child attributes

description

object

Optional respondent-facing description shown with a Question.

Show child attributes

required

boolean

randomizePosition

boolean

Whether this Question participates in layout-position randomization. Defaults to false.

position

object

Repositions the Question. Submit this field by itself or with blockId.

Show child attributes

blockId

string<uuid> | null

Public UUID of the Block that will contain this Question, or null to move it to the Study root. Submit this field by itself or with position.

aiFollowUp

object | null

Show child attributes

type

enum<string>

The public Question type.

Available options:

OPEN_TEXT,

SINGLE_SELECT,

MULTIPLE_SELECT,

RATING_SCALE,

NPS,

VALIDATED_TEXT,

RANK_ORDER,

MATRIX,

TEXT_URL_PROMPT,

CONSENT_LEGAL,

AI_DYNAMIC,

CONJOINT,

MAX_DIFF

userPrompt

string | null

carryForward

object

Carries respondent-selected items from an earlier Question.

Show child attributes

randomizeOptions

boolean

presentation

enum<string>

Available options:

LIST,

DROPDOWN

options

object

One ordered item to rank. Its value is immutable; its label may be updated.

Rank order options · object[]
Options · object[]
Matrix rows · object[]

Show child attributes

selection

object

Inclusive minimum and maximum number of Options a respondent may select.

Show child attributes

range

Number of points on the rating scale.

Available options:

3

scaleLabelType

enum<string>

How the rating-scale points are displayed.

Available options:

NUMBER,

STAR,

SMILEY

lowEndLabel

string | null

Optional label shown at one endpoint of the scale.

Maximum string length: 255

highEndLabel

string | null

Optional label shown at one endpoint of the scale.

Maximum string length: 255

validation

Email · object

The validation rule applied to a validated-text response.

Email
URL
Regular expression
Number
Phone

Show child attributes

responsePlaceholder

string | null

Placeholder shown in the response field.

validationErrorMessage

string | null

Error shown when the response does not satisfy validation.

Required string length: 1 - 200

footer

object

Optional respondent-facing footer shown below the response field.

Show child attributes

labelForHighestRank

string

Required string length: 1 - 255

labelForLowestRank

string

Required string length: 1 - 255

rows

object[]

Minimum array length: 2

Show child attributes

columns

object[]

Minimum array length: 2

Show child attributes

randomizeRows

boolean

displayLimit

integer | null

Total number of authored choices shown to each respondent, including pinned choices.

Required range: x >= 2

action

Continue · object

Button behavior for a Text/URL Prompt.

Continue
External link
No button

Show child attributes

skipButtonText

string | null

Required string length: 1 - 255

labelForBest

string

Required string length: 1 - 255

labelForWorst

string

Required string length: 1 - 255

configuration

Recommended MaxDiff configuration · object

Recommended MaxDiff configuration
Custom MaxDiff configuration
Conjoint configuration

Show child attributes

selectionStyle

enum<string>

How respondents mark the best and worst item in each set.

Available options:

RADIO,

SMILEY

Required string length: 1 - 255

collectName

boolean

submitButtonText

string | null

Required string length: 1 - 255

assetId

string | null

Opaque id of a CONSENT_DOCUMENT asset owned by this environment.

Pattern: ^[A-Za-z0-9_-]{1,128}$

features

object[]

Required array length: 3 - 8 elements

Show child attributes

exclusions

object[]

Show child attributes

image

object | null

Attaches a QUESTION_IMAGE recorded on this Study. Null removes the current image. Omission leaves it unchanged.

Show child attributes

displayLogic

Condition · object

Replaces Question-owned display logic. Null clears it. Omission preserves the stored value.

Condition
All of
Any of

Show child attributes

skipLogic

object[] | null

Replaces Question skip logic. Null or an empty array clears it. Omission preserves the stored value.

Maximum array length: 20

Show child attributes

Response

Canonical Question resource.

string<uuid>

required

title

object

required

Canonical rich-text Question title.

Show child attributes

required

boolean

required

displayLogic

Condition · object

required

A single typed condition. Operators that inspect answer state omit value; choice comparisons use immutable Option values.

Condition
All of
Any of

Show child attributes

skipLogic

object[]

required

Ordered skip rules, limited to 20. An empty array clears skip logic.

Maximum array length: 20

Show child attributes

aiFollowUp

object | null

required

Show child attributes

randomizePosition

boolean

required

type

enum<string>

required

Available options:

OPEN_TEXT

name

string

description

object

Canonical respondent-facing Question description.

Show child attributes

image

object

The image shown with a Question. Omitted when the Question has no image.

Show child attributes

responsePlaceholder

string

Placeholder shown in the response field.

⌘I

curl --request PATCH \
  --url https://api.sprig.com/v2/studies/{studyId}/questions/{questionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: <if-match>' \
  --data '
{
  "configuration": {
    "tasksPerRespondent": 10
  }
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": {
    "html": "<string>",
    "variables": {}
  },
  "required": true,
  "displayLogic": {
    "source": {
      "type": "QUESTION_RESPONSE",
      "question": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    },
    "operator": "EQUALS",
    "value": "<string>"
  },
  "skipLogic": [
    {
      "when": {
        "source": {
          "type": "QUESTION_RESPONSE",
          "question": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>"
          }
        },
        "operator": "EQUALS",
        "value": "<string>"
      },
      "destination": {
        "type": "END"
      }
    }
  ],
  "aiFollowUp": {
    "userPrompt": "<string>"
  },
  "randomizePosition": true,
  "type": "OPEN_TEXT",
  "name": "<string>",
  "description": {
    "html": "<string>",
    "variables": {}
  },
  "image": {
    "url": "<string>",
    "altText": "<string>",
    "displaySize": "FIT",
    "alignment": "LEFT",
    "width": 123,
    "height": 123,
    "mediaType": "image/gif",
    "originalFilename": "<string>",
    "assetId": "<string>"
  },
  "responsePlaceholder": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "path": "<string>",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      }
    }
  ]
}