> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olira.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Rename project

> Renames a project or updates its description/environment tag.

```python theme={null}
olira.rename_project(
    project: str,
    name: str | None = None,
    description: str | None = None,
    environment: str | None = None,
) -> Project
```

**Requires scope:** `api:manage-projects`

Requires an org-wide key.

## Parameters

<ParamField body="project" type="str" required>
  Project id or slug.
</ParamField>

<ParamField body="name" type="str | None">
  New display name.
</ParamField>

<ParamField body="description" type="str | None">
  New description.
</ParamField>

<ParamField body="environment" type="str | None">
  New intent tag: "dev", "staging", or "prod".
</ParamField>

## Returns

`Project` — The updated project.

<ResponseField name="id" type="str">
  Olira project id.
</ResponseField>

<ResponseField name="name" type="str">
  Updated display name.
</ResponseField>

<ResponseField name="slug" type="str">
  URL-friendly handle (unchanged by rename).
</ResponseField>

<ResponseField name="description" type="str | None">
  Updated description.
</ResponseField>

<ResponseField name="environment" type="str | None">
  Updated intent tag.
</ResponseField>

<ResponseField name="status" type="str">
  "active" or "deprecated".
</ResponseField>

<ResponseField name="is_default" type="bool">
  True for the organization's default project.
</ResponseField>

<ResponseField name="created_at" type="str | None">
  ISO 8601 creation timestamp.
</ResponseField>

<ResponseField name="deprecated_at" type="str | None">
  ISO 8601 deprecation timestamp, if deprecated.
</ResponseField>

## Raises

| Exception         | When                                                                                                                  |
| ----------------- | --------------------------------------------------------------------------------------------------------------------- |
| `AuthError`       | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.                                      |
| `ValidationError` | HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).   |
| `ServerError`     | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status\_code when applicable. |
| `RateLimitError`  | HTTP 429 — rate limited; check retry\_after (seconds).                                                                |
| `NetworkError`    | Connection timeout, DNS failure, or read error after retries.                                                         |

<RequestExample>
  ```python Python theme={null}
  import olira

  olira.init(api_key="YOUR_ORG_WIDE_API_KEY")
  project = olira.rename_project(project="dev-sandbox", name="Dev 2")
  print(project.name)
  ```

  ```csharp C# theme={null}
  using Olira;

  OliraModule.Init(apiKey: "YOUR_ORG_WIDE_API_KEY");
  var project = OliraModule.RenameProject(project: "dev-sandbox", name: "Dev 2");
  Console.WriteLine(project.Name);
  ```

  ```http HTTP theme={null}
  PATCH /v1/projects/68582e4a0a0b3c1234567890
  Authorization: Bearer YOUR_ORG_WIDE_API_KEY
  Content-Type: application/json

  {
    "name": "Dev 2"
  }
  ```
</RequestExample>

<ResponseExample>
  ```python 200 theme={null}
  Project(
      id="68582e4a0a0b3c1234567890",
      name="Dev 2",
      slug="dev-sandbox",
      description=None,
      environment="dev",
      status="active",
      is_default=False,
      created_at="2026-06-25T10:00:00Z",
      deprecated_at=None,
  )
  ```

  ```json 401 theme={null}
  {
    "error": true,
    "status_code": 401,
    "error_type": "authentication_error",
    "message": "Could not validate credentials",
    "details": [
      {
        "type": "authentication_error",
        "message": "Could not validate credentials"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 403 theme={null}
  {
    "error": true,
    "status_code": 403,
    "error_type": "authorization_error",
    "message": "Insufficient OAuth scope for this endpoint",
    "details": [
      {
        "type": "authorization_error",
        "message": "Insufficient OAuth scope for this endpoint"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 404 theme={null}
  {
    "error": true,
    "status_code": 404,
    "error_type": "not_found_error",
    "message": "Patient not found",
    "details": [
      {
        "type": "not_found_error",
        "message": "Patient not found"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 422 theme={null}
  {
    "error": true,
    "status_code": 422,
    "error_type": "validation_error",
    "message": "Request validation failed (1 error)",
    "details": [
      {
        "type": "missing",
        "message": "Field required",
        "field": "patient_id",
        "location": ["body", "patient_id"],
        "input_value": null
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 429 theme={null}
  {
    "error": true,
    "status_code": 429,
    "error_type": "server_error",
    "message": "Rate limit exceeded",
    "details": [
      {
        "type": "rate_limit",
        "message": "Too many requests; retry after backoff"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 500 theme={null}
  {
    "error": true,
    "status_code": 500,
    "error_type": "internal_server_error",
    "message": "An internal server error occurred",
    "details": [
      {
        "type": "internal_server_error",
        "message": "An unexpected error occurred while processing your request"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```
</ResponseExample>