Update a project module

Early access: request API access for your workspace at https://bauhow.com/support before using this endpoint.

Replaces the module payload and/or sets its status. Locked modules reject payload changes.

PATCH/v1/projects/{projectId}/modules/{moduleKey}

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (`bh_…`).

Path parameters

projectIdstringrequired

min length 1

moduleKeystringrequired

Allowed:project-informationraumweiseheizlast-huellflaecheverbrauchwaermepumpejazwirtschaftlichkeitfoerderrechnerfoerderwissenschallrechnerchecku-wert-rechnerfoerderservicenachweisservice

Request body

application/json

statusstring

Allowed:not_starteddraftreadycalculatingcompletedsubmittedlockedfailed

schemaVersioninteger

min -9007199254740991 · max 9007199254740991

payloadobject | any

Show properties

Any of:

object

object

any

any

Responses

200OK

idstringrequired

projectIdstringrequired

moduleKeystringrequired

Allowed:project-informationraumweiseheizlast-huellflaecheverbrauchwaermepumpejazwirtschaftlichkeitfoerderrechnerfoerderwissenschallrechnerchecku-wert-rechnerfoerderservicenachweisservice

statusstringrequired

Allowed:not_starteddraftreadycalculatingcompletedsubmittedlockedfailed

schemaVersionintegerrequired

min -9007199254740991 · max 9007199254740991

payloadobject | anyrequired

Show properties

Any of:

object

object

any

any

validationStateobject | anyrequired

Show properties

Any of:

object

object

any

any

lockedReasonstring | anyrequired

Show properties

Any of:

string

string

any

any

lastCompletedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

createdAtstring<date-time>required

updatedAtstring<date-time>required

Request

curl -X PATCH "https://app.bauhow.com/api/v1/projects/string/modules/project-information" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "not_started",
  "schemaVersion": 0,
  "payload": {}
}'

const response = await fetch("https://app.bauhow.com/api/v1/projects/string/modules/project-information", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "status": "not_started",
  "schemaVersion": 0,
  "payload": {}
})
});

import requests

response = requests.patch(
    "https://app.bauhow.com/api/v1/projects/string/modules/project-information",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "status": "not_started",
  "schemaVersion": 0,
  "payload": {}
},
)

Response

{
  "id": "string",
  "projectId": "string",
  "moduleKey": "project-information",
  "status": "not_started",
  "schemaVersion": 0,
  "payload": {},
  "validationState": {},
  "lockedReason": "string",
  "lastCompletedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}