Sign in
Surveys V2

Create Survey

Creates a new survey in the specified application. Requires surveys:write scope.

post/v2/surveys

Request body

application_idstring required

ID of the application to create the survey in

namestring required

Display name of the survey

titlestring required

Title shown to the user

messagestring required

Message shown below the title

include_other_optionboolean

Whether to show an 'Other' free-text option (default: true)

include_close_optionboolean

Whether to show a close button (default: false)

presentation_probabilitynumber

Probability (0-1) of showing the survey (default: 1.0)

Response

Success

idstring required

Unique identifier for the survey

object'survey' required

Object type, always survey

application_idstring required

ID of the application this survey belongs to

namestring required

Display name of the survey

titlestring required

Title shown to the user

messagestring required

Message shown below the title

include_other_optionboolean required

Whether to show an 'Other' free-text option

include_close_optionboolean required

Whether to show a close button that dismisses without answering

presentation_probabilitynumber required

Probability (0-1) of showing the survey to a given user

assignment_keystring required

Key used for tracking user assignments; changes when assignments are reset

created_atstring required

ISO 8601 timestamp of when the survey was created

updated_atstring required

ISO 8601 timestamp of when the survey was last updated

Changes

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