curl --request GET \
--url https://api.upwell.com/api/rest/rules/{id}{
"rule": {
"actionType": "CREATE_EXCEPTION",
"actionValue": "<unknown>",
"createdAt": "<unknown>",
"criteriaField": "<string>",
"criteriaObject": "EMAIL_MESSAGE",
"criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
"criteriaValue": "<string>",
"customerId": "<string>",
"id": "<string>",
"priority": 123,
"type": "CARRIER_INVOICE_EXCEPTION",
"updatedAt": "<unknown>"
}
}Get a rule by ID
curl --request GET \
--url https://api.upwell.com/api/rest/rules/{id}{
"rule": {
"actionType": "CREATE_EXCEPTION",
"actionValue": "<unknown>",
"createdAt": "<unknown>",
"criteriaField": "<string>",
"criteriaObject": "EMAIL_MESSAGE",
"criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
"criteriaValue": "<string>",
"customerId": "<string>",
"id": "<string>",
"priority": 123,
"type": "CARRIER_INVOICE_EXCEPTION",
"updatedAt": "<unknown>"
}
}Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
"id" is required (enter it either in parameters or request body)
Responses for GET /api/rest/rules/{id}
Rules used for matching, document requirements, etc
Show child attributes
CREATE_EXCEPTION, EXEMPT_FROM_DOCUMENT_REQUIREMENTS, MATCH_FIELDS_ACROSS_DOCUMENTS, REQUIRE_DOCUMENT_SET, REQUIRE_SIGNATURE_IN_LOCATION, REQUIRE_STAMP_FROM_ENTITY, SET_CUSTOMER_BY_CASS_ID, SET_CUSTOMER_BY_CUSTOMER_NAME, SET_REQUIRED_DOCUMENTS, VALIDATE_DOCUMENT_CONTENT, VALIDATE_LOCATION_CRITERIA, VALIDATE_REFERENCE_NUMBER EMAIL_MESSAGE, PARSED_INVOICE ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY, ARRAY_HAS_OBJECT_WITH_PROPERTY, CONTAINED_IN, CONTAINS, EQ, GT, GTE, HAS_KEY, HAS_KEYS_ALL, HAS_KEYS_ANY, ILIKE, IN, IREGEX, IS_NULL, LIKE, LT, LTE, NEQ, NILIKE, NIN, NLIKE, NREGEX, NSIMILAR, REGEX, SIMILAR CARRIER_INVOICE_EXCEPTION, DOCUMENT_BASIC, DOCUMENT_CONTENT_VALIDATION, DOCUMENT_CUSTOM, LOCATION_BASED_RULE, MULTI_DOCUMENT_SET, NO_DOCUMENTS_REQUIRED, ON_CREATION_FROM_EMAIL, REFERENCE_NUMBER, REFERENCE_NUMBER_MATCHING, REFERENCE_NUMBER_REQUIRED, SIGNATURE_REQUIRED, STAMP_REQUIRED