---
title: "Set card label"
method: PUT
path: "/api/v1/cards/{card_id}/label"
tags: ["Cards"]
---

# Set card label

`PUT /api/v1/cards/{card_id}/label`

Set or clear a user-defined label (nickname) for a card. Local-only, not sent to provider.

## Path parameters

- `card_id` string, required

## Headers

- `x-api-key` string, nullable

## Request body

- SetCardLabelRequest — Request to set a user-defined card label.
  - `label` string, nullable — Label/nickname (null to clear)

## Response `200`

Successful Response

- CardResponse — Card response - universal format for any provider.
  - `id` string, required
  - `walletAddress` string, nullable — Linked wallet address
  - `status` 'pending' | 'active' | 'blocked' | 'closed' — Card status.
  - `limit` CardLimit — Card spending limit.
    - `dailyLimit` number, nullable — Daily spending limit (-1 for unlimited)
    - `dailyUsage` number — Amount spent today
    - `monthlyLimit` number, nullable — Monthly spending limit (-1 for unlimited)
    - `monthlyUsage` number — Amount spent this month
    - `lifetimeLimit` number, nullable — Lifetime spending limit (-1 for unlimited)
    - `lifetimeUsage` number — Total amount spent
    - `currency` string
  - `cardData` CardData — Card display data (non-sensitive).
    - `nameOnCard` string, required
    - `paymentSystem` string, required — Visa, Mastercard, etc.
    - `lastFour` string, required — Last 4 digits of card number
    - `expiryDate` string, required — MM/YY format
    - `format` 'virtual' | 'physical', required — Card format.
    - `cardName` string, required — Display name like 'Visa **** 1234'
  - `createdAt` string, nullable
  - `activated` boolean — True if card details have been revealed and cached
  - `billingAddress` UserAddress — Address schema for user. Canonical field names: street_address, address_line_2, city, state, country, zip. Accepts legacy Align/IBAN field names (street_line_1, street_line_2, postal_code) for backward compatibility with existing JSONB data.
    - `streetAddress` string, nullable
    - `addressLine2` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `country` 'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' — ISO 3166-1 alpha-2 country codes.
    - `zip` string, nullable
  - `dailySpend` number — Total spent today on this card (from fiat_transfers)
  - `label` string, nullable — User-defined card label/nickname

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/hevn-inc/apis/hevn-api.md) · [All operations](https://skmtc.net/hevn-inc/apis/hevn-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hevn-inc/hevn-api/versions/e6301d6796bf/schema)