Projects

Update a project

Changed on

Partially updates a project: only the fields present in the request are applied, and at least one must be present. Renaming does not change the slug.

name and options require the update-project permission on the project.

restricted and members apply to organization projects only and require the organization's update-project permission (the organization owner always has it). They must be sent by a signed-in user; requests authenticated with an access token cannot change them. members replaces the full member list, and the organization owner is always kept. Restricting without members keeps every current organization member, so who can see the project does not change; restricting with members sets the list to exactly the owner plus those members.

Returns the updated project with its member list.

post/v1/account/{accountSlug}/project/{projectSlug}

Request

Path parameters

accountSlugstring required

Account slug of the user

projectSlugstring required

Project slug of the account

Request body

namestring

New project name, 1 to 100 characters. The slug stays unchanged.

optionsobject

Replaces the project options object.

restrictedboolean

Organization projects only. true restricts the project to its explicit members; false opens it to every organization member. Restricting without members keeps every current organization member as a project member, so visibility does not change. Restricting together with members sets the member list to exactly the organization owner plus the given members (an empty list means the owner only).

membersstring[]

Organization projects only. Replaces the full member list with these principal IDs of accepted organization members. The organization owner is always kept. Cannot be combined with restricted: false.

Example request

{
  "name": "Mainnet Monitoring v2",
  "restricted": true,
  "members": [
    "2f6a3c4e-1b7d-4e0a-9c11-5d2e8a7b9f30"
  ]
}

Response

A successful response.

Example response

{
  "project": {
    "id": "d66fd37f-e2f8-46c3-b549-0160d60eec96",
    "name": "Mainnet Monitoring",
    "slug": "mainnet-monitoring",
    "owner_id": "49309f73-1d60-48fc-94b3-120fd9982381",
    "created_at": "2026-09-07T16:12:22.895718Z",
    "owner": {
      "id": "49309f73-1d60-48fc-94b3-120fd9982381",
      "username": "acme",
      "type": "organization"
    },
    "permissions": {
      "add_contract": true,
      "update_contract": true,
      "remove_contract": true,
      "create_alert": true,
      "update_alert": true,
      "remove_alert": true,
      "create_and_update_analytics": true,
      "manage_collaborators": true
    },
    "members": [
      {
        "id": "2f6a3c4e-1b7d-4e0a-9c11-5d2e8a7b9f30",
        "username": "jane",
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane@example.com",
        "accepted": true,
        "added_at": "2026-08-25T09:14:03.201Z"
      }
    ]
  }
}

Changes