Update a survey

Arbitrary JSON survey context for customer- or operation-specific metadata. v3 preserves arbitrary metadata values as-is. If present, title and description are treated as translatable text maps and returned with real locale-code keys.

Replaces the survey language configuration. The default language cannot be changed through PATCH; any default: true entry must match the existing default language. Languages referenced by metadata, welcomeCard, blocks, or endings translatable maps must be explicitly declared here, so remove the locale key from those maps as well when intentionally removing a language.

Optional card shown before the first survey block.

Hidden fields, sometimes called embedded data in other survey products. Field ids are stable public identifiers and may be referenced by logic, recall, quotas, integrations, and response data. Use only letters, numbers, underscores, and hyphens; avoid spaces and reserved ids.

App-survey runtime/display settings. Only valid for type: app; rejected for link surveys. Replacement semantics (destructive): when distribution is provided on PATCH it fully replaces the stored object — any sub-field you omit is reset to its default, NOT preserved. In particular, omitting triggers removes ALL existing triggers, and omitting displayOption resets it to displayOnce. To change one setting, send the complete desired distribution. To leave distribution untouched, omit the whole distribution key.

App-survey contact targeting. Only valid for type: app. filters: [] targets everyone. Setting or changing non-empty filters requires the Contacts entitlement; otherwise create/patch returns 403.

attribute filters reference workspace contact-attribute keys (discover them via GET /api/v3/contact-attribute-keys) and segment filters reference other segment ids — both are workspace-scoped resources you must obtain before constructing filters (an invalid key/id targets no one rather than erroring). See SegmentFilter for the per-root.type operator sets.