Skip to main content
PATCH
Update a survey

Authorizations

Authorization
string
header
required

Bearer API key. Secret server keys start with gt_live_; client-safe browser keys start with gt_pub_ (write-only, origin-pinned). Create and scope keys in Settings → API Keys.

Path Parameters

id
string<uuid>
required

The survey's UUID.

Body

application/json

Any subset of the survey contract. settings keys you send replace the matching top-level settings keys, and the rest are kept. A nested object such as reminders is replaced as a whole.

name
string
Required string length: 1 - 255
type
enum<string>

nps is a 0-10 scale. csat and ces use a 1-5 or 1-7 scale. custom has no band and its responses are unscored. For nps, csat and ces, the first question must be a required rating or scale question: it carries the score.

Available options:
nps,
csat,
ces,
custom
questions
object[]
Required array length: 1 - 20 elements
settings
object

Optional survey settings. Unknown keys are rejected.

cooldownDays
integer

Minimum days since this person last got a survey of the same measure (an email sent, an invited answer or an in-app view) before this survey can invite them or show to them in-app. It doesn't block responses you record through the API.

Required range: 0 <= x <= 730

Response

The updated survey.

data
object
required