v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

projects

Update a single project

Requires projects:write scopes.

patch/projects/{projectId}

Path parameters

projectIdstring uuid required

The Project Id

Request body

namestring

The name of the project

accountIdsstring[]

Account IDs that are associated with the project

type'PropertyProject' | 'RentalProject' | 'GenericProject'

The project type

archivedboolean

Flag to determine if project is archived or not

Example request

{
  "name": "Home Improvement",
  "accountIds": [
    "c390a94f-2309-4cdf-8d02-b0c5304d9f66"
  ],
  "type": "RentalProject",
  "archived": true
}

Response

Successful Project Response

metaobject

Example response

{
  "data": {
    "name": "Home Improvement",
    "accountIds": [
      "c390a94f-2309-4cdf-8d02-b0c5304d9f66"
    ],
    "type": "RentalProject",
    "dateCreated": "2018-07-11T03:51:08.000Z",
    "archived": false
  }
}