RulesEngine

CreateNewDraft

Use this call to create a new draft rule of a specified type. <b>Permissions Required: </b> GlobalPermissions.OrderBook.RulesEngineNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

post/api/RulesEngine/CreateNewDraft

Request

  • Base URL
    https://eu-ext.linnworks.net
  • URL
    https://eu-ext.linnworks.net/api/RulesEngine/CreateNewDraft
  • Auth
    API key in header Authorization

Request body

ruleNamestring

The name for the new draft.

type'Test' | 'Orders'

The rule type.

Response

OK

pkRuleIdinteger
RuleNamestring
RuleType'Test' | 'Orders'
Enabledboolean
RunOrderinteger
pkRuleId_Draftinteger
Draftboolean
RuleTypeDisplayNamestring

Changes

No recorded changes to this operation across all 1 revision of this API.