Skip to main content
POST
Apply tags to an entity

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Body

application/json
entityId
string
required

The ID of the entity to tag

Example:

"abc123"

entityType
string
required

The type of entity being tagged (e.g. transfer, withdrawal)

Example:

"withdrawal"

tags
string[]
required

The complete set of tag names for the entity within the given tag type. Apply replaces the entity's tags of that type with this set: names not already present are added, names no longer present are removed, and an empty list clears all of the entity's tags of that type. Tags of other types are not affected.

tagType
enum<string>
required

The ownership type of a tag.

Available options:
system,
backoffice,
client

Response

Tags applied successfully

tags
AppliedTag · object[]
required

The tags applied to the entity, including their association metadata