Update project

PUT

admin

api

projects

{id}

Update project

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/projects/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Website Revamp",
  "description": "Rebuild website pages and forms.",
  "visibility": "internal",
  "stage_id": 1,
  "user_id": 1,
  "partner_id": 1,
  "company_id": 1,
  "start_date": "2026-03-01",
  "end_date": "2026-03-31",
  "allocated_hours": 120,
  "allow_timesheets": false,
  "allow_milestones": false,
  "tags": [
    16
  ]
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/projects/projects/{id}"

payload = {
    "name": "Website Revamp",
    "description": "Rebuild website pages and forms.",
    "visibility": "internal",
    "stage_id": 1,
    "user_id": 1,
    "partner_id": 1,
    "company_id": 1,
    "start_date": "2026-03-01",
    "end_date": "2026-03-31",
    "allocated_hours": 120,
    "allow_timesheets": False,
    "allow_milestones": False,
    "tags": [16]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Website Revamp',
    description: 'Rebuild website pages and forms.',
    visibility: 'internal',
    stage_id: 1,
    user_id: 1,
    partner_id: 1,
    company_id: 1,
    start_date: '2026-03-01',
    end_date: '2026-03-31',
    allocated_hours: 120,
    allow_timesheets: false,
    allow_milestones: false,
    tags: [16]
  })
};

fetch('https://erp.arukz.com/admin/api/v1/projects/projects/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/projects/projects/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Website Revamp',
    'description' => 'Rebuild website pages and forms.',
    'visibility' => 'internal',
    'stage_id' => 1,
    'user_id' => 1,
    'partner_id' => 1,
    'company_id' => 1,
    'start_date' => '2026-03-01',
    'end_date' => '2026-03-31',
    'allocated_hours' => 120,
    'allow_timesheets' => false,
    'allow_milestones' => false,
    'tags' => [
        16
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Path Parameters

integer

required

The project ID

Example:

1

Body

application/json

name

string

Project name. Must not be greater than 255 characters.

Example:

"Website Revamp"

description

string | null

Project description.

Example:

"Rebuild website pages and forms."

visibility

enum<string>

Project visibility.

Available options:

private,

internal,

public

Example:

"internal"

stage_id

integer

Project stage ID. The id of an existing record in the projects_project_stages table.

Example:

1

user_id

integer | null

Project manager user ID. The id of an existing record in the users table.

Example:

1

partner_id

integer | null

Customer ID. The id of an existing record in the partners_partners table.

Example:

1

company_id

integer | null

Company ID. The id of an existing record in the companies table.

Example:

1

start_date

string | null

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.

Example:

"2026-03-01"

end_date

string | null

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.

Example:

"2026-03-31"

allocated_hours

number | null

Allocated effort in hours. Must be at least 0.

Example:

120

allow_timesheets

boolean | null

Allow timesheet entries.

Example:

false

allow_milestones

boolean | null

Allow milestone usage.

Example:

false

Response

Success

⌘I

Update project

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/projects/projects/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Website Revamp",
  "description": "Rebuild website pages and forms.",
  "visibility": "internal",
  "stage_id": 1,
  "user_id": 1,
  "partner_id": 1,
  "company_id": 1,
  "start_date": "2026-03-01",
  "end_date": "2026-03-31",
  "allocated_hours": 120,
  "allow_timesheets": false,
  "allow_milestones": false,
  "tags": [
    16
  ]
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/projects/projects/{id}"

payload = {
    "name": "Website Revamp",
    "description": "Rebuild website pages and forms.",
    "visibility": "internal",
    "stage_id": 1,
    "user_id": 1,
    "partner_id": 1,
    "company_id": 1,
    "start_date": "2026-03-01",
    "end_date": "2026-03-31",
    "allocated_hours": 120,
    "allow_timesheets": False,
    "allow_milestones": False,
    "tags": [16]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Website Revamp',
    description: 'Rebuild website pages and forms.',
    visibility: 'internal',
    stage_id: 1,
    user_id: 1,
    partner_id: 1,
    company_id: 1,
    start_date: '2026-03-01',
    end_date: '2026-03-31',
    allocated_hours: 120,
    allow_timesheets: false,
    allow_milestones: false,
    tags: [16]
  })
};

fetch('https://erp.arukz.com/admin/api/v1/projects/projects/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://erp.arukz.com/admin/api/v1/projects/projects/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Website Revamp',
    'description' => 'Rebuild website pages and forms.',
    'visibility' => 'internal',
    'stage_id' => 1,
    'user_id' => 1,
    'partner_id' => 1,
    'company_id' => 1,
    'start_date' => '2026-03-01',
    'end_date' => '2026-03-31',
    'allocated_hours' => 120,
    'allow_timesheets' => false,
    'allow_milestones' => false,
    'tags' => [
        16
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

Get started

Endpoints

Authorizations

Path Parameters

Body

Response