Skip to main content
POST
Create a CARF rule

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

workflowId
string
required

Body

application/json
name
string
required
Maximum string length: 200
Example:

"Supplier payments"

code
enum<string>
required

CARF5xx for in rules, CARF6xx for out rules.

Available options:
CARF501,
CARF502,
CARF503,
CARF504,
CARF505,
CARF506,
CARF507,
CARF508,
CARF509,
CARF601,
CARF602,
CARF603,
CARF604,
CARF605,
CARF606
conditions
object
required
enabled
boolean
default:true

Response

201 - application/json
id
string<uuid>
required
name
string
required
code
enum<string>
required
Available options:
CARF501,
CARF502,
CARF503,
CARF504,
CARF505,
CARF506,
CARF507,
CARF508,
CARF509,
CARF601,
CARF602,
CARF603,
CARF604,
CARF605,
CARF606
conditions
object
required
enabled
boolean
required
position
number
required

Tie-break order; lower first.

created_at
string
required
updated_at
string
required