---
title: "Patch Account Settings"
method: PATCH
path: "/v1/account/settings"
tags: ["v1"]
---

# Patch Account Settings

`PATCH /v1/account/settings`

## Request

- Base URL: `https://api.ellipsis.dev`
- URL: `https://api.ellipsis.dev/v1/account/settings`
- Auth: HTTP bearer

Replace supplied settings sections without changing omitted sections.

Changes to the budget ceiling require a GitHub administrator.

## Headers

- `user-agent` string, nullable

## Request body

- PatchAccountSettingsRequest: Replace supplied sections; omitted or null sections stay unchanged.
  - `analytics` AnalyticsSettingsInput
    - `enabled` boolean
  - `budget_ceiling` BudgetCeiling: The organization's spend ceilings, in millicents.
    - `session` integer, nullable: The most a single session may be budgeted, in millicents, as a whole number of cents. A session request or agent asking for more is refused with 400. Null means the platform ceiling applies.
  - `data_retention` DataRetentionSettingsInput
    - `api_requests_days` integer, nullable: Reserved; API request retention is not yet enforced.
    - `archive_inactive_sessions_days` integer: Days without a message before a session is archived. A session is also archived when it closes. 1 to 90, default 7.
    - `environment_snapshots_days` integer: Retention of newly created reusable environment snapshots, up to 28 days from creation. Paused session workspaces have a separate lifetime.
    - `session_logs_days` integer, nullable: Days after a session is archived before its records and messages are deleted. The session itself stays. Null keeps them.
    - `webhooks_days` integer, nullable: Reserved; webhook retention is not yet enforced.
  - `notifications` NotificationSettings
    - `email_contacts` NotificationEmailContact[]
      - `categories` NotificationCategory[], nullable
      - `email` string, required

## Response `200`

Successful Response

- AccountSettings
  - `analytics` AnalyticsSettingsOutput, required
    - `enabled` boolean, required
  - `budget_ceiling` BudgetCeiling: The organization's spend ceilings, in millicents.
    - `session` integer, nullable: The most a single session may be budgeted, in millicents, as a whole number of cents. A session request or agent asking for more is refused with 400. Null means the platform ceiling applies.
  - `data_retention` DataRetentionSettingsOutput, required
    - `api_requests_days` integer, nullable, required: Reserved; API request retention is not yet enforced.
    - `archive_inactive_sessions_days` integer, required: Days without a message before a session is archived. A session is also archived when it closes. 1 to 90, default 7.
    - `environment_snapshots_days` integer, required: Retention of newly created reusable environment snapshots, up to 28 days from creation. Paused session workspaces have a separate lifetime.
    - `session_logs_days` integer, nullable, required: Days after a session is archived before its records and messages are deleted. The session itself stays. Null keeps them.
    - `webhooks_days` integer, nullable, required: Reserved; webhook retention is not yet enforced.
  - `mention` MentionSettings, required
    - `require_leading_mention` boolean
    - `trigger_on_bot_mention_private_repo` boolean
    - `trigger_on_bot_mention_public_repo` boolean
    - `trigger_on_leading_ellipsis_symbol` boolean
    - `trigger_on_user_mention_private_repo` boolean
    - `trigger_on_user_mention_public_repo` boolean
  - `notifications` NotificationSettings, required
    - `email_contacts` NotificationEmailContact[]
      - `categories` NotificationCategory[], nullable
      - `email` string, required

## Other responses

- `401`: The bearer token is missing, invalid, or revoked.
- `403`: The credential may not perform this action, or the account is blocked.
- `422`: Validation Error

---

[API](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api.md) - [All operations](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ellipsis/apis/ellipsis-rest-api/revisions/344b16df9a1a?raw)