---
title: "Archive customers"
method: POST
path: "/api/v1/business/customers/archive"
tags: ["business"]
---

# Archive customers

`POST /api/v1/business/customers/archive`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/business/customers/archive`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

Archive up to 100 customers: they leave every future campaign and stay listed under the archived filter, where business_customers_restore brings them back. Read business_customer_lifecycle_impacts_get first to see which campaigns they leave.

## Headers

- `Point11-Organization` string, uuid
- `Idempotency-Key` string, uuid, required

## Request body

- BusinessCustomersArchiveRequest
  - `customerIds` string[], required: The customers' ids (1–1000)

## Response `200`

Success.

- BusinessCustomersArchiveResponse
  - `command` 'archive' | 'restore' | 'delete', required
  - `changedCustomers` integer, required
  - `removedFutureMemberships` object, required
    - `discovery` integer, required
    - `research` integer, required
    - `experience` integer, required
    - `total` integer, required
  - `impact` BusinessImpact, required
    - `selectedCount` integer, required
    - `foundCount` integer, required
    - `customers` object[], required
      - `customerId` string, uuid, required
      - `discovery` object, required
        - `activeExecutionCount` integer, required
        - `futureMembershipCount` integer, required
        - `historicalReferenceCount` integer, required
      - `research` object, required
        - `activeExecutionCount` integer, required
        - `futureMembershipCount` integer, required
        - `historicalReferenceCount` integer, required
      - `experience` object, required
        - `activeExecutionCount` integer, required
        - `futureMembershipCount` integer, required
        - `historicalReferenceCount` integer, required
      - `activeExecution` boolean, required
      - `futureMembership` boolean, required
      - `historicalReference` boolean, required
    - `totals` object, required
      - `activeExecutionCount` integer, required
      - `futureMembershipCount` integer, required
      - `historicalReferenceCount` integer, required

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `402`: Billing refused the write: the code names the reason and `details.reason` carries it.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

[API](https://skmtc.dev/point11/apis/point11-api.md) · [All operations](https://skmtc.dev/point11/apis/point11-api/llms.txt) · [OpenAPI document](https://skmtc.dev/point11/apis/point11-api/revisions/36a84c7aca11?raw)