> ## Documentation Index
> Fetch the complete documentation index at: https://docs.erp.arukz.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update rule

> Update an existing rule

Also accepts `PATCH` with the same body.



## OpenAPI

````yaml /api-reference/openapi.json put /admin/api/v1/inventories/rules/{id}
openapi: 3.0.3
info:
  title: ARUKZ ERP API
  version: v1
  description: >-
    The REST API of ARUKZ ERP: sales, purchases, inventory, products, partners,
    accounts, projects and reference data. Every call acts as the user whose
    token it carries and sees only that user's company.
servers:
  - url: https://erp.arukz.com
    description: ARUKZ ERP (hosted)
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Sign in for a token and sign out.
  - name: Sales
    description: Quotations, sales orders and their lines, deliveries and invoices.
  - name: Purchases
    description: Purchase orders, receipts, bills, agreements and vendor price lists.
  - name: Inventory
    description: >-
      Warehouses, locations, lots, stock quantities, receipts, deliveries,
      transfers and scrap.
  - name: Products
    description: 'The product catalogue: categories, attributes, variants and packaging.'
  - name: Partners
    description: Customers, vendors, contacts, addresses and bank accounts.
  - name: Accounts
    description: >-
      Invoices, bills, credit notes, refunds, taxes, journals and the chart of
      accounts.
  - name: Projects
    description: Projects, tasks, stages and milestones.
  - name: Reference data
    description: Currencies and rates, banks, countries, states and units of measure.
paths:
  /admin/api/v1/inventories/rules/{id}:
    put:
      tags:
        - Inventory
      summary: Update rule
      description: |-
        Update an existing rule

        Also accepts `PATCH` with the same body.
      operationId: inventory-rules-update-rule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            description: The rule ID
            example: 1
          description: The rule ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Rule name. Must not be greater than 255 characters.
                  example: 'WH1: Stock -> Output'
                action:
                  type: string
                  description: Rule action.
                  enum:
                    - pull
                    - push
                    - pull_push
                    - buy
                  example: pull
                operation_type_id:
                  type: integer
                  description: >-
                    Operation type ID. The `id` of an existing record in the
                    inventories_operation_types table.
                  example: 1
                source_location_id:
                  type: integer
                  description: >-
                    Source location ID. The `id` of an existing record in the
                    inventories_locations table.
                  example: 3
                destination_location_id:
                  type: integer
                  description: >-
                    Destination location ID. The `id` of an existing record in
                    the inventories_locations table.
                  example: 4
                partner_address_id:
                  type: integer
                  description: >-
                    Partner address ID. The `id` of an existing record in the
                    partners_partners table.
                  nullable: true
                  example: 10
                delay:
                  type: integer
                  description: Lead time in days. Must be at least 0.
                  nullable: true
                  example: 1
                route_id:
                  type: integer
                  description: >-
                    Route ID. The `id` of an existing record in the
                    inventories_routes table.
                  example: 1
                company_id:
                  type: integer
                  description: >-
                    Company ID. The `id` of an existing record in the companies
                    table.
                  nullable: true
                  example: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  id: 1
                  name: 'WH: Vendors → Stock'
                  sort: 1
                  route_sort: 9
                  delay: 0
                  group_propagation_option: propagate
                  action: pull
                  procure_method: make_to_stock
                  auto: manual
                  push_domain: null
                  location_dest_from_rule: false
                  propagate_cancel: false
                  propagate_carrier: false
                  created_at: '2025-04-07T13:12:33.000000Z'
                  updated_at: '2025-04-07T13:12:33.000000Z'
                  deleted_at: null
                message: Rule updated successfully.
        '401':
          description: Unauthenticated
          content:
            application/json:
              example:
                message: Unauthenticated.
        '404':
          description: Rule not found
        '422':
          description: Validation error
          content:
            application/json:
              example:
                message: The given data was invalid.
                errors:
                  name:
                    - The name field is required.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API token from [Sign in](/api-reference/authentication), sent as
        `Authorization: Bearer <token>`. Tokens last 30 days.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.