> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trusset.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Archive Customer

> Soft-delete a customer by marking it as archived

Archives a customer record. Archived customers are excluded from list queries by default but can be included by passing `includeArchived=true`. This is a soft delete - no data is permanently removed.

## Path Parameters

<ParamField path="customerId" type="string" required>
  Customer ID.
</ParamField>

## Response Fields

<ResponseField name="success" type="boolean">Request status</ResponseField>

<ResponseField name="data" type="object">
  <Expandable>
    <ResponseField name="archived" type="boolean">Always `true` on success</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X DELETE "https://api.trusset.org/customers/api/manage/cust_abc123" \
    -H "X-API-Key: trusset_abc123xy_secret..."
  ```

  ```typescript TypeScript theme={null}
  const response = await fetch(
    'https://api.trusset.org/customers/api/manage/cust_abc123',
    {
      method: 'DELETE',
      headers: { 'X-API-Key': 'trusset_abc123xy_secret...' }
    }
  );
  const { data } = await response.json();
  // data.archived === true
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "success": true,
    "data": {
      "archived": true
    },
    "metadata": {
      "requestId": "550e8400-e29b-41d4-a716-446655440000",
      "timestamp": "2025-06-15T12:00:00.000Z"
    }
  }
  ```
</ResponseExample>