GetInvitationDetail

  • invitation
    Type: object · Invitation
    • addedAt
      required

      Time when the invitation was added.

    • distributionEnabled
      Type: boolean
      required

      If distribution is enabled.

      • true: questback will send the invitation.
      • false: questback will NOT send the invitation.
    • invitationId
      Type: stringFormat: uuid
      required

      A unique id for a invitation.

    • languageCode
      Type: string
      required

      Language used when sending the invitation. Requires the quest to have a proper translation for the given language. Otherwise default language is used.

    • optedOut
      Type: boolean
      required

      If the respondent opted out on the invitation.

    • origin
      Type: string
      required

      Origin of the creator of the invitation.
      Valid values:

      • ESSENTIALS: web application
      • INTEGRATION: Machine to machine
      • DYNAMIC_LINK_INVITE: Dynamic link using invitation
      • DYNAMIC_LINK_ANSWER: Dynamic link without invitation
      • SURVEY_LOGIN: Invitations using token instead of link.
    • questId
      Type: stringFormat: uuid
      required

      A unique id for a quest.

    • replied
      Type: null | boolean
      required

      If the invitation was replied to or not. If the quest has enabled HiddenIdentity this field might be hidden.

    • sent
      Type: boolean
      required

      If the invitation was sent or not.

    • distributionChannel
      Type: string

      Distribution channel used when sending the invitation. Valid values:

      • EMAIL: Invitation link distriubted by email
      • SMS: Invitation link distributed by sms
      • EXTERNALLY_MANAGED: Invitation link distributed by quest owner. E.g. Send emails with private provider
      • LINK: Static link exposed by quest owner; one link for all respondents. E.g. a web page.
      • LINK_WITH_EMAIL: Static link exposed by quest owner; one link for all respondents, possible for respondent to apply email address.
      • DYNAMIC_LINK: Invitation link distributed by dynamic link
    • respondentIdent
      Type: string

      Respondent identifier. Unique for the respondent.

    • scheduledSendAt

      If delay is set, this is the time when the invitation will be sent.

    • sentAt

      Time when the invitation was sent.