Skip to main content
PUT
/
api
/
projects
/
{projectId}
Update a project
curl --request PUT \
  --url https://api.example.com/api/projects/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "key": "<string>",
  "protected": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "key": "<string>",
  "protected": true,
  "deletedAt": "<string>",
  "decisionsApprovalGroups": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.gorules.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

​
projectId
string<uuid>
required

Unique identifier of the project to update

Body

application/json
​
name
string
required

New name for the project

​
key
string
required

New unique key identifier for the project

Pattern: ^[a-z0-9]{2,}(-[a-z0-9]+)*$
​
protected
boolean

Whether the project should be protected from deletion (admin/owner only)

Example:

false

Response

200 - application/json

Updated project details

Updated project details

​
id
string<uuid>
required

Unique identifier of the project

​
name
string
required

Name of the project

​
organisationId
string<uuid>
required

Organisation ID the project belongs to

​
version
enum<string>
required

Project version (v1 or v2)

Available options:
v1,
v2
​
createdAt
string
required

Timestamp when the project was created

​
updatedAt
string
required

Timestamp when the project was last updated

​
key
string

Unique key identifier for the project

​
protected
boolean

Whether the project is protected from deletion

​
deletedAt
string | null

Timestamp when the project was soft deleted

​
decisionsApprovalMode
enum<string> | null

Approval mode for decisions

Available options:
require_one_per_team,
none_create_request,
require_any,
none,
null
​
decisionsApprovalGroups
object[]

Groups required for decision approvals