v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Workflows

Create rule

Create a rule for the retailer.

🔒 Requires: business_rules:write scope

post/workflows/rules

Request body

event_type'sale.ready_for_payment' | 'sale.line_items.added' | 'sale.customer.changed' | 'sale.created' | 'sale.updated' required
remote_rule_idstring required

Example request

{
  "remote_rule_id": "1239349157873029120"
}

Response

A business rule.

Example response

{
  "data": {
    "id": "1239349747718000640",
    "remote_rule_id": "1239349157873029120"
  }
}