---
title: "partially update one existing survey"
method: PATCH
path: "/api/servicepulse/surveys/{identifier}"
tags: ["surveys"]
---

# partially update one existing survey

`PATCH /api/servicepulse/surveys/{identifier}`

Partially update one existing survey

## Path parameters

- `identifier` string, uuid, required

## Request body

- Survey
  - `uuid` string, uuid
  - `createdAt` string, date-time
  - `createdBy` string, uuid
  - `lastUpdatedAt` string, date-time
  - `lastUpdatedBy` string, uuid
  - `lastUpdatedByAudience` string
  - `lastUpdatedByAudienceUuid` string, uuid
  - `lastUpdatedByImpersonatedBy` string, uuid
  - `lastUpdatedByCompanyUuid` string, uuid
  - `lastUpdatedByEnterpriseUuid` string, uuid
  - `companyUuid` string, uuid, required
  - `parentSurveyUuid` string, uuid
  - `workerDisplayTitle` string, required
  - `template` SurveyTemplate
    - `title` string, required
    - `description` string
  - `title` string, required
  - `description` RichTextField
    - `html` string, required
    - `plainText` string, required
  - `conclusionTitle` string
  - `conclusionDescription` RichTextField
    - `html` string, required
    - `plainText` string, required
  - `anonymous` boolean
  - `useDurationNudge` boolean
  - `useSocialProofNudge` boolean
  - `socialProofNudgeMinimum` number
  - `conclusionBackButton` boolean
  - `audienceType` 'all' | 'segments'
  - `cadence` union
    - object
      - `type` 'oneShot', required
    - object
      - `type` 'pulse', required
      - `recurrence` union, required
        - object
          - `time` string, required
          - `timezone` string, required
          - `type` 'daily', required
        - object
          - `time` string, required
          - `timezone` string, required
          - `type` 'weekly', required
          - `dayOfWeek` number, required
        - object
          - `time` string, required
          - `timezone` string, required
          - `type` 'monthly', required
          - `dayOfMonth` number, required
        - object
          - `time` string, required
          - `timezone` string, required
          - `type` 'quarterly', required
          - `dayOfMonth` number, required
          - `monthOfYear` number, required
        - object
          - `time` string, required
          - `timezone` string, required
          - `type` 'yearly', required
          - `dayOfMonth` number, required
          - `monthOfYear` number, required
    - object
      - `type` 'trigger', required
  - `audienceCount` number
  - `estimatedAudienceCount` number
  - `clickRate` number
  - `responseCount` number
  - `responseRate` number
  - `noticeOrPolicyContentEnabled` boolean
  - `noticeOrPolicyContentText` string
  - `nps` boolean
  - `channel` 'workerPortal' | 'email' | 'sms'
  - `segmentUuids` string[]
  - `subtype` Subtype
    - `type` 'default' | 'publicShareable', required
    - `dataCollection` object
      - `enabled` boolean, required
      - `displayTitle` string
      - `optional` boolean
      - `attributesToCollect` SurveyDataCollectionAttribute[]
        - `label` string, required
        - `key` string, required
        - `dataType` 'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument', required
    - `brandUuid` string, uuid
    - `publicUrl` string
  - `triggerSegmentUuids` string[]
  - `questions` Question[]
    - union
      - object
        - `prompt` string, required
        - `description` string
        - `position` number, required
        - `theme` string[]
        - `uuid` string, uuid
        - `options` object
          - `optional` boolean
          - `excludeFromAIAnalysis` boolean
        - `aiData` AiData
          - `sentimentAnalysis` number
          - `confidence` number
          - `analysisText` string
          - `negativeThemes` string[]
          - `positiveThemes` string[]
        - `type` 'booleanQuestion', required
        - `category` 'Yes/No' | 'Thumbs Up/Down' | 'True/False', required
        - `additionalOptions` object
          - `allowMultiSelect` boolean
      - object
        - `prompt` string, required
        - `description` string
        - `position` number, required
        - `theme` string[]
        - `uuid` string, uuid
        - `options` object
          - `optional` boolean
          - `excludeFromAIAnalysis` boolean
        - `aiData` AiData
          - `sentimentAnalysis` number
          - `confidence` number
          - `analysisText` string
          - `negativeThemes` string[]
          - `positiveThemes` string[]
        - `type` 'choicesQuestion', required
        - `choiceOptions` ChoiceOption[], required
          - `text` string, required
          - `position` number, required
        - `additionalOptions` object
          - `allowMultiSelect` boolean
      - object
        - `prompt` string, required
        - `description` string
        - `position` number, required
        - `theme` string[]
        - `uuid` string, uuid
        - `options` object
          - `optional` boolean
          - `excludeFromAIAnalysis` boolean
        - `aiData` AiData
          - `sentimentAnalysis` number
          - `confidence` number
          - `analysisText` string
          - `negativeThemes` string[]
          - `positiveThemes` string[]
        - `type` 'fiveScaleQuestion', required
        - `category` 'Emojis' | 'Level of Agreement' | 'Satisfaction Level' | 'Frequency' | 'Likelihood' | 'Quality' | '5 Stars'
        - `questionBankUuid` string
        - `additionalOptions` object
          - `invertOrder` boolean
      - object
        - `prompt` string, required
        - `description` string
        - `position` number, required
        - `theme` string[]
        - `uuid` string, uuid
        - `options` object
          - `optional` boolean
          - `excludeFromAIAnalysis` boolean
        - `aiData` AiData
          - `sentimentAnalysis` number
          - `confidence` number
          - `analysisText` string
          - `negativeThemes` string[]
          - `positiveThemes` string[]
        - `type` 'likertScaleQuestion', required
        - `maxLabel` string, required
        - `minLabel` string, required
      - object
        - `prompt` string, required
        - `description` string
        - `position` number, required
        - `theme` string[]
        - `uuid` string, uuid
        - `options` object
          - `optional` boolean
          - `excludeFromAIAnalysis` boolean
        - `aiData` AiData
          - `sentimentAnalysis` number
          - `confidence` number
          - `analysisText` string
          - `negativeThemes` string[]
          - `positiveThemes` string[]
        - `type` 'openQuestion', required
        - `additionalOptions` object
          - `limitCharacters` boolean
          - `limitCharacterCount` number
  - `status` 'active' | 'archived' | 'completed' | 'draft' | 'paused' | 'scheduled' | 'template' | 'deleted', required
  - `topLevelAiData` TopLevelAiData
    - `averageSentiment` number
    - `analysisText` string
    - `aiKeyInsights` object[]
      - `analysisText` string
      - `insightName` string
      - `sentimentAnalysis` number
    - `status` 'completed' | 'errored' | 'notStarted' | 'pending' | 'skipped'
  - `npsData` object
    - `npsScore` number
    - `lastUpdatedAt` string
  - `activation` Activation
    - `startTz` string, required
    - `startDate` string, required
    - `endTz` string, nullable
    - `endDate` string, nullable
    - `totalResponseCutoff` number, nullable
    - `sendReminderDaysBefore` number, nullable
    - `cooldownInDays` number
  - `completion` Completion
    - `completedAt` string, required
    - `completionMethod` string, required
  - `archivedAt` string
  - `archivedBy` string
  - `pausedAt` string
  - `pausedBy` string
  - `lastNudgedAt` string
  - `lastNudgedBy` string
  - `deletedAt` string
  - `deletedBy` string
  - `activationNotification` Notification
    - `email` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `subject` string
      - `body` object
        - `html` string
        - `plainText` string
    - `sms` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `body` object
        - `html` string
        - `plainText` string
  - `deadlineNotification` Notification
    - `email` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `subject` string
      - `body` object
        - `html` string
        - `plainText` string
    - `sms` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `body` object
        - `html` string
        - `plainText` string
  - `nudgeIncompleteNotification` Notification
    - `email` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `subject` string
      - `body` object
        - `html` string
        - `plainText` string
    - `sms` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `body` object
        - `html` string
        - `plainText` string
  - `nudgeNonRespondantsNotification` Notification
    - `email` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `subject` string
      - `body` object
        - `html` string
        - `plainText` string
    - `sms` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `body` object
        - `html` string
        - `plainText` string
  - `reminderNotification` ReminderNotification
    - `email` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `subject` string
      - `body` object
        - `html` string
        - `plainText` string
    - `sms` object
      - `enabled` boolean, required
      - `campaignUuid` string
      - `body` object
        - `html` string
        - `plainText` string
    - `reminderLimit` number
    - `sendDaysAfter` number
    - `recurringIntervalDays` number
    - `recurringEnabled` boolean
  - `statusHistory` object[]
    - `status` 'active' | 'archived' | 'completed' | 'draft' | 'paused' | 'scheduled' | 'template' | 'deleted'
    - `updatedAt` string
    - `updatedBy` string
  - `lastAiAnalysisMetricsSnapshot` object
    - `audienceCount` number
    - `clickRate` number
    - `responseCount` number
    - `responseRate` number
    - `updatedAt` string
    - `updatedBy` string

## Response `202`

updated survey. Wrapped in a JsonAPI root response.

- object
  - `data` Survey
    - `uuid` string, uuid
    - `createdAt` string, date-time
    - `createdBy` string, uuid
    - `lastUpdatedAt` string, date-time
    - `lastUpdatedBy` string, uuid
    - `lastUpdatedByAudience` string
    - `lastUpdatedByAudienceUuid` string, uuid
    - `lastUpdatedByImpersonatedBy` string, uuid
    - `lastUpdatedByCompanyUuid` string, uuid
    - `lastUpdatedByEnterpriseUuid` string, uuid
    - `companyUuid` string, uuid, required
    - `parentSurveyUuid` string, uuid
    - `workerDisplayTitle` string, required
    - `template` SurveyTemplate
      - `title` string, required
      - `description` string
    - `title` string, required
    - `description` RichTextField
      - `html` string, required
      - `plainText` string, required
    - `conclusionTitle` string
    - `conclusionDescription` RichTextField
      - `html` string, required
      - `plainText` string, required
    - `anonymous` boolean
    - `useDurationNudge` boolean
    - `useSocialProofNudge` boolean
    - `socialProofNudgeMinimum` number
    - `conclusionBackButton` boolean
    - `audienceType` 'all' | 'segments'
    - `cadence` union
      - object
        - `type` 'oneShot', required
      - object
        - `type` 'pulse', required
        - `recurrence` union, required
          - object
            - `time` string, required
            - `timezone` string, required
            - `type` 'daily', required
          - object
            - `time` string, required
            - `timezone` string, required
            - `type` 'weekly', required
            - `dayOfWeek` number, required
          - object
            - `time` string, required
            - `timezone` string, required
            - `type` 'monthly', required
            - `dayOfMonth` number, required
          - object
            - `time` string, required
            - `timezone` string, required
            - `type` 'quarterly', required
            - `dayOfMonth` number, required
            - `monthOfYear` number, required
          - object
            - `time` string, required
            - `timezone` string, required
            - `type` 'yearly', required
            - `dayOfMonth` number, required
            - `monthOfYear` number, required
      - object
        - `type` 'trigger', required
    - `audienceCount` number
    - `estimatedAudienceCount` number
    - `clickRate` number
    - `responseCount` number
    - `responseRate` number
    - `noticeOrPolicyContentEnabled` boolean
    - `noticeOrPolicyContentText` string
    - `nps` boolean
    - `channel` 'workerPortal' | 'email' | 'sms'
    - `segmentUuids` string[]
    - `subtype` Subtype
      - `type` 'default' | 'publicShareable', required
      - `dataCollection` object
        - `enabled` boolean, required
        - `displayTitle` string
        - `optional` boolean
        - `attributesToCollect` SurveyDataCollectionAttribute[]
          - `label` string, required
          - `key` string, required
          - `dataType` 'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument', required
      - `brandUuid` string, uuid
      - `publicUrl` string
    - `triggerSegmentUuids` string[]
    - `questions` Question[]
      - union
        - object
          - `prompt` string, required
          - `description` string
          - `position` number, required
          - `theme` string[]
          - `uuid` string, uuid
          - `options` object
            - `optional` boolean
            - `excludeFromAIAnalysis` boolean
          - `aiData` AiData
            - `sentimentAnalysis` number
            - `confidence` number
            - `analysisText` string
            - `negativeThemes` string[]
            - `positiveThemes` string[]
          - `type` 'booleanQuestion', required
          - `category` 'Yes/No' | 'Thumbs Up/Down' | 'True/False', required
          - `additionalOptions` object
            - `allowMultiSelect` boolean
        - object
          - `prompt` string, required
          - `description` string
          - `position` number, required
          - `theme` string[]
          - `uuid` string, uuid
          - `options` object
            - `optional` boolean
            - `excludeFromAIAnalysis` boolean
          - `aiData` AiData
            - `sentimentAnalysis` number
            - `confidence` number
            - `analysisText` string
            - `negativeThemes` string[]
            - `positiveThemes` string[]
          - `type` 'choicesQuestion', required
          - `choiceOptions` ChoiceOption[], required
            - `text` string, required
            - `position` number, required
          - `additionalOptions` object
            - `allowMultiSelect` boolean
        - object
          - `prompt` string, required
          - `description` string
          - `position` number, required
          - `theme` string[]
          - `uuid` string, uuid
          - `options` object
            - `optional` boolean
            - `excludeFromAIAnalysis` boolean
          - `aiData` AiData
            - `sentimentAnalysis` number
            - `confidence` number
            - `analysisText` string
            - `negativeThemes` string[]
            - `positiveThemes` string[]
          - `type` 'fiveScaleQuestion', required
          - `category` 'Emojis' | 'Level of Agreement' | 'Satisfaction Level' | 'Frequency' | 'Likelihood' | 'Quality' | '5 Stars'
          - `questionBankUuid` string
          - `additionalOptions` object
            - `invertOrder` boolean
        - object
          - `prompt` string, required
          - `description` string
          - `position` number, required
          - `theme` string[]
          - `uuid` string, uuid
          - `options` object
            - `optional` boolean
            - `excludeFromAIAnalysis` boolean
          - `aiData` AiData
            - `sentimentAnalysis` number
            - `confidence` number
            - `analysisText` string
            - `negativeThemes` string[]
            - `positiveThemes` string[]
          - `type` 'likertScaleQuestion', required
          - `maxLabel` string, required
          - `minLabel` string, required
        - object
          - `prompt` string, required
          - `description` string
          - `position` number, required
          - `theme` string[]
          - `uuid` string, uuid
          - `options` object
            - `optional` boolean
            - `excludeFromAIAnalysis` boolean
          - `aiData` AiData
            - `sentimentAnalysis` number
            - `confidence` number
            - `analysisText` string
            - `negativeThemes` string[]
            - `positiveThemes` string[]
          - `type` 'openQuestion', required
          - `additionalOptions` object
            - `limitCharacters` boolean
            - `limitCharacterCount` number
    - `status` 'active' | 'archived' | 'completed' | 'draft' | 'paused' | 'scheduled' | 'template' | 'deleted', required
    - `topLevelAiData` TopLevelAiData
      - `averageSentiment` number
      - `analysisText` string
      - `aiKeyInsights` object[]
        - `analysisText` string
        - `insightName` string
        - `sentimentAnalysis` number
      - `status` 'completed' | 'errored' | 'notStarted' | 'pending' | 'skipped'
    - `npsData` object
      - `npsScore` number
      - `lastUpdatedAt` string
    - `activation` Activation
      - `startTz` string, required
      - `startDate` string, required
      - `endTz` string, nullable
      - `endDate` string, nullable
      - `totalResponseCutoff` number, nullable
      - `sendReminderDaysBefore` number, nullable
      - `cooldownInDays` number
    - `completion` Completion
      - `completedAt` string, required
      - `completionMethod` string, required
    - `archivedAt` string
    - `archivedBy` string
    - `pausedAt` string
    - `pausedBy` string
    - `lastNudgedAt` string
    - `lastNudgedBy` string
    - `deletedAt` string
    - `deletedBy` string
    - `activationNotification` Notification
      - `email` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `subject` string
        - `body` object
          - `html` string
          - `plainText` string
      - `sms` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `body` object
          - `html` string
          - `plainText` string
    - `deadlineNotification` Notification
      - `email` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `subject` string
        - `body` object
          - `html` string
          - `plainText` string
      - `sms` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `body` object
          - `html` string
          - `plainText` string
    - `nudgeIncompleteNotification` Notification
      - `email` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `subject` string
        - `body` object
          - `html` string
          - `plainText` string
      - `sms` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `body` object
          - `html` string
          - `plainText` string
    - `nudgeNonRespondantsNotification` Notification
      - `email` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `subject` string
        - `body` object
          - `html` string
          - `plainText` string
      - `sms` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `body` object
          - `html` string
          - `plainText` string
    - `reminderNotification` ReminderNotification
      - `email` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `subject` string
        - `body` object
          - `html` string
          - `plainText` string
      - `sms` object
        - `enabled` boolean, required
        - `campaignUuid` string
        - `body` object
          - `html` string
          - `plainText` string
      - `reminderLimit` number
      - `sendDaysAfter` number
      - `recurringIntervalDays` number
      - `recurringEnabled` boolean
    - `statusHistory` object[]
      - `status` 'active' | 'archived' | 'completed' | 'draft' | 'paused' | 'scheduled' | 'template' | 'deleted'
      - `updatedAt` string
      - `updatedBy` string
    - `lastAiAnalysisMetricsSnapshot` object
      - `audienceCount` number
      - `clickRate` number
      - `responseCount` number
      - `responseRate` number
      - `updatedAt` string
      - `updatedBy` string
  - `meta` ResponsesPartMeta
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `status` string
    - `duration` number
    - `size` number

## Other responses

- `500` — default error response

---

[API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/versions/5f406c0e9462/schema)