tools.ozone.inbox.defs
#subjectView
A subject belonging to the viewer that has moderation actions against it.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| src | string (did) | - | ✅ | DID of the moderation service that took the actions. |
| subject | union of com.atproto.admin.defs#repoRef com.atproto.repo.strongRef | - | ✅ | - |
| enforcement | #enforcementView | - | ✅ | - |
| appeal | #appealView | - | ❌ | - |
| availableActions | array of string | - | ❌ | - |
| latestAction | #actionView | - | ❌ | - |
| actionCount | integer | - | ❌ | - |
| createdAt | string (datetime) | - | ✅ | - |
| updatedAt | string (datetime) | - | ✅ | - |
| isRead | boolean | - | ✅ | - |
#enforcementView
The current enforcement state of a subject.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| state | string | none labeled removed suspended takendown | ✅ | - |
| scope | string | network app labelOnly | ❌ | - |
| expiresAt | string (datetime) | - | ❌ | - |
| labels | array of string | - | ❌ | Active label values on the subject, excluding negated and expired labels. |
#appealView
The state of the viewer's appeal against the actions on a subject.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| state | string | none pending resolved superseded expired | ✅ | - |
| appealedAt | string (datetime) | - | ❌ | - |
| resolvedAt | string (datetime) | - | ❌ | When the appeal's report was closed. |
| outcome | string | approved denied | ❌ | Decision on a resolved appeal. |
| appealableUntil | string (datetime) | - | ❌ | - |
#actionView
A single moderation action taken against a subject.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| id | integer | - | ✅ | Action ID (moderation event ID). |
| type | string | - | ✅ | Public action type. |
| scope | string | network app labelOnly | ❌ | - |
| createdAt | string (datetime) | - | ✅ | - |
| reversedAt | string (datetime) | - | ❌ | - |
| expiresAt | string (datetime) | - | ❌ | - |
| labels | array of string | - | ❌ | Label values, for labelApplied/labelRemoved. |
| policies | array of #policyView | - | ❌ | Policies applied by a takedown action. |
#policyView
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| key | string | - | ✅ | - |
| displayName | string | - | ✅ | - |
| link | string (uri) | - | ✅ | - |
#subjectViewDetail
A subject with a page of its action history and an aggregate report summary. Follow cursor to retrieve older actions; enforcement and appeal describe the current subject state on every page.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| src | string (did) | - | ✅ | - |
| isRead | boolean | - | ✅ | - |
| subject | union of com.atproto.admin.defs#repoRef com.atproto.repo.strongRef | - | ✅ | - |
| record | unknown | - | ❌ | Raw record JSON for the subject, when the subject is a record and the record is available. |
| enforcement | #enforcementView | - | ✅ | - |
| appeal | #appealView | - | ❌ | - |
| availableActions | array of string | - | ❌ | - |
| actions | array of #actionView | - | ✅ | A page of action history, most recent first. Reversal timestamps include changes outside this page. |
| cursor | string | - | ❌ | Cursor for the next page of action history. Omitted when no older actions remain. |
| reports | #reportsSummary | - | ❌ | - |
| createdAt | string (datetime) | - | ✅ | - |
| updatedAt | string (datetime) | - | ✅ | - |
#reportsSummary
Aggregate view of reports filed against this subject. Deliberately carries no report IDs, no count, and no reporter identities.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| reasonTypes | array of string | - | ✅ | Distinct reason types reported, deduplicated and unordered. Excludes reasonAppeal. |
| firstReportedOn | string (datetime) | - | ✅ | Day of the earliest report, truncated to midnight UTC. Render as a date; the time component is not meaningful. |
| lastReportedOn | string (datetime) | - | ✅ | Day of the most recent report, truncated to midnight UTC. Render as a date; the time component is not meaningful. |
#notification
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| id | integer | - | ✅ | - |
| reason | string | reportResolved reportReopened actionTaken actionReversed appealResolved standingChanged | ✅ | - |
| target | union of #reportRef #subjectRef #standingRef | - | ✅ | - |
| isRead | boolean | - | ✅ | - |
| createdAt | string (datetime) | - | ✅ | - |
#notificationPreferences
Push notification preferences by moderation notification category. These preferences do not hide in-app inbox activity. Each category defaults to enabled.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| reports | boolean | - | ✅ | Notify about outcomes of reports filed by the account (reportResolved and reportReopened). |
| account | boolean | - | ✅ | Notify about moderation actions against the account or its content, action reversals, appeal outcomes, and standing changes. Label application and removal are controlled by labels. |
| labels | boolean | - | ✅ | Notify when labels are applied to or removed from the account or its content (labelApplied and labelRemoved actions). |
#reportRef
Reference to a report by its report table ID, as used by getReport and Ozone's report detail page.
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| reportId | integer | - | ✅ | - |
| subject | union of com.atproto.admin.defs#repoRef com.atproto.repo.strongRef | - | ❌ | - |
| status | string | pending resolved | ❌ | - |
#subjectRef
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| appealOutcome | string | approved denied | ❌ | Decision captured when an appealResolved notification was created. Omitted when the outcome is unknown. |
| subject | union of com.atproto.admin.defs#repoRef com.atproto.repo.strongRef | - | ✅ | - |
| actionType | string | - | ❌ | - |
| actionId | integer | - | ❌ | - |
#standingRef
| Property | Type | Known Values | Required | Description |
|---|---|---|---|---|
| standing | string | good warning atRisk | ✅ | - |
| previousStanding | string | good warning atRisk | ❌ | - |