Skip to main content
PATCH
Update many projects

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json

Every field is optional. Only the fields you send are changed.

identifier
string

Human-readable id, unique within your organization. Generated in the form PROJ-a1b2c when you leave it out.

name
string

Display name.

isArchived
boolean
default:false

Archived records are hidden from list results unless you ask for them. Set this to archive or restore the record.

archivedAt
string<date-time> | null

When the record was archived. Set automatically when isArchived flips to true, and cleared on restore.

scheduledStartDate
string<date> | null

Planned start of the project.

scheduledEndDate
string<date> | null

Planned finish of the project.

actualEndDate
string<date> | null

Date the project actually finished.

costCode
string | null

Cost code. Trimmed on write, and an empty string is rejected: send a non-empty string or null.

Stored as a plain string. It is not validated against the cost code list, and renaming an entry in that list does not change this value.

Response

The updated projects.

values
object[]
required