PATCH /project/{projectId} — update project settings

Use this endpoint to change a project’s configuration after it has been created. You can update the display name, toggle public or private access, control whether reviewers can comment anonymously, and set the language displayed in the review interface. Include only the fields you want to change — all body fields are optional, but at least one must be present.

PATCH https://api.bugsmash.io/api/v2/project/{projectId}

Request headers

string

required

Your Bugsmash API key.

string

required

Must be application/json.

Path parameters

uuid

required

The UUID of the project to update.

Request body

At least one of the following fields is required.

string

New display name for the project.

Access level for the review link. Accepted values: "public" or "private".

boolean

When true, reviewers can leave comments without logging in to Bugsmash.

string

Language short code for the review interface (for example, "en", "pl", "de").

Example

curl --location --request PATCH 'https://api.bugsmash.io/api/v2/project/{projectId}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Home Design 2",
    "share_access": "private",
    "anonymous_comments": false,
    "review_language": "pl"
  }'

{
  "status": true,
  "message": "Project updated successfully",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Home Design 2",
    "settings": {
      "share_access": "private",
      "anonymous_comments": false,
      "review_language": "pl"
    }
  }
}

Response fields

boolean

required

true when the update succeeded.

string

required

Human-readable status message.

object

required

Hide properties

string

required

UUID of the updated project.

string

required

Current display name of the project after the update.

object

required

Show properties

Current access level: "public" or "private".

boolean

required

Whether anonymous commenting is currently enabled.

string

required

Current language short code for the review interface.

Folders

Versions

Projects

Comments

Webhooks

PATCH /project/{projectId} — update project settings

Request headers

Path parameters

Request body

Example

Response fields

​Request headers

​Path parameters

​Request body

​Example

​Response fields

Request headers

Path parameters

Request body

Example

Response fields