Skip to main content
PUT
Update an existing survey

承認

Authorization
string
header
必須

For authenticated requests, set the Authorization: Bearer your_api_key parameter in the header.
You can create and manage your API Keys by visiting the API Keys tab in the Settings page of your organization in Admina

パスパラメータ

organizationId
number
必須
surveyId
number
必須

ボディ

application/json
surveyName
string
必須

Name of the survey

:

"Device Ownership Survey"

category
string
必須

Category of the survey

:

"device_ownership"

targetType
enum<string>
必須

Type of targets for the survey

利用可能なオプション:
employees,
devices,
services,
services_by_identities,
devices_by_identities
:

"employees"

questions
object[]
必須

Array of survey questions

targets
object[]
必須

Array of survey targets

scheduledLaunchAt
string<date-time>
必須

Scheduled launch date and time for the survey

:

"2024-01-15T10:00:00Z"

description
string

Optional description of the survey

:

"Survey to collect device ownership information from employees"

deliveryEnableEmail
boolean

Enable email delivery for the survey

:

true

deliveryEnableSlack
boolean

Enable Slack delivery for the survey

:

false

deliverySlackNotificationCredentialId
number

Notification credential ID for Slack delivery. Required when deliveryEnableSlack is true.

:

1

isScheduleLaunch
boolean

Whether the survey should be scheduled for launch

:

false

deadlineAt
string<date-time>

Deadline date and time for the survey responses

:

"2024-01-30T23:59:59Z"

reminderConfig
object

Reminder configuration for the survey

destinationType
enum<string>

Destination type for the survey

利用可能なオプション:
resource_holder,
holder_manager
:

"resource_holder"

レスポンス

Successfully updated survey

id
number
必須
read-only
:

1

surveyName
string
必須
read-only
:

"Employee Device Survey"

description
string | null
必須
read-only
:

"Survey to understand device usage"

status
enum<string>
必須
read-only
利用可能なオプション:
draft,
published,
launched,
completed,
revoked
:

"draft"

category
string
必須
read-only
:

"device_ownership"

targetType
enum<string>
必須
read-only
利用可能なオプション:
employees,
devices,
services,
services_by_identities,
devices_by_identities
:

"employees"

questions
object[]
必須
read-only
:
deliveryEnableEmail
boolean
必須
read-only
:

true

deliveryEnableSlack
boolean
必須
read-only
:

false

isScheduleLaunch
boolean
必須
read-only
:

false

scheduledLaunchAt
string<date-time> | null
必須
read-only
:

null

deadlineAt
string<date-time> | null
必須
read-only
:

null

destinationType
enum<string>
必須
read-only
利用可能なオプション:
resource_holder,
holder_manager
:

"resource_holder"

createdAt
string<date-time>
必須
read-only
:

"2026-09-15T10:06:24.085Z"

updatedAt
string<date-time>
必須
read-only
:

"2026-09-15T10:06:24.085Z"

totalTargets
number
read-only
:

5

totalResponses
number
read-only
:

3

最終更新日 2026年9月15日