Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Tag Management

Create tag

This API enables the creation of custom tags to classify transactions using user-defined criteria, including include/exclude terms, amount thresholds, and recurrence patterns.

post/v2/analytics/tags

Request body

namestring required

The name of the tag you want to create.

descriptionstring required

A description of the tag you want to create.

colorstring required

A hex code to visually represent the tag in the Dashboard.

Example request

{
  "name": "Deposits",
  "description": "baker street",
  "color": "#777",
  "customization": {
    "amount": {
      "lt": 10,
      "gt": 100,
      "eq": 50
    },
    "include_terms": [
      "create inc 1",
      "create inc 2"
    ],
    "exclude_terms": [
      "create exc 1",
      "create exc 2"
    ],
    "recurrence": {
      "min_days": 30,
      "max_days": 60
    }
  }
}

Response

Success

Example response

{
  "response": {
    "uuid": "1b1a82db-b323-4a09-9d09-1fa4d926d3db"
  }
}