questions

Update Question

Please note that any update to the options field will delete the existing question options (if still possible) and replace them with the new ones. Use the AnswerOption API for granular question option modifications.

put/api/events/{event}/questions/{id}/

Request

  • Base URL: https://pretalx.com
  • URL: https://pretalx.com/api/events/{event}/questions/{id}/
  • Auth: none declared

Path parameters

eventstring required

The event’s slug

idinteger required

A unique integer value identifying this question.

Request body

identifierstring
questionMultiLanguageString required
help_textMultiLanguageString
default_answerstring nullable
variant'number' | 'string' | 'text' | 'url' | 'date' | 'datetime' | 'boolean' | 'file' | 'choices' | 'multiple_choice'
  • number - Number
  • string - Text (one-line)
  • text - Multi-line text
  • url - URL
  • date - Date
  • datetime - Date and time
  • boolean - Yes/No
  • file - File upload
  • choices - Choose one from a list
  • multiple_choice - Choose multiple from a list
target'submission' | 'speaker' | 'reviewer'
  • submission - per proposal
  • speaker - per speaker
  • reviewer - for reviewers
deadlinestring date-time nullable

Set a deadline to make this field required after the given date.

freeze_afterstring date-time nullable

Set a deadline to stop changes to responses after the given date.

question_required'optional' | 'required' | 'after_deadline'
  • optional - always optional
  • required - always required
  • after_deadline - required after a deadline
positioninteger
tracksinteger[]

You can limit this field to some tracks. Leave empty to apply to all tracks.

submission_typesinteger[]

You can limit this field to some session types. Leave empty to apply to all session types.

min_lengthinteger nullable

Minimum allowed text in characters or words (set in CfP settings).

max_lengthinteger nullable

Maximum allowed text length in characters or words (set in CfP settings).

min_numberstring decimal nullable
max_numberstring decimal nullable
min_datestring date nullable
max_datestring date nullable
min_datetimestring date-time nullable
max_datetimestring date-time nullable
activeboolean

Inactive fields will no longer be shown.

is_publicboolean

Responses will be shown on session or speaker pages as appropriate.

contains_personal_databoolean

If a user deletes their account, responses containing personal data will be removed, too.

is_visible_to_reviewersboolean

Should responses to this field be shown to reviewers? This is helpful if you want to collect personal information, but use anonymous reviews.

Example request

{
  "question": {
    "en": "English text",
    "de": "Deutscher Text"
  },
  "help_text": {
    "en": "English text",
    "de": "Deutscher Text"
  },
  "options": [
    {
      "answer": {
        "en": "English text",
        "de": "Deutscher Text"
      }
    }
  ]
}

Response

idinteger required
identifierstring
questionMultiLanguageString required
help_textMultiLanguageString
default_answerstring nullable
variant'number' | 'string' | 'text' | 'url' | 'date' | 'datetime' | 'boolean' | 'file' | 'choices' | 'multiple_choice'
  • number - Number
  • string - Text (one-line)
  • text - Multi-line text
  • url - URL
  • date - Date
  • datetime - Date and time
  • boolean - Yes/No
  • file - File upload
  • choices - Choose one from a list
  • multiple_choice - Choose multiple from a list
target'submission' | 'speaker' | 'reviewer'
  • submission - per proposal
  • speaker - per speaker
  • reviewer - for reviewers
deadlinestring date-time nullable

Set a deadline to make this field required after the given date.

freeze_afterstring date-time nullable

Set a deadline to stop changes to responses after the given date.

question_required'optional' | 'required' | 'after_deadline'
  • optional - always optional
  • required - always required
  • after_deadline - required after a deadline
positioninteger
tracksinteger[]

You can limit this field to some tracks. Leave empty to apply to all tracks.

submission_typesinteger[]

You can limit this field to some session types. Leave empty to apply to all session types.

min_lengthinteger nullable

Minimum allowed text in characters or words (set in CfP settings).

max_lengthinteger nullable

Maximum allowed text length in characters or words (set in CfP settings).

min_numberstring decimal nullable
max_numberstring decimal nullable
min_datestring date nullable
max_datestring date nullable
min_datetimestring date-time nullable
max_datetimestring date-time nullable
activeboolean

Inactive fields will no longer be shown.

is_publicboolean

Responses will be shown on session or speaker pages as appropriate.

contains_personal_databoolean

If a user deletes their account, responses containing personal data will be removed, too.

is_visible_to_reviewersboolean

Should responses to this field be shown to reviewers? This is helpful if you want to collect personal information, but use anonymous reviews.

Example response

{
  "question": {
    "en": "English text",
    "de": "Deutscher Text"
  },
  "help_text": {
    "en": "English text",
    "de": "Deutscher Text"
  },
  "options": [
    {
      "answer": {
        "en": "English text",
        "de": "Deutscher Text"
      }
    }
  ]
}

Changes

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