Set a custom set of categories

POST

https://api.ntropy.com/v3/categories/:id

POST

/v3/categories/:id

curl -X "POST" \
    "https://api.ntropy.com/v3/categories/my_category_id" \
    -H "Accept: application/json" \
    -H "X-API-KEY: cd1H...Wmhl"  \
    -H "Content-Type: application/json" \
    -d '{
        "incoming": {
            "salary": "Income paid by an employer as wages or salary.",
            "investment income": "Income earned from investments.",
            "other income": "Income not covered by another available category."
        },
        "outgoing": {
            "rent": "Payment for ongoing use of a residence or property.",
            "utilities": "Payment for household utility services.",
            "groceries": "Purchase of food and household staples.",
            "entertainment": "Payment for recreation or entertainment."
        }
    }'

{
  "incoming": {
    "investment income": "Income earned from investments.",
    "other income": "Income not covered by another available category.",
    "salary": "Income paid by an employer as wages or salary."
  },
  "outgoing": {
    "entertainment": "Payment for recreation or entertainment.",
    "groceries": "Purchase of food and household staples.",
    "rent": "Payment for ongoing use of a residence or property.",
    "utilities": "Payment for household utility services."
  }
}

Sets a custom set of categories. Transactions that don’t match a category will be categorized not enough information regardless of whether it is present in the set.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

idstringRequired

Request

This endpoint expects an object.

incomingmap from strings to stringsRequired

outgoingmap from strings to stringsRequired

Response

Custom categories successfully set.

incomingmap from strings to strings

outgoingmap from strings to strings

Errors

422

Unprocessable Entity Error