Skip to content

Set Inbox Email Settings

PUT
/inbox/email-settings

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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

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.

object
agent_id
Any of:
string
auto_tagging
boolean
business_hours_end
integer
default: 17
business_hours_only

Restrict AI replies to the hours below.

boolean
business_hours_start
integer
default: 9
event_id
Any of:
integer
refresh_rate

Minutes between sync rounds.

integer
default: 1
timezone
required

IANA timezone name, e.g. America/New_York. Required.

string

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string