v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Projects

Update Main Project

Update main project details.

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

The whole object must be specified when using this endpoint, and optional fields will be set to empty. The PATCH endpoint can be used to update only specific fields. Typically, this endpoint is called after a request to get details.

put/v1/project/{project_id}/

Path parameters

project_idinteger required

Request body

namestring required

The name of the project.

addressstring required

The address of the project site.

citystring required

The city of the project site.

countrystring required

The country of the project site.

timezonestring required

The timezone associated with the project site.

phonestring nullable required

The main phone number associated with the project site.

longitudenumber nullable required

The longitude of the project site.

latitudenumber nullable required

The latitude of the project site.

musterPointstring nullable required

The muster point for the project site.

isPrivateboolean required

Indicates that a project is private.

geoCheckInEnabledboolean required

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
  }
}