account
Address book invalidations
Authenticated invalidation signals for address-book scopes visible to the subscribing root account, including shared subaccounts allowed by its role. Refetch only the invalidated scope after receiving an update.
Channel
private:auth:address-books:{rootAccountPublicId}:proto Subscribe frame
{
"type": "subscribe",
"channel": "private:auth:address-books:3gDmDv6tjHJ:proto"
}Channel parameters
rootAccountPublicId string
Public identifier of the subscribing root account.
e.g. 3gDmDv6tjHJMessage
Payload
auth.v1.AddressBookViewInvalidated 3 fields
scopeType enum
Address-book scope type.
SCOPE_ROOT SCOPE_SUBACCOUNT
Example
SCOPE_ROOT rootAccountId string (fixed64)
Root account that owns this address book.
Example
1152921504606846977 subaccountId string (fixed64)
Subaccount for subaccount-scoped books. Empty for root account books.
invalidatedAt string (date-time)
Time the view was invalidated.
Example
2026-01-01T00:00:00Z viewRevision string (uint64)
Revision that GetAddressBookView must reach before the invalidation is considered satisfied.