Skip to main content
PATCH
/
projects
/
{id}
Typescript (SDK)
import { Idalia } from "idalia";

const idalia = new Idalia({
  apiKeyAuth: process.env["IDALIA_API_KEY_AUTH"] ?? "",
});

async function run() {
  const result = await idalia.projects.update({
    id: "123",
  });

  console.log(result);
}

run();
{
  "id": "<string>",
  "createdAt": "<string>",
  "workspaceId": "<string>",
  "name": "<string>",
  "updatedAt": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "reference": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "notes": "<string>",
  "statusId": "<string>",
  "companyId": "<string>",
  "locationId": "<string>",
  "externalIds": {}
}

Path Parameters

id
string
required

Project ID

Body

application/json

Project update data

name
string
required

Name of the project

reference
string | null

Reference of the project

startDate
string | null

Datetime the project starts

endDate
string | null

Datetime the project ends

notes
string | null

Notes on the project

statusId
string | null

ID of the project status

companyId
string | null

ID of the company the project is for

locationId
string | null

ID of the location the project

externalIds
object

Response

Returns the updated project object

id
string
required

ID of the project

createdAt
string
required

Datetime the project was created

workspaceId
string
required

ID of the workspace the project belongs to

name
string
required

Name of the project

updatedAt
string | null

Datetimet the project was last updated

createdBy
string | null

ID of the user who created the project

updatedBy
string | null

ID of the user who last updated the project

reference
string | null

Reference of the project

startDate
string | null

Datetime the project starts

endDate
string | null

Datetime the project ends

notes
string | null

Notes on the project

statusId
string | null

ID of the project status

companyId
string | null

ID of the company the project is for

locationId
string | null

ID of the location the project

externalIds
object