For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Archive survey

Archives an unpublished survey. A survey counts as published while its flag
is enabled, unless it's only in test mode without a schedule; archiving a
published survey returns 409 with error_code: cannot_archive_published.
Unpublish it in Amplitude first. Use dry_run=true to check whether a
survey can be archived. An already archived survey returns 404, like GET.

delete/v1/projects/{project_id}/surveys/{survey_id}

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345
Constraints:pattern: ^[0-9]+$
survey_idstringrequired

Survey nudge identifier.

Constraints:pattern: ^[0-9]+$

Query parameters

dry_runboolean

Validate request without performing mutation.

Default:false

Header parameters

Idempotency-Keystringrequired

Required on write operations. Keys aren't stored yet, so retrying a write with the same key performs it again; a retried create makes another resource. Check whether the first attempt succeeded before you retry.

Constraints:min length: 8max length: 255

Response

application/json

Was this helpful?