v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Projects

Patch Main Project

Update main project details.

A project owner can update all relevant project details, including default name, address and other project related details.

This endpoint will ignore any fields that are empty; only fields with values will be updated.

patch/v1/project/{project_id}/

Path parameters

project_idinteger required

Request body

namestring nullable

The name of the project.

addressstring nullable

The address of the project site.

citystring nullable

The city of the project site.

countrystring nullable

The country of the project site.

timezonestring nullable

The timezone associated with the project site.

phonestring nullable

The main phone number associated with the project site.

longitudenumber nullable

The longitude of the project site.

latitudenumber nullable

The latitude of the project site.

musterPointstring nullable

The muster point for the project site.

isPrivateboolean nullable

Indicates that a project is private.

geoCheckInEnabledboolean nullable

Enable or disable having workers get automatically checked in and out of the site based on their location

Example request

{
  "name": "The Project Name",
  "address": "123 Somewhere Ave",
  "city": "Vancouver",
  "country": "Canada",
  "timezone": "America/Vancouver",
  "phone": "16045551234",
  "longitude": 35.89421911,
  "latitude": 139.94637467,
  "isPrivate": true,
  "geoCheckInEnabled": true
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 123,
    "name": "The Project Name",
    "address": "123 Somewhere Ave",
    "city": "Vancouver",
    "country": "Canada",
    "timezone": "America/Vancouver",
    "phone": "16045551234",
    "longitude": 35.89421911,
    "latitude": 139.94637467,
    "siteCode": 54231,
    "isPrivate": true,
    "geoCheckInEnabled": true
  }
}