| CommunityId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- The ID of the community that you want to send the survey to.
|
| EmailBrandingId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- The ID of the survey email branding object that’s associated with this invitation.
|
| InvitationLink |
- Type
- url
- Properties
- Filter, Group, Nillable, Sort
- Description
- The URL to the survey that is sent to participants.
|
| InviteExpiryDateTime |
- Type
- dateTime
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The date and time that the survey invitation expires.
|
| IsDefault |
- Type
- boolean
- Properties
- Create, Defaulted on create, Filter
- , Group, Sort, Update
- Description
- Determines whether this is the default survey invitation to use when the survey is sent to participants.
|
| LastReferencedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp for when the current user last viewed a record related to this survey invitation.
|
| LastViewedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp for when the current user last viewed this survey invitation.
|
| Name |
- Type
- string
- Properties
- Create, Filter, Group, Sort, Update
- Description
- The name of the survey invitation that appears in the UI.
|
| OptionsAllowGuestUserResponse |
- Type
- boolean
- Properties
- Create, Filter
- Description
- Determines whether participants who don’t have a Salesforce account can complete the survey.
|
| OptionsAllowParticipantAccessTheirResponse |
- Type
- boolean
- Properties
- Create, Filter
- Description
- Determines whether participants can access a copy of their responses after they complete the survey.
|
| OptionsCollectAnonymousResponse |
- Type
- boolean
- Properties
- Create, Filter
- Description
- Determines whether participants can complete the survey anonymously.
|
| OwnerId |
- Type
- reference
- Properties
- Create, Defaulted on create, Filter, Group, Sort, Update
- Description
- The ID of the user who created the survey invitation.
|
| ParticipantId |
- Type
- reference
- Properties
- Create, Filter, Group, Nillable, Sort
- Description
- The user ID of the participant if the participant is a Salesforce user or contact.
|
| ResponseStatus |
- Type
- picklist
- Properties
- Filter, Group, Sort
- Description
- The status of a participant’s response to the survey
that’s associated with the survey invitation. Possible
values include:
- NotStarted — For an invitation with a
ParticipantID, it means that the
recipient hasn’t opened the survey. For an
invitation without the ParticipantID, it means that none of the
recipients have opened the survey.
- Started — For an invitation with a
ParticipantID, it means that the
recipient opened the survey. For an invitation
without the ParticipantID, it means that the survey
has been opened by at least one recipient.
- Paused — For an invitation with a ParticipantID, it
means that the recipient has paused the survey.
For an invitation without the ParticipantID, it
means that the survey has been paused by any one
of the recipients. Paused isn't available for
invitations in which either OptionsAllowParticipantAccessTheirResponse
or OptionsCollectAnonymousResponse is
true.
- Completed — For an invitation with a
ParticipantID, it means that the
recipient has submitted the survey. For an
invitation without the ParticipantID, it means that the
invitation has been submitted by at least one
recipient.
|
| SurveyId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- The ID of the survey that’s sent in the invitation.
|