Projects

Update a project

Partially updates a project: only fields present in the request change. draw_assessment_question_ids replaces the full set of Draw Assessment Questions applied to the project (an empty list clears them); every id must name a question in the project's organization — discover them via GET /draw-assessment-questions — and may appear at most once.

patch/projects/{projectId}

Request

  • Base URL: https://api.rabbet.com/v1
  • URL: https://api.rabbet.com/v1/projects/{projectId}
  • Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: write)

Path parameters

projectIdstring uuid required

Rabbet project UUID. To resolve your own identifier to a project, use GET /projects?custom_id=....

Headers

Idempotency-Keystring

Optional client-supplied key making this request idempotent. Reuse the same value (for the same request) to safely retry.

Request body

namestring

Name for the project.

street_addressstring nullable
citystring nullable
statestring nullable
zipstring nullable
start_datestring date nullable

The project's anticipated start date.

team_idstring uuid nullable

Id of the team to assign the project to. Must be a team of your organization — assigning a team gives its members access to the project; discover them via GET /teams.

draw_assessment_question_idsstring[]

Ids of the Draw Assessment Questions to apply to the project, replacing the current set. Each must belong to the project's organization; discover them via GET /draw-assessment-questions.

Example request

{
  "name": "Theodore Hotel Austin",
  "street_address": "123 Foobar St",
  "city": "Austin",
  "state": "TX",
  "zip": "78757",
  "start_date": "2026-04-15",
  "team_id": "a3f1c9de-2b47-4f80-9c11-5d2e7a6b8c04",
  "draw_assessment_question_ids": [
    "d290f1ee-6c54-4b01-90e6-d701748f0851"
  ]
}

Response

The updated project.

Example response

{
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Theodore Hotel Austin",
    "custom_id": "SANY-4471",
    "street_address": "123 Foobar St",
    "city": "Austin",
    "state": "TX",
    "zip": "78757",
    "start_date": "2026-04-15",
    "status": "active",
    "project_type_id": "e5a0e6db-0367-4d21-b0a4-6a3b3f4c9f2a",
    "team_id": "a3f1c9de-2b47-4f80-9c11-5d2e7a6b8c04",
    "custom_fields": [
      {
        "id": "b308e77f-6d1d-47c4-bd1f-0069cc548315",
        "label": "Project Number",
        "field_name": "loan_id",
        "type": "text",
        "value": "PN123"
      }
    ],
    "draw_assessment_questions": [
      {
        "id": "b308e77f-6d1d-47c4-bd1f-0069cc548315",
        "label": "Site Progress",
        "description": "Describe the current site progress",
        "field_name": "ta_group",
        "field_type": "text"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.