---
title: "Set Inbox Email Settings"
method: PUT
path: "/inbox/email-settings"
tags: ["AI Inbox"]
---

# Set Inbox Email Settings

`PUT /inbox/email-settings`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/email-settings`
- Auth: HTTP bearer

Create or replace the organisation's AI Inbox email settings.

A PUT because it REPLACES: the app writes every field, so anything you
omit is written as its default rather than left alone. Read the current
settings, change the one field, send the whole thing back.

`business_hours_only` plus the start/end hours are what stop the AI
replying to a customer at 3am. `event_id` is the booking event it offers
when it schedules a meeting.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- EmailSettingsRequest: Organisation-wide AI Inbox email settings. There is no per-user copy. This is a REPLACE, not a merge: the app writes every field, so a value you omit is written as its default rather than left alone. Read the current settings first and send them back with your change applied.
  - `refresh_rate` integer: Minutes between sync rounds.
  - `timezone` string, required: IANA timezone name, e.g. `America/New_York`. Required.
  - `event_id` integer, nullable: Booking event the AI offers when it schedules a meeting.
  - `agent_id` union: AI Inbox agent that answers. See `POST /inbox/agents`.
    - string
    - integer
  - `auto_tagging` boolean
  - `business_hours_only` boolean: Restrict AI replies to the hours below.
  - `business_hours_start` integer
  - `business_hours_end` integer

## Response `200`

Successful Response

- ApiResponseInboxPayload
  - `data` InboxPayload, required: An open envelope for a comment, an assignment or a workspace. Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)