Asana: Mark notifications as read
Asana notifications.markNotificationsReadForUser: arguments, response, policy and SDK examples.
← Notifications operations · Get started
Operation asana.marknotificationsreadforuser
Provider route: POST /users/{user_gid}/notifications/markRead. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["notifications"]["markNotificationsReadForUser"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.notifications.markNotificationsReadForUser(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_asana import AsanaIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.notifications.mark_notifications_read_for_user(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.user_gid | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.opt_pretty | boolean | Optional | |
query.opt_fields | array | Optional | |
query.opt_fields[] | string | Each item | One of: failed_gids |
body | object | Required within parent | |
body.data | Model | Required within parent | Expand Mark notifications as read — request body — body data |
Referenced models: Mark notifications as read — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | object | All variants apply | |
$ (allOf 1).data | Model | Optional | Expand Mark notifications as read — response body — data data |
$ (allOf 2) | Model | All variants apply | Expand Mark notifications as read — response body — data |
Referenced models: Mark notifications as read — response body — data data, Mark notifications as read — response body — data
Schemas
Section titled “Schemas”Mark notifications as read — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
workspace | string | Required within parent | GID of the workspace used to route the request. |
notification_gids | array | Required within parent | The notifications to update. Between 1 and 50 GIDs may be supplied, and duplicate GIDs are ignored. Minimum items: 1 Maximum items: 50 |
notification_gids[] | string | Each item | The `gid` of a notification. |
Mark notifications as read — response body — data data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
failed_gids | array | Optional | The GIDs from notification_gids that could not be updated, for example because the notification does not exist, does not belong to the caller, or has been deleted. GIDs not listed here were updated successfully. Empty when every GID succeeded. |
failed_gids[] | string | Each item | The `gid` of a notification that failed to update. |
Mark notifications as read — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Mark notifications as read — response body — data data |
Referenced models: Mark notifications as read — response body — data data
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: asana.marknotificationsreadforuser. Catalog operation: asana:markNotificationsReadForUser. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["notifications:write"]