Skip to content
BuildWorkPro Docs

Update project

PATCH
/projects/{id}

Partially updates a project.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
integer

Request Body

Section titled “Request Body ”
object
name
string
>= 1 characters
projectNumber
string
contactId
integer | null
projectType
string | null
status
string
Allowed values: planning in_progress on_hold closeout completed cancelled
priority
string | null
startDate
Any of:
string format: date-time
expectedEndDate
Any of:
string format: date-time
actualEndDate
Any of:
string format: date-time
contractValue
Any of:
string
description
string | null
siteAddress
string | null
assignedTo
integer | null

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated

object
data
required
object
id
required
integer
name
required
string
projectNumber
required
string
contactId
required
integer | null
bidId
required
integer | null
projectType
required
string | null
status
required
string
priority
required
string | null
startDate
required
Any of:
string format: date-time
expectedEndDate
required
Any of:
string format: date-time
actualEndDate
required
Any of:
string format: date-time
contractValue
required
string | null
description
required
string | null
siteAddress
required
string | null
assignedTo
required
integer | null
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

404

Section titled “404 ”

Not found

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string

422

Section titled “422 ”

Validation failed

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string