transactionsCreate a custom category

Create a custom category

Creates a custom category. Requires the categories:write scope, writes_enabled, and an Idempotency-Key. Categories nest one level, so parent_id must name a visible top-level category. Reaching the per-account category limit returns 409 (waiting does not help), never a rate limit.

curl -X POST "https://api.403fin.io/v1/categories" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "name": "John Doe",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "icon": "example_string",
  "color": "example_string"
}'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "parent_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "icon": "example_string",
    "color": "example_string",
    "type_tag": "example_string",
    "is_system": true,
    "sort_order": 42
  },
  "pagination": {
    "next_cursor": "example_string",
    "has_more": true
  },
  "redacted_fields": [
    "example_string"
  ],
  "filtered": true
}
POST
/v1/categories
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key (header: X-API-Key)
X-API-Keystring
Required

An opaque ff_ credential presented in the X-API-Key header.

An opaque ff_ credential presented in the X-API-Key header.
Content-Typestring
Required

The media type of the request body

Options: application/json
header
Idempotency-Keystring
Required

A caller-chosen unique key (1-128 chars) that makes the write idempotent. A retry with the SAME key against the SAME operation, resource, and body replays the original response (Idempotency-Replayed: true). The same key with anything different — a changed body, a different endpoint, or a different {id} — is a 409 conflict; a still-in-flight duplicate is 409 with Retry-After. Required on every write. Stored for 24 hours. The key is bound to the target, not only to the payload, so reusing one key across two deletes (which carry no body at all) conflicts rather than replaying the first delete's response.

Min length: 1 • Max length: 128
namestring
Required
Max length: 60
parent_idstring
Format: uuid
iconstring

A Material icon name, or "emoji:" followed by a single emoji.

colorstring

A hex color, e.g. "#FF5733".

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

header
X-API-Keystring
Required

API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.

Headers

Idempotency-Keystring
Required

A caller-chosen unique key (1-128 chars) that makes the write idempotent. A retry with the SAME key against the SAME operation, resource, and body replays the original response (Idempotency-Replayed: true). The same key with anything different — a changed body, a different endpoint, or a different {id} — is a 409 conflict; a still-in-flight duplicate is 409 with Retry-After. Required on every write. Stored for 24 hours.

The key is bound to the target, not only to the payload, so reusing one key across two deletes (which carry no body at all) conflicts rather than replaying the first delete's response.

Body

application/json
iconstring

A Material icon name, or "emoji:" followed by a single emoji.

colorstring

A hex color, e.g. "#FF5733".

Responses

dataobject
Required
paginationstring

Cursor pagination state, present on list endpoints.

redacted_fieldsstring[]

Field ids stripped from the payload by connection scope.

filteredboolean

True when row or aggregate filtering is in effect for this response.