Skip to main content
POST
Remove a folder

Authorizations

Authorization
string
header
required

Bearer credential for one agent: an API key or an access token (a JWT). Pass as Authorization: Bearer <credential>.

A key is shown once when it is issued and is not recoverable afterwards; an access token lives five minutes and is fetched with the agent's own client key from the access service. Treat both as secrets: they reach one agent's mail, and anything a delegation has extended to it. An access token's scope is a ceiling on what the agent may do with it.

Body

application/json
in
string
required

The mailbox, by its agent's identifier.

Example:

"ag_01j9x2v8k3e0080000000000"

folder
string
required

inbox, quarantine, sent, or a folder the mailbox made: lowercase letters, digits and hyphens, at most 48 characters, not corr or unread.

Pattern: ^[a-z0-9][a-z0-9-]{0,47}$
Example:

"receipts"

idempotency_key
string

Response

The write was applied.

ref
string
created
boolean
effects
object[]

What the write changed.

error
object