POST
/
v1
/
rule
/
create

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
amountGreaterThan
integer | null

Lower bound for the amount, exclusive.

amountLessThan
integer | null

Upper bound for the amount, exclusive.

delayInDays
integer
required

Number of days to delay before applying the rule.

lessThanOrEqualTo
integer | null

Upper bound for the amount, inclusive.

message
string | null

Message to be sent when applying this rule, must contain the {url} and {first_name} placeholders.

method
enum<string>
required

Communication method to be used for this rule.

Available options:
Native,
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
name
string
required

Name of the rule.

ruleSetId
string
required

Identifier of the rule set this rule belongs to.

Response

200 - application/json
amountGreaterThan
integer | null

Lower bound for the amount, exclusive.

amountLessThan
integer | null

Upper bound for the amount, exclusive.

delayInDays
integer
required

Number of days to delay before applying the rule.

id
string
required

Unique identifier for the rule.

lessThanOrEqualTo
integer | null

Upper bound for the amount, inclusive.

message
string | null

Message to be sent when applying this rule.

method
enum<string>
required

Communication method to be used for this rule.

Available options:
Native,
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
name
string
required

Name of the rule.

ruleSetId
string
required

Identifier of the rule set this rule belongs to.

Provider ListRule Get