POST /beta/transactions/rules/v1/create

The /transactions/rules/v1/create endpoint creates transaction categorization rules.

Rules will be applied on the Item's transactions returned in /transactions/get response.

The product is currently in beta. To request access, contact transactions-feedback@plaid.com.

Servers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Name	Type	Required	Description
`pfc_primary_category`	String	Yes	A personal finance primary category. See the taxonomy csv file for a full list of personal finance categories.
`rule_details`	Object	Yes	A representation of transactions rule details.
`rule_details.field`	String	Yes	Transaction field for which the rule is defined. Valid values: `"MERCHANT_NAME"` `"TRANSACTION_ID"`
`rule_details.query`	String	Yes	For `TRANSACTION_ID` field, provide `transaction_id`. For `NAME` field, provide a string pattern.
`rule_details.type`	String	Yes	Transaction rule's match type. For `TRANSACTION_ID` field, `EXACT_MATCH` is available. Matches are case sensitive. Valid values: `"SUBSTRING_MATCH"` `"EXACT_MATCH"`
`client_id`	String	No	Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
`pfc_detailed_category`	String	Yes	A personal finance detailed category. See the taxonomy csv file for a full list of personal finance categories.
`secret`	String	No	Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
`client_user_id`	String	Yes	A unique ID representing the end user. This ID is used to associate rules with a specific user.

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.