v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB

Projects

Patch 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.

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

patch/v1/project/{project_id}/company/

Path parameters

project_idinteger required

Request body

externalIdstring nullable

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

externalSystemNamestring nullable

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

isArchivedboolean

Indicates if the company wants to archive the site.

displayNamestring nullable

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

accountingNamestring nullable

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

Optional specifier for an external project number.

siteClassstring nullable

The project site class.

descriptionstring nullable

nearestHospitalstring nullable

Name of the nearest hospital to the site

nearestClinicstring nullable

Name of the nearest medical clinic to the site

firstAidAttendantstring nullable

Name of the first aid attendant for the site

siteLinkOnestring nullable

Any additional links for the site

siteLinkTwostring nullable

Any additional links for the site

siteLinkThreestring nullable

Any additional links for the site

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

Example request

{
  "externalId": "100123",
  "externalSystemName": "Procore",
  "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",
  "udf1": "Canada Division",
  "udf2": "BC Division",
  "udf3": "Eli's team"
}

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