| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

### Survey Identifier

- **identifier**  
  - uuid  
  - required  
  - survey unique identifier

- **companyUuid**  
  - uuid  
  - required

- **parentSurveyUuid**  
  - uuid

- **workerDisplayTitle**  
  - string  
  - required

### Template

- **template**  
  - object

- **title**  
  - string  
  - required

- **description**  
  - object

### Conclusion

- **conclusionTitle**  
  - string

- **conclusionDescription**  
  - object

### Options

- **anonymous**  
  - boolean  
  - Defaults to false

- **useDurationNudge**  
  - boolean  
  - Defaults to false

- **useSocialProofNudge**  
  - boolean  
  - Defaults to false

- **socialProofNudgeMinimum**  
  - number  
  - Defaults to 0

- **conclusionBackButton**  
  - boolean  
  - Defaults to false

- **audienceType**  
  - string  
  - enum  
  - allowed: all, segments

### Cadence

- **cadence**  
  - oneShotCadence, pulseCadence, triggerCadence  
  - oneShotCadence object

- **audienceCount**  
  - number

- **estimatedAudienceCount**  
  - number

- **clickRate**  
  - number  
  - Defaults to 0

- **responseCount**  
  - number

- **responseRate**  
  - number

- **noticeOrPolicyContentEnabled**  
  - boolean  
  - Defaults to false

- **noticeOrPolicyContentText**  
  - string

- **nps**  
  - boolean  
  - Defaults to false

### Channel

- **channel**  
  - string  
  - enum  
  - allowed: workerPortal, email, sms

### Segment UUIDs

- **segmentUuids**  
  - array of uuids

### Subtypes

- **subtype**  
  - object

- **triggerSegmentUuids**  
  - array of uuids

### Questions

- **questions**  
  - array of objects

### Status

- **status**  
  - string  
  - enum  
  - allowed: active, archived, completed, draft, paused, scheduled, template, deleted

### Top Level AI Data

- **topLevelAiData**  
  - object

### NPS Data

- **npsData**  
  - object

### Activation and Completion

- **activation**  
  - object

- **completion**  
  - object

### Timestamps and Notifications

- **archivedAt**  
  - string

- **archivedBy**  
  - string

- **pausedAt**  
  - string

- **pausedBy**  
  - string

- **lastNudgedAt**  
  - string

- **lastNudgedBy**  
  - string

- **deletedAt**  
  - string

- **deletedBy**  
  - string

### Notifications

- **activationNotification**  
  - object

- **deadlineNotification**  
  - object

- **nudgeIncompleteNotification**  
  - object

- **nudgeNonRespondantsNotification**  
  - object

- **reminderNotification**  
  - object

### Status History

- **statusHistory**  
  - array of objects

### Last AI Analysis Metrics Snapshot

- **lastAiAnalysisMetricsSnapshot**  
  - object

### Survey Update Example

```bash
curl --request PATCH \
     --url https://services.fountain.com/api/servicepulse/surveys/identifier \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{\n  "anonymous": false,\n  "useDurationNudge": false,\n  "useSocialProofNudge": false,\n  "socialProofNudgeMinimum": 0,\n  "conclusionBackButton": false,\n  "clickRate": 0,\n  "noticeOrPolicyContentEnabled": false,\n  "nps": false,\n  "subtype": {\n    "dataCollection": {\n      "optional": true\n    }\n  },\n  "status": "active",\n  "lastAiAnalysisMetricsSnapshot": {\n    "responseCount": 0,\n    "responseRate": 0\n  }\n}'
``

### Response Codes
- **202**: updated survey. Wrapped in a JsonAPI root response.
- **500**: default error response.

**Updated about 2 months ago**