Skip to main content
POST
Create One Rule
The fields to populate depend on the rule’s type β€” three distinct shapes; mixing them produces a rule that silently never fires. See Rules.

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account β†’ API keys) and are scoped to one organization.

Body

application/json

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

input
RulesInsertInput Β· object

Object containing the fields to create or update. Only the fields in this endpoint schema are accepted.

Response

Responses for POST /api/rest/rules

createRule
Rules Β· object | null

Rules used for matching, document requirements, etc