---
title: "Archive a List"
method: DELETE
path: "/lists/{list-id}"
tags: ["lists"]
---

# Archive a List

`DELETE /lists/{list-id}`

## Request

- Base URL: `https://api.withpersona.com/api/v1`
- URL: `https://api.withpersona.com/api/v1/lists/{list-id}`
- Auth: HTTP bearer

Archive an existing list. Archived lists are still retrievable, but will no longer match on inquiries.

## Path parameters

- `list-id` string, required

## Query parameters

- `include` string
- `fields` object

## Headers

- `Key-Inflection` 'camel' | 'kebab' | 'snake'
- `Idempotency-Key` string
- `Persona-Version` '2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18': Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).

## Response `200`

This endpoint returns a List object.

- ListsArchiveAListResponse200
  - `data` union, required
    - object: A Browser Fingerprint List object
      - `type` 'list/browser-fingerprint', required: Discriminator value: list/browser-fingerprint
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListBrowserFingerprintRelationships
        - `list-items` ListDiscriminatorMappingListBrowserFingerprintRelationshipsListItems
          - `data` ListDiscriminatorMappingListBrowserFingerprintRelationshipsListItemsDataItems[]
    - object: A Country List object
      - `type` 'list/country', required: Discriminator value: list/country
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListCountryRelationships
        - `list-items` ListDiscriminatorMappingListCountryRelationshipsListItems
          - `data` ListDiscriminatorMappingListCountryRelationshipsListItemsDataItems[]
    - object: A Email Address List object
      - `type` 'list/email-address', required: Discriminator value: list/email-address
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListEmailAddressRelationships
        - `list-items` ListDiscriminatorMappingListEmailAddressRelationshipsListItems
          - `data` ListDiscriminatorMappingListEmailAddressRelationshipsListItemsDataItems[]
    - object: A Face List object IMPORTANT: You must ensure proper consent for processing of biometrics is in place prior to using face Lists.
      - `type` 'list/face', required: Discriminator value: list/face
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListFaceRelationships
        - `list-items` ListDiscriminatorMappingListFaceRelationshipsListItems
          - `data` ListDiscriminatorMappingListFaceRelationshipsListItemsDataItems[]
    - object: A Geolocation List object
      - `type` 'list/geolocation', required: Discriminator value: list/geolocation
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListGeolocationRelationships
        - `list-items` ListDiscriminatorMappingListGeolocationRelationshipsListItems
          - `data` ListDiscriminatorMappingListGeolocationRelationshipsListItemsDataItems[]
    - object: A Government Id Number List object
      - `type` 'list/government-id-number', required: Discriminator value: list/government-id-number
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListGovernmentIdNumberRelationships
        - `list-items` ListDiscriminatorMappingListGovernmentIdNumberRelationshipsListItems
          - `data` ListDiscriminatorMappingListGovernmentIdNumberRelationshipsListItemsDataItems[]
    - object: A Ip Address List object
      - `type` 'list/ip-address', required: Discriminator value: list/ip-address
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListIpAddressRelationships
        - `list-items` ListDiscriminatorMappingListIpAddressRelationshipsListItems
          - `data` ListDiscriminatorMappingListIpAddressRelationshipsListItemsDataItems[]
    - object: A Name List object
      - `type` 'list/name', required: Discriminator value: list/name
      - `id` string
      - `attributes` ListDiscriminatorMappingListNameAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
        - `allow-fuzzy-name-first` boolean
      - `relationships` ListDiscriminatorMappingListNameRelationships
        - `list-items` ListDiscriminatorMappingListNameRelationshipsListItems
          - `data` ListDiscriminatorMappingListNameRelationshipsListItemsDataItems[]
    - object: A Phone Number List object
      - `type` 'list/phone-number', required: Discriminator value: list/phone-number
      - `id` string
      - `attributes` ListsSharedAttributes
        - `name` string
        - `status` string
        - `archived-at` string, date-time, nullable
        - `created-at` string, date-time
        - `updated-at` string, date-time
      - `relationships` ListDiscriminatorMappingListPhoneNumberRelationships
        - `list-items` ListDiscriminatorMappingListPhoneNumberRelationshipsListItems
          - `data` ListDiscriminatorMappingListPhoneNumberRelationshipsListItemsDataItems[]

## Other responses

- `400`: The request was unacceptable, often due to invalid parameters.
- `401`: An invalid API key was provided.
- `403`: The given API key doesn’t have permissions to perform the request or a quota has been exceeded.
- `404`: The requested resource doesn’t exist.
- `409`: The request conflicts with another request, often due to attempting to create a duplicate resource.
- `422`: The request modifies the resource in an unacceptable way, often due to an invalid action or parameter.
- `429`: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests.

---

[API](https://skmtc.dev/withpersona/apis/withpersona-8.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-8/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-8/revisions/3683a7f9e1fe?raw)