AssignSurvey

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

The AssignSurvey action assigns a survey to a record, enabling collection of structured feedback, assessments, or questionnaire responses. The survey is linked to the specified record and can be sent to designated recipients for completion.

How It Works

When executed, the AssignSurvey action:

  1. Retrieves the survey template specified by the surveyId parameter
  2. Creates a survey assignment linked to the record specified by domainName and domainKey
  3. Optionally sends the survey to designated recipients via email
  4. Tracks survey status (assigned, sent, completed, etc.)
  5. Associates completed survey responses with the parent record

Survey assignments are configured at the Survey Template level, not the domain level.

The survey template defines which domain(s) it can be assigned to - not the other way around.

Path Params
string
required

The AssignSurvey action can operate on any domain that supports survey assignments:

DomainCommon Use Cases
ClaimClaimant satisfaction surveys, injury assessment questionnaires
IncidentWitness statements, incident investigation surveys
PolicyPolicyholder feedback, renewal questionnaires
ContactCustomer satisfaction, vendor assessments
LocationSite assessments, safety inspections
AuditAudit questionnaires, compliance checklists
integer
required

This is the ID of the record for which the survey is being generated.

Body Params
parameters
object
required
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json