DOCUMENTATIONv2

POST

Notifications

Mark account signals

/api/v2/notifications/mark

AUTHENTICATIONBearer token · profile:writeAUTHORITATIVE OWNERnotificationsCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Atomically set one to 100 owner-scoped notification records to UNREAD, READ, or ARCHIVED using an idempotent acknowledgement command.

WHEN THIS CALL IS USEFUL

Use after an authenticated person or agent has intentionally acknowledged, reopened, or archived one to 100 signals from the current owner-scoped inbox.

OUTCOME · Create or advance

What changes

Changes only inbox presentation state for the authenticated profile and workspace. It cannot execute, approve, cancel, settle, publish, or authorize the event referenced by a signal.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance mark account signals.
Provides a bounded attention queue with stable references and unread state while preserving the owning domain as the authority for any consequential action.

ISOLATION + AUTHORITY

Profile, workspace, notification, delivery channel, read or archive status, referenced resource, and owning-domain lifecycle remain distinct. Reading, marking, or archiving a signal changes only inbox presentation state and never authorizes, executes, reverses, or resolves the referenced business action.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Supply the required notificationUuids (body), status (body) exactly as defined by the live contract.
Use one Idempotency-Key only for retries of the same byte-equivalent logical mutation.
Resolve the authenticated profile and workspace plus the canonical resource reference and owning domain for any signal that may require action.

WHAT TO DO NEXT

Refresh the affected notification records and unread aggregate to confirm their presentation state.
Handle the referenced resource separately; marking a signal read, unread, or archived does not change its business lifecycle.

AGENT GUIDANCE

Use mark account signals only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required notificationUuids (body), status (body) exactly as defined by the live contract.
Distinguish signal delivery, unread state, acknowledgement, archival, referenced-resource state, and resolution in the authoritative domain workflow.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the profile:write scope.EXAMPLEBearer hc_live_…

Idempotency-KeyheaderRequired

ASCII string · 1–128Caller-generated key reused for every retry of the same logical mutation.EXAMPLEnotifications-acknowledge-security-review-20260901

Content-TypeheaderRequired

application/jsonSigned mutations accept canonical JSON only.EXAMPLEapplication/json

Content-DigestheaderRequired

RFC 9530 SHA-256 digestDigest of the exact transmitted body bytes.EXAMPLEsha-256=:47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=:

Signature-InputheaderRequired

RFC 9421 signature parametersCovers @method, @path, content-digest, content-type, and idempotency-key; includes keyid, nonce, created, and expires.EXAMPLEsig1=("@method" "@path" "content-digest" "content-type" "idempotency-key");created=1786582800;expires=1786583100;nonce="01J…";keyid="machine-prod"

SignatureheaderRequired

Ed25519 HTTP Message SignatureSignature made by an active public key registered to the authenticated client.EXAMPLEsig1=:base64-signature:

notificationUuidsbodyRequired

safe identifier[] · 1–100 unique valuesEvery identifier must exist in the authenticated profile and workspace inbox. Missing, foreign, malformed, or duplicate identifiers reject the complete batch.

statusbodyRequired

UNREAD | READ | ARCHIVEDReplacement presentation state. It never changes the referenced domain resource.EXAMPLEREAD

REQUEST

JSON body example

{
  "notificationUuids": [
    "notice-security-review-20260901",
    "notice-workspace-invitation-20260901"
  ],
  "status": "READ"
}

RESPONSES

Status and payload examples

200Owner-scoped notification states retained idempotently.Mutation completed · JSON RESPONSE+

{
  "notificationUuids": [
    "notice-security-review-20260901",
    "notice-workspace-invitation-20260901"
  ],
  "status": "READ",
  "updated": 2
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then refresh the affected notification records and unread aggregate to confirm their presentation state.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.

400The identifier set, replacement status, or Idempotency-Key is invalid.Request must change · JSON RESPONSE+

{
  "code": "invalid_notification_command",
  "message": "The identifier set, replacement status, or Idempotency-Key is invalid."
}

INTEGRATION DECISIONinvalid_notification_command

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

401The bearer credential is missing or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

403The credential lacks profile:write or the owner boundary is unavailable.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks profile:write or the owner boundary is unavailable."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for the authenticated profile, tenant brand, referral, funding, and account-lifecycle projections.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

404One or more identifiers do not belong to this owner inbox; no record was changed.Resource not visible · JSON RESPONSE+

{
  "code": "notification_not_found",
  "message": "One or more identifiers do not belong to this owner inbox; no record was changed."
}

INTEGRATION DECISIONnotification_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

409The Idempotency-Key was reused with a non-equivalent command.State reconciliation required · JSON RESPONSE+

{
  "code": "idempotency_conflict",
  "message": "The Idempotency-Key was reused with a non-equivalent command."
}

INTEGRATION DECISIONidempotency_conflict

CALLER ACTION: Stop the mutation sequence and fetch the latest authoritative resource, lifecycle state, version, ETag, reservation, or existing idempotency result.
RETRY SAFETY: Retry only after reconciling the conflict. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

503The acknowledgement could not be durably retained.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "notifications_unavailable",
  "message": "The acknowledgement could not be durably retained."
}

INTEGRATION DECISIONnotifications_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. For one logical mutation, retain the same Idempotency-Key and byte-equivalent request. Never reuse that key for changed instructions. Use bounded backoff with jitter.
STATE RECONCILIATION: Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

The operation changes inbox presentation only. It cannot execute, approve, cancel, settle, publish, transfer, trade, alter traffic, or authorize the event referenced by a signal.
All identifiers must resolve inside one authenticated owner boundary before the update. Reuse one Idempotency-Key only with the equivalent identifier set and status.
The exact request body and Idempotency-Key are covered by the documented RFC 9421 Ed25519 signature profile. On an ambiguous result, re-read the inbox rather than guessing whether acknowledgement was retained. Responses are no-store.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

POST/api/v1/notifications/markNOTIFICATIONS: Mark Notification Status

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗