Archive a card group

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

cardGroupId

string

required

Card group id with the card_group_ prefix.

Response

The archived card group.

string

required

Card group id with the card_group_ prefix.

Example:

"card_group_2rj4l7hmrrrcv"

name

string

required

Example:

"Marketing"

status

enum<string>

required

Available options:

active,

archived

createdAt

string<date-time>

required

controls

CardGroupControls · object

What the group's cards may spend together; a group limit is shared across its cards. Replaced whole on update; null clears it.

Hide child attributes

controls.limit

CardControlsLimit · object

How much may be spent per period.

Hide child attributes

controls.limit.amount

UsdMoney · object

required

A positive USD amount expressed in cents.

Hide child attributes

controls.limit.amount.amount

integer

required

Amount in cents. For example, 1250 represents USD 12.50.

Required range: x >= 1

Example:

1250

controls.limit.amount.currency

enum<string>

required

Available options:

USD

controls.limit.period

enum<string>

required

Every period but lifetime resets at its boundary in timezone; lifetime never resets.

Available options:

daily,

weekly,

monthly,

yearly,

lifetime

controls.limit.startDate

string<date>

Day the first period starts, today or earlier. Defaults to the start of the current period. Not used by daily.

Example:

"2026-09-01"

controls.limit.timezone

string

IANA timezone the period boundaries use. Defaults to UTC.

Example:

"America/Los_Angeles"

controls.transactionLimit

UsdMoney · object

The most a single transaction may be.

Hide child attributes

controls.transactionLimit.amount

integer

required

Amount in cents. For example, 1250 represents USD 12.50.

Required range: x >= 1

Example:

1250

controls.transactionLimit.currency

enum<string>

required

Available options:

USD

controls.merchantCategories

CardControlsRestriction · object

Merchant category ids from GET /v2/merchant-categories.

Hide child attributes

controls.merchantCategories.mode

enum<string>

required

Available options:

allow,

block

controls.merchantCategories.values

string[]

required

Minimum array length: 1

controls.merchantCategoryCodes

CardControlsRestriction · object

Four-digit merchant category codes (MCC).

Hide child attributes

controls.merchantCategoryCodes.mode

enum<string>

required

Available options:

allow,

block

controls.merchantCategoryCodes.values

string[]

required

Minimum array length: 1

controls.merchants

CardControlsRestriction · object

Merchant ids from GET /v2/merchants.

Hide child attributes

controls.merchants.mode

enum<string>

required

Available options:

allow,

block

controls.merchants.values

string[]

required

Minimum array length: 1

controls.countries

CardControlsRestriction · object

ISO 3166-1 alpha-2 codes of merchant countries.

Hide child attributes

controls.countries.mode

enum<string>

required

Available options:

allow,

block

controls.countries.values

string[]

required

Minimum array length: 1

Example:

{
  "limit": {
    "amount": { "amount": 500000, "currency": "USD" },
    "period": "monthly"
  },
  "transactionLimit": { "amount": 250000, "currency": "USD" },
  "merchantCategoryCodes": { "mode": "block", "values": ["7995"] }
}

Banking

Money movement

Cards

Bill pay

Invoicing

Accounting

Platform

Archive a card group

Authorizations

Headers

Path Parameters

Response