Skip to content

Mints an opaque navigation token without advancing durable cursor state.

GET
/v1/m/sessions/inbox/cursors/personal/{recipient}
curl --request GET \
--url 'https://example.com/v1/m/sessions/inbox/cursors/personal/example?workspace_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&target=example' \
--header 'Authorization: Bearer <token>'

Mints an opaque navigation token without advancing durable cursor state.

recipient
required
string

Path parameter recipient.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

workspace_id
required
string format: uuid
/^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/

Canonical stored workspace UUID selected for this personal collection; it is revalidated and never grants authority.

target
required
string
>= 1 characters <= 2048 characters

Opaque c2n1 cursor target returned by inbox listing and revalidated against the current mailbox and cursor lineage.

Durable cursor target minted

Media type application/json
object
cursor
required
string
cursor_id
string format: uuid
etag
required
string
version
required
integer format: int64
Example generated
{
"cursor": "example",
"cursor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"etag": "example",
"version": 1
}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Precondition failed

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}

Current authority, custody or store evidence is unavailable; or, with code commit_outcome_unknown, the write was issued and its outcome was never learned, so it may be durable and must not be retried automatically

Media type application/json
object
Example generated
{}