Skip to main content
PATCH
Update 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

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.

Body

application/json

Omitted fields keep their value; null controls clear them.

name
string
Required string length: 1 - 255
controls
CardGroupControls · object | null

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

Example:

Response

The updated card group.

id
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.

Example: