Skip to main content
PATCH
Update survey

Authorizations

Authorization
string
header
required

OAuth2 access token obtained via the authorization flow. Include in the Authorization header as: Bearer {access_token}

Path Parameters

id
string
required

Survey GUID

Body

application/json
name
string

Survey name (1-255 characters, trimmed)

Required string length: 1 - 255
tags
object[]

Tags to replace all existing tags. Each item has either id or name.

Maximum array length: 10
projectId

Project GUID (string) or numeric ID to associate, or null to remove project. Mutually exclusive with projects.

projects
(string | number)[]

Project GUIDs (or numeric IDs) to associate the survey with. Replace-all semantics. Mutually exclusive with projectId.

Maximum array length: 50
questions
object[]

Questions to replace all existing questions (replace-all semantics)

Required array length: 1 - 24 elements
targeting
string[]

Targeting trait permalinks (replace-all semantics)

reporting
string[]

Reporting trait permalinks (replace-all semantics)

country
string

Two-letter country code (e.g. US)

sampleSize
string

Number of respondents. Standard polls: "15", "30", "50", "75", "100", "200", "300", "500". Screen recording polls: "5", "10", "15", "20", "25", "30", "50", "75" (max 75).

surveyIntent
string

Original intent of the survey as interpreted by AI (max 255 characters)

Maximum string length: 255

Response

Default Response

success
boolean
data
object

Full survey data including questions, options, and metadata

cost
object

Cost information for the survey