Skip to main content
PATCH
Update suggested categorization rule
Use this endpoint to mark a categorization rules suggestion as not dismissed. This allows the transaction categorization flow to show the suggestion again to the user.

Undoing a dismissed suggestion

Set dismissed_at to null to mark the suggestion as not dismissed and return it to normal suggestion flow.

Rejecting a suggestion

To reject a suggestion, see reject suggested categorization rule. Do not use this endpoint to set the dismissed_at field to some timestamp.

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.

suggestionId
string<uuid>
required

The UUID of the suggestion to update.

Body

application/json

Fields that can be patched on a suggested categorization rule.

dismissed_at
string<date-time> | null

Timestamp that marks the suggestion as dismissed. Set to null to clear dismissal.

Response

Suggested categorization rule updated successfully.

data
object
required

Consumer-facing rule suggestion for creating a categorization rule for a specific counterparty.