Skip to main content
POST
/
api
/
rest
/
rules
Create One Rule
curl --request POST \
  --url https://api.upwell.com/api/rest/rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "actionType": "CREATE_EXCEPTION",
    "actionValue": "<unknown>",
    "conditionExpression": "<string>",
    "createdAt": "<unknown>",
    "criteriaField": "<string>",
    "criteriaObject": "CUSTOMER",
    "criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
    "criteriaValue": "<string>",
    "customerId": "<string>",
    "enabled": true,
    "exceptionConfig": "<unknown>",
    "exceptionType": "CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH",
    "id": "<string>",
    "priority": 123,
    "ruleActionType": {},
    "ruleType": {},
    "type": "CARRIER_INVOICE_EXCEPTION",
    "updatedAt": "<unknown>",
    "validationExpression": "<string>"
  }
}
'
{
  "createRule": {
    "actionType": "CREATE_EXCEPTION",
    "actionValue": "<unknown>",
    "conditionExpression": "<string>",
    "createdAt": "<unknown>",
    "criteriaField": "<string>",
    "criteriaObject": "CUSTOMER",
    "criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
    "criteriaValue": "<string>",
    "customerId": "<string>",
    "id": "<string>",
    "priority": 123,
    "type": "CARRIER_INVOICE_EXCEPTION",
    "updatedAt": "<unknown>",
    "validationExpression": "<string>"
  }
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Body

application/json

Query parameters can also be provided in the request body as a JSON object

​
input
RulesInsertInput · object

input type for inserting data into table "rules"

Response

200 - application/json

Responses for POST /api/rest/rules

​
createRule
Rules · object

Rules used for matching, document requirements, etc