Skip to main content
PUT
Update categorization rule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string<uuid>
required

The UUID of the business.

categorizationRuleId
string<uuid>
required

The UUID of the categorization rule.

Body

application/json

Parameters for creating or updating a categorization rule. At least one filter must be specified.

name
string

Optional name for the rule.

category
Account ID · object
suggestion_1
Account ID · object
suggestion_2
Account ID · object
suggestion_3
Account ID · object
apply_retroactively
boolean
default:false

Whether to apply this rule to existing uncategorized transactions.

external_id
string

External identifier for idempotency. Used for create/upsert operations.

created_by_suggestion_id
string<uuid>

UUID of the suggestion that created this rule (if applicable).

merchant_type_filter
string

Regex pattern to match against merchant type (minimum 7 characters).

Minimum string length: 7
transaction_description_filter
string

Regex pattern to match against transaction description (minimum 7 characters).

Minimum string length: 7
counterparty_filter
string<uuid>

UUID of a specific counterparty (merchant/vendor) to match.

bank_transaction_type_filter
enum<string>

Type of bank transaction.

Available options:
REVENUE,
LOAN_DISBURSEMENT,
REFUND_RECEIVED,
INCOMING_P2P_TRANSFER,
INTRA_ACCOUNT_TRANSFER_IN,
CHECK_WITHDRAWAL,
ATM_DEPOSIT,
BANK_DEPOSIT,
BANK_VERIFICATION_TRIAL_CREDIT,
REVERSAL_IN,
CREDIT_CARD_REWARD,
CREDIT_CARD_PAYMENT_IN,
INTEREST_EARNED,
GOVERNMENT_OR_OTHER_GRANT,
TAX_REFUND,
PURCHASE,
REFUND_GIVEN,
OUTGOING_P2P_TRANSFER,
INTRA_ACCOUNT_TRANSFER_OUT,
CHECK_DEPOSIT,
CREDIT_CARD_PAYMENT_OUT,
ATM_WITHDRAWAL,
BANK_WITHDRAWAL,
BANKING_FEE,
PAYMENT_PROCESSING_FEE,
BANK_VERIFICATION_TRIAL_DEBIT,
REVERSAL_OUT,
LOAN_PAYMENT,
TAX_PAYMENT,
NOT_ENOUGH_INFORMATION
bank_direction_filter
enum<string>

Transaction direction to match.

Available options:
MONEY_IN,
MONEY_OUT
amount_min_filter
integer<int64>

Minimum transaction amount in cents.

amount_max_filter
integer<int64>

Maximum transaction amount in cents.

Response

Categorization rule updated successfully.

data
object
required

A categorization rule that automatically categorizes transactions matching specified filters.