Skip to main content

Resource fields

Field NameData TypeIs NullableDescription
idUUIDNo
nameStringNo
distributionString enumNoCan be TEMPLATE, TRIGGER or MODAL
integration_idIntegration IDNo
is_archivedBooleanNo
created_atDateNo
updated_atDateNo
ticket_linkStringNoTemplate URL for the associated ticket with <TICKET_ID> placeholder.
questionsQuestion Object[]No

Question object

Field NameData TypeIs NullableDescription
question_idQuestion IDNo
positionIntegerNo
is_requiredBooleanNo
is_activeBooleanNofalse indicates the question was removed/archived from the survey.
archived_atDateYesDate indicates the question was removed/archived from the survey.
is_mainBooleanNoFor internal use only.
sentiment_orderasc / descYesindicates sort only for scale question answers as CSAT2 and CSAT3