Skip to main content
TypeScript
const response: Promise<FireblocksResponse<Tag>> = fireblocks.tags.createTag(tagsApiCreateTagRequest);
{
  "id": "df4c0987-30da-4976-8dcf-bc2dd41ae331",
  "label": "VIP",
  "isProtected": false,
  "updatedAt": 1717084800000,
  "description": "Tag for VIP customers",
  "color": "#FF5733",
  "pendingApprovalRequest": {
    "id": "12345"
  }
}

Headers

​
Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Body

application/json
​
label
string
required

The tag label

Required string length: 2 - 30
Example:

"VIP"

​
description
string

Description for the tag

Maximum string length: 250
Example:

"Tag for VIP customers"

​
color
string

The tag color in hex format

Example:

"#FF5733"

​
isProtected
boolean
default:false

Indication if the tag is protected tag

​
type
enum<string>

The tag type, indicating the domain that owns the tag

Available options:
WALLET_POOL

Response

201 - application/json

Tag created successfully

​
id
string<uuid>
required

The unique identifier of the tag

Example:

"df4c0987-30da-4976-8dcf-bc2dd41ae331"

​
label
string
required

The tag label

Example:

"VIP"

​
isProtected
boolean
default:false
required

Indication if the tag is a protected tag

​
updatedAt
number
required

The date and time the tag was last updated

Example:

1717084800000

​
description
string

Description for the tag

Example:

"Tag for VIP customers"

​
color
string

The tag color in hex format

Example:

"#FF5733"

​
type
enum<string>

The tag type, indicating the domain that owns the tag

Available options:
WALLET_POOL
​
pendingApprovalRequest
object

Approval request details