Rules
Rule Update
Update an existing Rule
by ID.
PUT
/
v1
/
rule
/
update
/
{rule_id}
Headers
TENANT
string
requiredThe tenant you are making this request on behalf of
API-KEY
string
requiredYour api key
Path Parameters
rule_id
string
requiredBody
application/json
amountGreaterThan
integer | null
Lower bound for the amount, exclusive.
amountLessThan
integer | null
Upper bound for the amount, exclusive.
delayInDays
integer | null
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> | null
Communication method to be used for this rule.
Available options:
Native
, SMS
, MAIL
, CALL
, COLLECTIONS
, EMAIL
, SMS_AND_EMAIL
Response
200 - application/json
amountGreaterThan
integer | null
Lower bound for the amount, exclusive.
amountLessThan
integer | null
Upper bound for the amount, exclusive.
delayInDays
integer
requiredNumber of days to delay before applying the rule.
id
string
requiredUnique 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>
requiredCommunication method to be used for this rule.
Available options:
Native
, SMS
, MAIL
, CALL
, COLLECTIONS
, EMAIL
, SMS_AND_EMAIL
name
string
requiredName of the rule.
ruleSetId
string
requiredIdentifier of the rule set this rule belongs to.