---
title: "AddAction"
method: POST
path: "/api/RulesEngine/AddAction"
tags: ["RulesEngine"]
---

# AddAction

`POST /api/RulesEngine/AddAction`

## Request

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

Use this call to add a new action to a condition node.
<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

## Request body

- CreateActionRequest
  - `fkConditionId` integer: The condition the action runs on.
  - `ActionName` string: The name of the action
  - `ActionType` 'Unknown' | 'AssignShippingService' | 'AssignToFolder' | 'AssignToLocation' | 'SplitOrderByWeight' | 'SplitOrderByValue' | 'SplitOrderSingle' | 'AssignOrderExtendedProperty' | 'ChangeOrderLockStatus' | 'ChangeOrderParkStatus' | 'AssignTagToOrder' | 'ExecuteMacro' | 'AssignIdentifierToOrder' | 'BlockOrderFromMerging' | 'SendToFulfillmentNetwork' | 'SetDispatchDate' | 'AddItemToOrder' | 'AddServiceToOrder' | 'AddNoteToOrder': The type of the action
  - `Properties` ActionPropertyRequest[]: Data the action needs to run.
    - `DisplayName` string: The name of the property
    - `Value` string: The actual data input for the property
    - `ActionPropertyId` integer: The unique identifier for this action property. If not provided the property will be created as new property.
    - `PropertyGroupId` integer: Property grouping key. Used if there are multiple properties with the same name under one action. Defaults to 1.

## Response `200`

OK

- RuleActionResponse: The actual action saved in the rule.
  - `pkActionId` integer
  - `fkConditionId` integer: The condition the action runs on.
  - `ActionName` string: The name of the action
  - `ActionType` 'Unknown' | 'AssignShippingService' | 'AssignToFolder' | 'AssignToLocation' | 'SplitOrderByWeight' | 'SplitOrderByValue' | 'SplitOrderSingle' | 'AssignOrderExtendedProperty' | 'ChangeOrderLockStatus' | 'ChangeOrderParkStatus' | 'AssignTagToOrder' | 'ExecuteMacro' | 'AssignIdentifierToOrder' | 'BlockOrderFromMerging' | 'SendToFulfillmentNetwork' | 'SetDispatchDate' | 'AddItemToOrder' | 'AddServiceToOrder' | 'AddNoteToOrder': The type of the action
  - `Properties` RuleActionPropertyResponse[]: Data the action needs to run.
    - `ActionPropertyId` integer: identifier for this action property
    - `DisplayName` string: The name of the property
    - `Value` string: The actual data input for the property
    - `PropertyGroupId` integer: Property grouping key. Used if there are multiple properties with the same name under one action.

---

[API](https://skmtc.dev/linnworks/apis/rules-engine-api.md) - [All operations](https://skmtc.dev/linnworks/apis/rules-engine-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/rules-engine-api/revisions/52df4ad3d247?raw)