API Reference
Service StatusModulr WebsiteShare FeedbackSandbox Portal Sign In
Start typing to search…

Create a Rule

post
https://api-sandbox.modulrfinance.com/api-sandbox-token/rules

When you want a new rule on an account you can create one with this endpoint. Note that Rules are linked to an Account and each Account can only have one instance of a Rule type

Body Params
string
required

The type of Rule. Can be one of the following {SWEEP, SPLIT, FUNDING}

string
required
length between 0 and 25

Rule's name

string
required
length ≥ 1

The Account which the Rule is created on.

data
object
required

Configuration fields for all types of rules. To be populated where applicable based on rule type.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 7 months ago