Skip to content

Create Inbox Agent

POST
/inbox/agents

Create an AI Inbox agent - the named responder tags and email settings point at.

NOT the Copilot Agent Runtime at /agent/*, which runs and approves autonomous work. Different object, similar name; the context notes record that this pair has already misled an audit.

Names are unique per organisation: a repeat is a 400, not a second agent.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create an AI Inbox agent.

NOT the Copilot Agent Runtime at /agent/* - that surface runs and approves autonomous work. This is the named responder an inbox tag or an email setting points at.

object
name
required

Unique within the organisation.

string

Responses

201

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