Create a transaction rule

post

https://api.cardda.com/v1/transaction/rules

Creates a transaction rule. Requires the transactions_rules_manage permission. The
company_id and user_id are taken from the authenticated context and company-id header.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload to create a transaction rule. Requires the transactions_rules_manage
permission. company_id and user_id are set from the authenticated context and the
company-id header, not from the body.

name

string

required

enabled

boolean

Defaults to true

hidden

boolean

Defaults to false

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

The company-id header is missing or the caller is not a member of the company

Language

Credentials

Bearer

Loading…

Response

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

application/json

201Rule created

422Validation error