Notifications

Mark As Read

Changed on

Mark a notification as read.

post/v1/notifications/{notification_id}/read

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/notifications/{notification_id}/read
  • Auth: HTTP bearer

Path parameters

notification_idstring required

Response

Successful Response

idstring

Unique ID

type'pipeline_success' | 'pipeline_failure' | 'feature_extraction_success' | 'feature_extraction_failure' | 'system_alert' | 'billing_alert' | 'quota_alert' | 'audit_alert' | 'maintenance_alert' | 'custom' | 'onboarding_nudge' | 'engagement_nudge' | 'feature_tip' required

Enum for notification types.

priority'low' | 'medium' | 'high' | 'critical' required

Enum for notification priority levels.

titlestring required

Notification title

contentstring required

Notification content

created_atstring date-time

Creation timestamp

organization_idstring required

Organization ID

user_idstring nullable

User ID (if applicable)

metadataobject

Additional metadata

delivery_statusobject

Delivery status by channel

readboolean

Whether the notification has been read

read_atstring date-time nullable

When the notification was read

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API