API Reference

Modify Tags for a Transaction

post
http://localhost:8080/v1/transactions//tags

Add or remove tags for transaction. Each tag must either reference an existing tag by 'id', or specify both 'category' and 'value' to create/reference a new tag. If 'id' is null, both 'category' and 'value' are required. Operation field determines whether tags are added (ADD) or removed (REMOVE).

Path Params
uuid
required

Unique identifier (UUID) of the Transaction

Body Params

Request to modify tags for an entity

string
enum
required

An indicator for whether the supplied list of tags should be added or removed

Allowed:
tags
array of objects
required
length between 1 and 100

List of tags to add or remove on the entity. Each tag must either have an 'id' to reference an existing tag, or both 'category' and 'value' to create/reference a new tag.

tags*

A category-value pair Tag for an entity. Either provide an 'id' to reference an existing tag, or provide both 'category' and 'value' to create/reference a tag. If 'id' is null, both 'category' and 'value' are required.

string
length between 1 and 64

Tag category name. Required when 'id' is not provided.

uuid

Unique identifier of an existing tag. If provided, 'category' and 'value' are optional.

string
length between 1 and 64

Tag value. Required when 'id' is not provided.

Responses

Updated 11 days ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 11 days ago