Skip to main content
POST
/
api
/
v1-beta
/
customers
/
{id}
/
entities
/
archive
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const response = await client.v1Beta.customers.entities.archive('id', {
  ids: ['user-7f3a0c1d', 'user-c4d1b2e9'],
});

console.log(response.data);
{
  "data": {
    "ids": [
      "user-7f3a0c1d",
      "user-c4d1b2e9"
    ]
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Headers

​
X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

​
X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

​
id
string
required

The customer identifier (owner) the entities belong to

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$

Body

application/json

List of entity identifiers to act on in bulk (1-100 entries)

​
ids
string[]
required

Entity identifiers to act on

Required array length: 1 - 100 elements

The unique identifier for the entity

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

Response

No content.

Wrapped response echoing the ids that were acted on by an archive/unarchive call

​
data
EntityIdsResponse · object
required

List of entity identifiers that were acted on