Skip to main content
PUT
Set the survey frequency rule

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.

Body

application/json
recontactDays
integer
required

Days after any survey contact (email sent, in-app shown, answered, or imported answer) before the same person is surveyed again. 0 turns the rule off. Default 30.

Required range: 0 <= x <= 365
dismissedRecontactDays
integer
required

Days after someone dismisses an in-app survey before any in-app survey shows to them again. 0 turns the rule off. Default 7.

Required range: 0 <= x <= 365
companyLimit
object | null

Optional Company limit: ask at most people different people at one Company within days, across every survey and channel. People are matched by email address, so a person counts once however often they are asked, and reminders don't count. null means no limit, which is the default. Leave it out of a PUT to keep the saved limit.

Response

The saved rule.

data
object
required