FIfireblocks
Tags

Create a new tag

Create a new tag. Endpoint Permissions: For protected tags: ADMIN,NON_SIGNING_ADMIN,OWNER. For non protected tags: ADMIN,NON_SIGNING_ADMIN,OWNER,SIGNER,EDITOR,APPROVER.

post/tags

Request

Headers

Idempotency-Keystring

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.

Request body

labelstring required

The tag label

descriptionstring

Description for the tag

colorstring

The tag color in hex format

isProtectedboolean

Indication if the tag is protected tag

type'WALLET_POOL'

The tag type, indicating the domain that owns the tag

allowedEntityTypesstring[]

Allow-list of entity types this tag may be attached to. Soft-defaults to ['vault_account'] when omitted, and is immutable after creation. Known values: vault_account (default), contact.

Example request

{
  "label": "VIP",
  "description": "Tag for VIP customers",
  "color": "#FF5733",
  "allowedEntityTypes": [
    "vault_account"
  ]
}

Response

Tag created successfully

idstring uuid required

The unique identifier of the tag

labelstring required

The tag label

descriptionstring

Description for the tag

colorstring

The tag color in hex format

isProtectedboolean required

Indication if the tag is a protected tag

updatedAtnumber required

The date and time the tag was last updated

type'WALLET_POOL'

The tag type, indicating the domain that owns the tag

allowedEntityTypesstring[]

The entity types this tag may be attached to. Tags created before this field was introduced read back as ['vault_account']. Known values: vault_account (default), contact.

Example response

{
  "id": "df4c0987-30da-4976-8dcf-bc2dd41ae331",
  "label": "VIP",
  "description": "Tag for VIP customers",
  "color": "#FF5733",
  "updatedAt": 1717084800000,
  "allowedEntityTypes": [
    "vault_account"
  ],
  "pendingApprovalRequest": {
    "id": "12345"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.