---
title: "Archive form"
method: PATCH
path: "/forms/{id}/archive"
tags: ["Forms"]
---

# Archive form

`PATCH /forms/{id}/archive`

## Request

- Base URL: `https://api.crevio.co/v1`
- URL: `https://api.crevio.co/v1/forms/{id}/archive`
- Auth: API key in header `Authorization`

Soft-deletes a Form by setting archived_at. The form stops appearing in the active list but its fields and submissions are preserved. Idempotent.

## Response `200`

Archived form

- Form
  - `id` string, required
  - `object` string, required
  - `name` string, required
  - `redirect_url` string, nullable, required
  - `settings` object, required
  - `archived_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `confirmation_required` boolean, required
  - `tag_ids` string[], required
  - `delivery_url` string, nullable, required
  - `delivery_subject` string, nullable, required
  - `delivery_message` string, nullable, required
  - `delivery_type` 'none' | 'file' | 'link' | 'experience', required
  - `delivery_file` object, nullable, required
  - `experience_id` string, nullable, required
  - `submissions_count` number, required
  - `form_fields` FormField[], required
    - `id` string, required
    - `object` string, required
    - `name` string, required
    - `field_type` 'email' | 'text' | 'phone' | 'textarea' | 'radio' | 'select' | 'checkbox' | 'consent', required
    - `required` boolean, nullable, required
    - `position` integer, nullable, required
    - `options` string[], required

## Other responses

- `401`: Authentication required
- `403`: Forbidden
- `404`: Resource not found
- `422`: Validation error
- `429`: Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`.
- `500`: Internal server error

---

[API](https://skmtc.dev/crevio/apis/crevio-api-v1.md) · [All operations](https://skmtc.dev/crevio/apis/crevio-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/crevio/apis/crevio-api-v1/revisions/2219f18ad651?raw)