> ## 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 project

> Update an existing project

Also accepts `PATCH` with the same body.



## OpenAPI

````yaml /api-reference/openapi.json put /admin/api/v1/projects/projects/{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/projects/projects/{id}:
    put:
      tags:
        - Projects
      summary: Update project
      description: |-
        Update an existing project

        Also accepts `PATCH` with the same body.
      operationId: projects-update-project
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            description: The project ID
            example: 1
          description: The project ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Project name. Must not be greater than 255 characters.
                  example: Website Revamp
                description:
                  type: string
                  description: Project description.
                  nullable: true
                  example: Rebuild website pages and forms.
                visibility:
                  type: string
                  description: Project visibility.
                  enum:
                    - private
                    - internal
                    - public
                  example: internal
                stage_id:
                  type: integer
                  description: >-
                    Project stage ID. The `id` of an existing record in the
                    projects_project_stages table.
                  example: 1
                user_id:
                  type: integer
                  description: >-
                    Project manager user ID. The `id` of an existing record in
                    the users table.
                  nullable: true
                  example: 1
                partner_id:
                  type: integer
                  description: >-
                    Customer ID. The `id` of an existing record in the
                    partners_partners table.
                  nullable: true
                  example: 1
                company_id:
                  type: integer
                  description: >-
                    Company ID. The `id` of an existing record in the companies
                    table.
                  nullable: true
                  example: 1
                start_date:
                  type: string
                  description: >-
                    Planned start date. This field is required when `end_date`
                    is present. Must be a valid date. Must be a date before or
                    equal to `end_date`.
                  nullable: true
                  example: '2026-03-01'
                end_date:
                  type: string
                  description: >-
                    Planned end date. This field is required when `start_date`
                    is present. Must be a valid date. Must be a date after or
                    equal to `start_date`.
                  nullable: true
                  example: '2026-03-31'
                allocated_hours:
                  type: number
                  description: Allocated effort in hours. Must be at least 0.
                  nullable: true
                  example: 120
                allow_timesheets:
                  type: boolean
                  description: Allow timesheet entries.
                  nullable: true
                  example: false
                allow_milestones:
                  type: boolean
                  description: Allow milestone usage.
                  nullable: true
                  example: false
                tags:
                  type: array
                  items:
                    type: integer
                  description: The `id` of an existing record in the projects_tags table.
                  example:
                    - 16
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                data:
                  id: 1
                  name: Client Task for Magement Work
                  tasks_label: null
                  description: <p>Client Task for Magement Work</p>
                  visibility: internal
                  color: null
                  sort: 1
                  start_date: '2025-04-11T00:00:00.000000Z'
                  end_date: '2025-04-30T00:00:00.000000Z'
                  allocated_hours: 500
                  allow_timesheets: true
                  allow_milestones: true
                  allow_task_dependencies: false
                  is_active: true
                  stage_id: 1
                  partner_id: 21
                  company_id: 3
                  user_id: 1
                  creator_id: 1
                  created_at: '2025-04-11T11:01:38.000000Z'
                  updated_at: '2025-04-11T11:01:38.000000Z'
                  deleted_at: null
                message: Project updated successfully.
        '401':
          description: Unauthenticated
          content:
            application/json:
              example:
                message: Unauthenticated.
        '404':
          description: Project not found
          content:
            application/json:
              example:
                message: Resource 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.