Skip to main content
POST
Provisions an inbox headlessly (no browser step). The inbox address derives from the org and the name, for example [email protected]. Inbound mail to it launches a session; replies in the same thread follow up the same session. Bind the inbox to a roster agent with agent_id so runs inherit that agent’s defaults and rubric. Required scope: integrations:write, and the caller must be an org admin or owner.

Request Body

string
required
Display name (1 to 128 characters); becomes the inbox username slug. Name collisions return 409.
string
Roster agent ID the inbox binds to (stored in config.agent_id).
string
Org template sessions launch from.
string
Default repo (owner/name) for launched sessions.
string
default:"claude-code"
Coding agent harness.
object
Additional configuration.