Skip to content
localisyncDocs
Open panel

Mark your notification as read

Requires current workspace membership. Manager-only operations include permission and project-link management. Text approval requires a separate language review grant; resource editor access never grants translation permissions. Expected versions and branch scope are checked before mutation. Source and context text are not telemetry.

PATCH /api/v1/notifications/{notificationId}/read

Operation: readNotification · Download OpenAPI

This operation does not use the panel session as its authentication mechanism. Follow the operation-specific checks described above.

session

{
"type": "apiKey",
"in": "cookie",
"name": "localisync_session"
}
Name Location Required Description
notificationId path Yes See constraints below.
Origin header Yes See constraints below.
X-CSRF-Token header Yes See constraints below.
{
"type": "string",
"format": "uuid"
}
{
"type": "string",
"format": "uri"
}
{
"type": "string"
}

Required: Yes.

Schema reference: NotificationReadInput.

Field Type Required Constraints / description
{
"$ref": "#/components/schemas/NotificationReadInput"
}

Result returned.

Content type: application/json Schema reference: NotificationRead.

Field Type Required Constraints / description
read boolean Yes —
{
"$ref": "#/components/schemas/NotificationRead"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Safe error. Mutations are atomic.

Content type: application/json Schema reference: Error.

Field Type Required Constraints / description
error string Yes —
message string Yes —
requestId string Yes —
details See schema No —
{
"$ref": "#/components/schemas/Error"
}

Request errors and safe retries · Troubleshooting

Cookie preferences

Your choice applies to localisync.com and docs.localisync.com. You can change it at any time using Cookie settings.