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

# Update a card group



## OpenAPI

````yaml /openapi-v2.json patch /v2/card-groups/{cardGroupId}
openapi: 3.1.0
info:
  title: Slash Public API V2
  description: >-
    Send money for a Slash legal entity. Every request uses an API key. Transfer
    creation returns a Transfer that links its resulting transactions.
  version: 0.0.1
servers:
  - url: https://api.slash.com
    description: production
security:
  - api_key: []
paths:
  /v2/card-groups/{cardGroupId}:
    parameters:
      - name: x-legal-entity
        in: header
        required: true
        description: >-
          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.
        schema:
          type: string
          pattern: ^le_[a-zA-Z0-9]+$
    patch:
      summary: Update a card group
      parameters:
        - name: cardGroupId
          in: path
          required: true
          description: Card group id with the `card_group_` prefix.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/card-group-update'
      responses:
        '200':
          description: The updated card group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card-group'
        '400':
          $ref: '#/components/responses/PublicApiV2Error400CardGroupsUpdate'
        '401':
          $ref: '#/components/responses/PublicApiV2Error401Unauthorized'
        '403':
          $ref: '#/components/responses/PublicApiV2Error403CardGroupsUpdate'
        '404':
          $ref: '#/components/responses/PublicApiV2Error404CardGroupsUpdate'
        '409':
          $ref: '#/components/responses/PublicApiV2Error409CardGroupsUpdate'
        '429':
          $ref: '#/components/responses/PublicApiV2RateLimited'
        '500':
          $ref: '#/components/responses/PublicApiV2Error500Internal'
      security:
        - api_key: []
components:
  schemas:
    card-group-update:
      title: CardGroupUpdate
      description: Omitted fields keep their value; `null` controls clear them.
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        controls:
          allOf:
            - $ref: '#/components/schemas/card-group-controls'
          nullable: true
      additionalProperties: false
    card-group:
      title: CardGroup
      type: object
      properties:
        id:
          type: string
          description: Card group id with the `card_group_` prefix.
          example: card_group_2rj4l7hmrrrcv
        name:
          type: string
          example: Marketing
        status:
          type: string
          enum:
            - active
            - archived
        controls:
          $ref: '#/components/schemas/card-group-controls'
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - name
        - status
        - createdAt
      additionalProperties: false
    card-group-controls:
      title: CardGroupControls
      description: >-
        What the group's cards may spend together; a group limit is shared
        across its cards. Replaced whole on update; `null` clears it.
      type: object
      properties:
        limit:
          $ref: '#/components/schemas/card-controls-limit'
        transactionLimit:
          allOf:
            - $ref: '#/components/schemas/UsdMoney'
          description: The most a single transaction may be.
        merchantCategories:
          allOf:
            - $ref: '#/components/schemas/card-controls-restriction'
          description: Merchant category ids from `GET /v2/merchant-categories`.
        merchantCategoryCodes:
          allOf:
            - $ref: '#/components/schemas/card-controls-restriction'
          description: Four-digit merchant category codes (MCC).
        merchants:
          allOf:
            - $ref: '#/components/schemas/card-controls-restriction'
          description: Merchant ids from `GET /v2/merchants`.
        countries:
          allOf:
            - $ref: '#/components/schemas/card-controls-restriction'
          description: ISO 3166-1 alpha-2 codes of merchant countries.
      additionalProperties: false
      example:
        limit:
          amount:
            amount: 500000
            currency: USD
          period: monthly
        transactionLimit:
          amount: 250000
          currency: USD
        merchantCategoryCodes:
          mode: block
          values:
            - '7995'
    PublicApiV2ErrorInvalidRequestShape:
      title: PublicApiV2ErrorInvalidRequestShape
      description: >-
        The body, query, or headers failed validation, or a required header is
        missing. `details` has one entry per failing location, keyed by JSON
        pointer or header name.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
            details:
              type: object
              properties: {}
              additionalProperties:
                type: string
          required:
            - code
            - details
    PublicApiV2ErrorUnauthorized:
      title: PublicApiV2ErrorUnauthorized
      description: API key authentication is missing or invalid.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorForbidden:
      title: PublicApiV2ErrorForbidden
      description: >-
        The credential is not permitted to perform this action on the resource.
        When the resource is a field of the request, `details` names that
        `field` and the `id` it received.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
            details:
              type: object
              properties:
                field:
                  type: string
                  description: Dot path of the request field at fault.
                id:
                  type: string
                  description: The identifier that field carried, when it is one.
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorForbiddenLegalEntity:
      title: PublicApiV2ErrorForbiddenLegalEntity
      description: The credential is not permitted to act for the selected legal entity.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorNotAvailable:
      title: PublicApiV2ErrorNotAvailable
      description: >-
        Public API v2 is not yet available. Use [Public API
        v1](https://docs.slash.com/introduction) in the meantime.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - not_available
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorUserApiKeyRequired:
      title: PublicApiV2ErrorUserApiKeyRequired
      description: >-
        The API key is scoped to a legal entity rather than a user. Every v2
        request needs a user API key, created under Settings → API keys in the
        Slash dashboard, together with the `x-legal-entity` header.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - user_api_key_required
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorNotFound:
      title: PublicApiV2ErrorNotFound
      description: >-
        No resource matches the identifier. When the identifier is a field of
        the request, `details` names that `field` and the `id` it received.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - not_found
            details:
              type: object
              properties:
                field:
                  type: string
                  description: Dot path of the request field at fault.
                id:
                  type: string
                  description: The identifier that field carried, when it is one.
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorCardGroupArchived:
      title: PublicApiV2ErrorCardGroupArchived
      description: Archived card groups cannot change or take new cards.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - card_group_archived
            details:
              type: object
              properties:
                field:
                  type: string
                  description: Dot path of the request field at fault.
                id:
                  type: string
                  description: The identifier that field carried, when it is one.
              additionalProperties: false
          required:
            - code
            - details
    PublicApiV2ErrorInternal:
      title: PublicApiV2ErrorInternal
      description: >-
        Slash could not complete the request. Quote `referenceId` when
        contacting Slash support.
      allOf:
        - $ref: '#/components/schemas/Error'
        - type: object
          properties:
            code:
              type: string
              enum:
                - internal
            details:
              type: object
              properties: {}
              additionalProperties: false
          required:
            - code
            - details
    card-controls-limit:
      title: CardControlsLimit
      description: How much may be spent per period.
      type: object
      properties:
        amount:
          $ref: '#/components/schemas/UsdMoney'
        period:
          type: string
          enum:
            - daily
            - weekly
            - monthly
            - yearly
            - lifetime
          description: >-
            Every period but `lifetime` resets at its boundary in `timezone`;
            `lifetime` never resets.
        startDate:
          type: string
          format: date
          description: >-
            Day the first period starts, today or earlier. Defaults to the start
            of the current period. Not used by `daily`.
          example: '2026-09-01'
        timezone:
          type: string
          description: IANA timezone the period boundaries use. Defaults to UTC.
          example: America/Los_Angeles
      required:
        - amount
        - period
      additionalProperties: false
    UsdMoney:
      type: object
      description: A positive USD amount expressed in cents.
      properties:
        amount:
          type: integer
          minimum: 1
          description: Amount in cents. For example, `1250` represents USD 12.50.
          example: 1250
        currency:
          type: string
          enum:
            - USD
      required:
        - amount
        - currency
      additionalProperties: false
      title: UsdMoney
    card-controls-restriction:
      title: CardControlsRestriction
      description: >-
        With `allow`, only the listed values are approved. With `block`, the
        listed values are declined.
      type: object
      properties:
        mode:
          type: string
          enum:
            - allow
            - block
        values:
          type: array
          minItems: 1
          uniqueItems: true
          items:
            type: string
      required:
        - mode
        - values
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type: string
          description: >-
            Machine-readable reason; branch on this, not on `message`. Every
            code an endpoint can return is listed on its reference page; the
            ones shared by all endpoints are explained in the Errors guide.
          example: invalid_request
        message:
          type: string
          description: >-
            Human-readable explanation, safe to show to an operator. Wording may
            change; use `code` and `details` programmatically.
        details:
          type: object
          description: >-
            The values behind `message`, keyed per `code`. For example
            `insufficient_funds` carries `available` and `requested`;
            `invalid_request` from contract validation carries one entry per
            failing field, keyed by JSON pointer. Empty when the code has no
            variable data.
          additionalProperties:
            type: string
          example:
            available: $120.00
            requested: $500.00
        referenceId:
          type: string
          description: Unique id of this failure. Quote it when contacting Slash support.
          example: 4001-2alj5if
      required:
        - code
        - message
        - details
        - referenceId
      additionalProperties: false
      title: Error
  responses:
    PublicApiV2Error400CardGroupsUpdate:
      description: >-
        - `invalid_request (request shape)` — The body, query, or headers failed
        validation, or a required header is missing. `details` has one entry per
        failing location, keyed by JSON pointer or header name.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorInvalidRequestShape'
          examples:
            invalid_request_request_shape:
              summary: invalid_request (request shape)
              value:
                code: invalid_request
                message: >-
                  Invalid `cardGroupId`: Expected a valid ID beginning with
                  "card_group_".
                details:
                  /cardGroupId: Expected a valid ID beginning with "card_group_".
                referenceId: 4001-2alj5if
    PublicApiV2Error401Unauthorized:
      description: '- `unauthorized` — API key authentication is missing or invalid.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorUnauthorized'
          examples:
            unauthorized:
              summary: unauthorized
              value:
                code: unauthorized
                message: API key authentication is missing or invalid.
                details: {}
                referenceId: 4011-2alj5if
    PublicApiV2Error403CardGroupsUpdate:
      description: >-
        - `forbidden` — The credential is not permitted to perform this action
        on the resource. When the resource is a field of the request, `details`
        names that `field` and the `id` it received.

        - `forbidden (legal entity)` — The credential is not permitted to act
        for the selected legal entity.

        - `not_available` — Public API v2 is not yet available. Use [Public API
        v1](https://docs.slash.com/introduction) in the meantime.

        - `user_api_key_required` — The API key is scoped to a legal entity
        rather than a user. Every v2 request needs a user API key, created under
        Settings → API keys in the Slash dashboard, together with the
        `x-legal-entity` header.
      content:
        application/json:
          schema:
            anyOf:
              - title: forbidden
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorForbidden'
              - title: forbidden (legal entity)
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorForbiddenLegalEntity'
              - title: not_available
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorNotAvailable'
              - title: user_api_key_required
                allOf:
                  - $ref: '#/components/schemas/PublicApiV2ErrorUserApiKeyRequired'
          examples:
            forbidden_card_group_id:
              summary: forbidden (cardGroupId)
              value:
                code: forbidden
                message: >-
                  This credential is not permitted to do that on `cardGroupId`
                  card_group_2rj4l7hmrrrcv.
                details:
                  field: cardGroupId
                  id: card_group_2rj4l7hmrrrcv
                referenceId: 4031-2alj5if
            forbidden_legal_entity:
              summary: forbidden (legal entity)
              value:
                code: forbidden
                message: This credential is not permitted to do that.
                details: {}
                referenceId: 4031-2alj5if
            not_available:
              summary: not_available
              value:
                code: not_available
                message: >-
                  Public API v2 is not yet available. Use Public API v1
                  (https://docs.slash.com/introduction) in the meantime.
                details: {}
                referenceId: 4031-2alj5if
            user_api_key_required:
              summary: user_api_key_required
              value:
                code: user_api_key_required
                message: >-
                  Public API v2 requires a user API key. Create one under
                  Settings → API keys in the Slash dashboard.
                details: {}
                referenceId: 4031-2alj5if
    PublicApiV2Error404CardGroupsUpdate:
      description: >-
        - `not_found` — No resource matches the identifier. When the identifier
        is a field of the request, `details` names that `field` and the `id` it
        received.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorNotFound'
          examples:
            not_found_card_group_id:
              summary: not_found (cardGroupId)
              value:
                code: not_found
                message: '`cardGroupId` card_group_2rj4l7hmrrrcv was not found.'
                details:
                  field: cardGroupId
                  id: card_group_2rj4l7hmrrrcv
                referenceId: 4041-2alj5if
    PublicApiV2Error409CardGroupsUpdate:
      description: >-
        - `card_group_archived` — Archived card groups cannot change or take new
        cards.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorCardGroupArchived'
          examples:
            card_group_archived_card_group_id:
              summary: card_group_archived (cardGroupId)
              value:
                code: card_group_archived
                message: The card group is archived.
                details:
                  field: cardGroupId
                  id: card_group_2rj4l7hmrrrcv
                referenceId: 4091-2alj5if
    PublicApiV2RateLimited:
      description: >-
        The request exceeded the applicable rate limit. The response body is
        plain text, not the error object; clients must not depend on its
        wording.
      content:
        text/plain:
          schema:
            type: string
          example: You are rate limited
    PublicApiV2Error500Internal:
      description: >-
        - `internal` — Slash could not complete the request. Quote `referenceId`
        when contacting Slash support.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PublicApiV2ErrorInternal'
          examples:
            internal:
              summary: internal
              value:
                code: internal
                message: >-
                  An unexpected error occurred. If this keeps happening, contact
                  Slash support with the reference id below.
                details: {}
                referenceId: 5001-2alj5if
  securitySchemes:
    api_key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        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`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.