---
title: "Patch Company Project"
method: PATCH
path: "/v1/project/{project_id}/company/"
tags: ["Projects"]
---

# Patch Company Project

`PATCH /v1/project/{project_id}/company/`

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.

## Path parameters

- `project_id` integer, required

## Request body

- ProjectCompanyPatchModel — Company specific project details that can optionally be updated
  - `externalId` string, nullable — The unique identifier used by an external system, can be used to support integration.
  - `externalSystemName` string, nullable — The name of the external system that the external_id field belongs to.
  - `isArchived` boolean — Indicates if the company wants to archive the site.
  - `displayName` string, nullable — The display name for a project that can be customized per company working on a project.
  - `accountingName` string, nullable — The project name as it's represented in the accounting or financial system, in case it's different from the main project name.
  - `jobNumber` string, nullable — Optional specifier for an external project number.
  - `siteClass` string, nullable — The project site class.
  - `description` string, nullable
  - `nearestHospital` string, nullable — Name of the nearest hospital to the site
  - `nearestClinic` string, nullable — Name of the nearest medical clinic to the site
  - `firstAidAttendant` string, nullable — Name of the first aid attendant for the site
  - `siteLinkOne` string, nullable — Any additional links for the site
  - `siteLinkTwo` string, nullable — Any additional links for the site
  - `siteLinkThree` string, nullable — Any additional links for the site
  - `udf1` string, nullable — Field for storing customer-defined metadata about the site
  - `udf2` string, nullable — Field for storing customer-defined metadata about the site
  - `udf3` string, nullable — Field for storing customer-defined metadata about the site

## Response `200`

Successful Response

- ApiGenericResponseProjectCompanyDetailsModel
  - `error` boolean — A boolean error indicator.
  - `message` string, nullable — Optional message.
  - `data` ProjectCompanyDetailsModel — Full version of company-specific project details
    - `externalId` string, nullable, required — The unique identifier used by an external system, can be used to support integration.
    - `externalSystemName` string, nullable, required — The name of the external system that the external_id field belongs to.
    - `isArchived` boolean, required — Indicates that a project has been archived for this company.
    - `udf1` string, nullable — Field for storing customer-defined metadata about the site
    - `udf2` string, nullable — Field for storing customer-defined metadata about the site
    - `udf3` string, nullable — Field for storing customer-defined metadata about the site
    - `displayName` string, nullable, required — The display name for a project that can be customized per company working on a project.
    - `accountingName` string, 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.
    - `jobNumber` string, nullable, required — Optional specifier for an external project number.
    - `siteClass` string, nullable, required — The project site class.
    - `description` string, nullable, required
    - `nearestHospital` string, nullable, required — Name of the nearest hospital to the site
    - `nearestClinic` string, nullable, required — Name of the nearest medical clinic to the site
    - `firstAidAttendant` string, nullable, required — Name of the first aid attendant for the site
    - `siteLinkOne` string, nullable, required — Any additional links for the site
    - `siteLinkTwo` string, nullable, required — Any additional links for the site
    - `siteLinkThree` string, nullable, required — Any additional links for the site
    - `udf1Label` string, nullable — Label for the customer-defined metadata about the site
    - `udf2Label` string, nullable — Label for the customer-defined metadata about the site
    - `udf3Label` string, nullable — Label for the customer-defined metadata about the site

## Other responses

- `400` — Business Logic Error
- `403` — Permission Error
- `409` — Integrity Error or Data Conflict
- `422` — Validation Error

---

[API](https://skmtc.dev/salussafety/apis/salus-developer-api.md) · [All operations](https://skmtc.dev/salussafety/apis/salus-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/salussafety/salus-developer-api/revisions/ef065f44da25/schema)