URL Expired

The URL for this request expired after 30 days.

surveyarray

companyUuid

uuid

required

parentSurveyUuid

uuid

workerDisplayTitle

string

required

template

object

templateobject

title

string

required

description

object

descriptionobject

conclusionTitle

string

conclusionDescription

object

conclusionDescriptionobject

anonymous

boolean

Defaults to false

truefalse

useDurationNudge

boolean

Defaults to false

truefalse

useSocialProofNudge

boolean

Defaults to false

truefalse

socialProofNudgeMinimum

number

Defaults to 0

conclusionBackButton

boolean

Defaults to false

truefalse

audienceType

string

enum

allsegments

Allowed:

all``segments

cadence

oneShotCadencepulseCadencetriggerCadence oneShotCadenceobject

audienceCount

number

estimatedAudienceCount

number

clickRate

number

Defaults to 0

responseCount

number

responseRate

number

noticeOrPolicyContentEnabled

boolean

Defaults to false

truefalse

noticeOrPolicyContentText

string

nps

boolean

Defaults to false

truefalse

channel

string

enum

workerPortalemailsms

Allowed:

workerPortal``email``sms

segmentUuids

array of uuids

segmentUuids ADD uuid

subtype

object

subtypeobject

triggerSegmentUuids

array of uuids

triggerSegmentUuids ADD uuid

questions

array of objects

questions ADD object

status

string

enum

required

activearchivedcompleteddraftpausedscheduledtemplatedeleted

Show 8 enum values

topLevelAiData

object

topLevelAiDataobject

npsData

object

npsDataobject

activation

object

activationobject

completion

object

completionobject

archivedAt

string

archivedBy

string

pausedAt

string

pausedBy

string

lastNudgedAt

string

lastNudgedBy

string

deletedAt

string

deletedBy

string

activationNotification

object

activationNotificationobject

deadlineNotification

object

deadlineNotificationobject

nudgeIncompleteNotification

object

nudgeIncompleteNotificationobject

nudgeNonRespondantsNotification

object

nudgeNonRespondantsNotificationobject

reminderNotification

object

reminderNotificationobject

statusHistory

array of objects

statusHistory ADD object

lastAiAnalysisMetricsSnapshot

object

lastAiAnalysisMetricsSnapshotobject

``201 One or many survey documents created. Wrapped in a JsonAPI root response.

``500 default error response

{
  "anonymous": false,
  "useDurationNudge": false,
  "useSocialProofNudge": false,
  "socialProofNudgeMinimum": 0,
  "conclusionBackButton": false,
  "clickRate": 0,
  "noticeOrPolicyContentEnabled": false,
  "nps": false,
  "subtype": {
    "dataCollection": {
      "optional": true
    }
  },
  "status": "active",
  "lastAiAnalysisMetricsSnapshot": {
    "responseCount": 0,
    "responseRate": 0
  }
}

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201500

Updatedabout 2 months ago