latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Projects

Update project

Updates project attributes.

patch/v1/projects/{projectId}

Path parameters

projectIdstring required

Project identifier.

Example:prj_example

Project identifier.

Request body

namestring

Updated project name.

descriptionstring nullable

Updated description. Use null to clear.

Example request

{
  "name": "Payments Updated",
  "description": "Updated project description.",
  "settings": {
    "rpcProvider": "custom",
    "rpcEndpoint": "https://rpc.example.com"
  }
}

Response

Project updated

Example response

{
  "data": {
    "project": {
      "id": "prj_example",
      "organizationId": "org_example",
      "name": "Payments",
      "slug": "payments",
      "description": "Payments workflow",
      "environment": "sandbox",
      "settings": {
        "rpcProvider": "default",
        "rpcEndpoint": "https://rpc.example.com",
        "webhookUrl": "https://example.com/webhook",
        "metadata": {
          "region": "us"
        }
      },
      "status": "active",
      "createdBy": "usr_example",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}