Sign in
V3 Surveys

Archive a survey

Archives (soft-deletes) a survey by id. Archived surveys are hidden from the default list, stop collecting responses, and become read-only until restored — a subsequent PATCH returns 422. Works on any survey, including legacy question-based surveys, so this endpoint returns a minimal lifecycle acknowledgement rather than the full survey resource. Session cookie or x-api-key.

post/api/v3/surveys/{surveyId}/archive

Path parameters

surveyIdstring cuid2 required

Survey identifier.

Response

Survey archived successfully

Changes

Changed in 4 of the 21 revisions of this API.501

  • aa2a946d376d5See the full diff
    • ●

      added the new service_unavailable enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new service_unavailable enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new service_unavailable enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new service_unavailable enum value to the code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new service_unavailable enum value to the code response property for the response status 500

      response-property-enum-value-added

  • 252a618df05440See the full diff
    • ●

      added the new conflict enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new conflict enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new conflict enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new conflict enum value to the code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new conflict enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new edge enum value to the invalid_params/items/referenceType response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new edge enum value to the invalid_params/items/referenceType response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new edge enum value to the invalid_params/items/referenceType response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new edge enum value to the invalid_params/items/referenceType response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new edge enum value to the invalid_params/items/referenceType response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new endingCard enum value to the invalid_params/items/referenceType response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new endingCard enum value to the invalid_params/items/referenceType response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new endingCard enum value to the invalid_params/items/referenceType response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new endingCard enum value to the invalid_params/items/referenceType response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new endingCard enum value to the invalid_params/items/referenceType response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new invalid_graph enum value to the invalid_params/items/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_graph enum value to the invalid_params/items/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_graph enum value to the invalid_params/items/code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new invalid_graph enum value to the invalid_params/items/code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_graph enum value to the invalid_params/items/code response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new invalid_workflow_state enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new invalid_workflow_state enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new invalid_workflow_state enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new invalid_workflow_state enum value to the code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new invalid_workflow_state enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new node enum value to the invalid_params/items/referenceType response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new node enum value to the invalid_params/items/referenceType response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new node enum value to the invalid_params/items/referenceType response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new node enum value to the invalid_params/items/referenceType response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new node enum value to the invalid_params/items/referenceType response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new survey enum value to the invalid_params/items/referenceType response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new survey enum value to the invalid_params/items/referenceType response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new survey enum value to the invalid_params/items/referenceType response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new survey enum value to the invalid_params/items/referenceType response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new survey enum value to the invalid_params/items/referenceType response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new workflow_not_executable enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new workflow_not_executable enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new workflow_not_executable enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new workflow_not_executable enum value to the code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new workflow_not_executable enum value to the code response property for the response status 500

      response-property-enum-value-added

  • 9010a37ad0245See the full diff
    • ●

      added the new ai_output_too_long enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new ai_output_too_long enum value to the code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new ai_output_too_long enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new ai_output_too_long enum value to the code response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new ai_output_too_long enum value to the code response property for the response status 500

      response-property-enum-value-added

  • b6ff6735daa61See the full diff
    • ○

      endpoint added

      endpoint-added