v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Projects

Update Company Project

Update the company-specific settings for a project.

This will configure settings primarily for display information.

This endpoint can be called by any company owner that has been added to a site where that owner can update their own display 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}/company/

Path parameters

project_idinteger required

Request body

externalIdstring nullable required

The unique identifier used by an external system, can be used to support integration.

externalSystemNamestring nullable required

The name of the external system that the external_id field belongs to.

isArchivedboolean required

Indicates that a project has been archived for this company.

udf1string nullable

Field for storing customer-defined metadata about the site

udf2string nullable

Field for storing customer-defined metadata about the site

udf3string nullable

Field for storing customer-defined metadata about the site

displayNamestring nullable required

The display name for a project that can be customized per company working on a project.

accountingNamestring nullable required

The project name as it's represented in the accounting or financial system, in case it's different from the main project name.

jobNumberstring nullable required

Optional specifier for an external project number.

siteClassstring nullable required

The project site class.

descriptionstring nullable required

nearestHospitalstring nullable required

Name of the nearest hospital to the site

nearestClinicstring nullable required

Name of the nearest medical clinic to the site

firstAidAttendantstring nullable required

Name of the first aid attendant for the site

siteLinkOnestring nullable required

Any additional links for the site

siteLinkTwostring nullable required

Any additional links for the site

siteLinkThreestring nullable required

Any additional links for the site

Example request

{
  "externalId": "100123",
  "externalSystemName": "Procore",
  "udf1": "Canada Division",
  "udf2": "BC Division",
  "udf3": "Eli's team",
  "displayName": "Company Prefix - Project Name",
  "accountingName": "ACCT-SYS-01-PRJ-NAME",
  "jobNumber": "001-PRJ-NAME",
  "siteClass": "Site Class",
  "nearestHospital": "Vancouver General Hospital",
  "nearestClinic": "Alberni Medical Clinic",
  "firstAidAttendant": "Jane Doe",
  "siteLinkOne": "https://example.com",
  "siteLinkTwo": "https://example.com",
  "siteLinkThree": "https://example.com"
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "externalId": "100123",
    "externalSystemName": "Procore",
    "udf1": "Canada Division",
    "udf2": "BC Division",
    "udf3": "Eli's team",
    "displayName": "Company Prefix - Project Name",
    "accountingName": "ACCT-SYS-01-PRJ-NAME",
    "jobNumber": "001-PRJ-NAME",
    "siteClass": "Site Class",
    "nearestHospital": "Vancouver General Hospital",
    "nearestClinic": "Alberni Medical Clinic",
    "firstAidAttendant": "Jane Doe",
    "siteLinkOne": "https://example.com",
    "siteLinkTwo": "https://example.com",
    "siteLinkThree": "https://example.com",
    "udf1Label": "Division",
    "udf2Label": "Subdivision",
    "udf3Label": "Team"
  }
}