Update Company Project

put

https://developer.beta.salussafety.io/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.

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

integer

required

Body Params

Company specific project details that can be updated

externalId

string | null

required

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

externalSystemName

string | null

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

Field for storing customer-defined metadata about the site

udf2

string | null

Field for storing customer-defined metadata about the site

udf3

string | null

Field for storing customer-defined metadata about the site

displayName

string | null

required

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

accountingName

string | null

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

required

Optional specifier for an external project number.

siteClass

string | null

required

The project site class.

description

string | null

required

nearestHospital

string | null

required

Name of the nearest hospital to the site

nearestClinic

string | null

required

Name of the nearest medical clinic to the site

firstAidAttendant

string | null

required

Name of the first aid attendant for the site

siteLinkOne

string | null

required

Any additional links for the site

siteLinkTwo

string | null

required

Any additional links for the site

siteLinkThree

string | null

required

Any additional links for the site

Responses

200Successful Response

400Business Logic Error

403Permission Error

409Integrity Error or Data Conflict

422Validation Error