Update a transaction rule

patch

https://api.cardda.com/v1/transaction/rules/{rule_id}

Updates a transaction rule and its custom-column change effects. Requires the
transactions_rules_manage permission. All fields are optional. Effects can be updated
(include id), added, or removed (_destroy: true).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

rule_id

uuid

required

The id of the transaction rule.

Body Params

Payload to update a transaction rule. Requires the transactions_rules_manage permission. All
fields are optional; only the provided fields are changed. company_id and user_id cannot be
changed via this endpoint (they are fixed from the rule's creation context).

name

string

enabled

boolean

hidden

boolean

constraints

object

Match expression evaluated against transactions.

custom_column_change_effects

array of objects

The custom-column changes to apply. Include an id to update an existing effect and
_destroy: true to remove one. target_custom_column_id is accepted as an alias for
custom_column_id.

custom_column_change_effects

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Accounting endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

404

Rule not found, or the company-id header is missing / not a member company

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Rule updated

422Validation error