Skip to main content
POST
/
v1
/
notifications
/
{notification_id}
/
read
Mark As Read
curl --request POST \
  --url https://api.mixpeek.com/v1/notifications/{notification_id}/read
{
  "type": "pipeline_success",
  "priority": "low",
  "title": "<string>",
  "content": "<string>",
  "organization_id": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "user_id": "<string>",
  "metadata": {},
  "delivery_status": {},
  "read": false,
  "read_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Path Parameters

​
notification_id
string
required

Response

Successful Response

Model for a notification instance.

​
type
enum<string>
required

Notification type

Available options:
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
​
priority
enum<string>
required

Priority level

Available options:
low,
medium,
high,
critical
​
title
string
required

Notification title

​
content
string
required

Notification content

​
organization_id
string
required

Organization ID

​
id
string

Unique ID

​
created_at
string<date-time>

Creation timestamp

​
user_id
string | null

User ID (if applicable)

​
metadata
Metadata · object

Additional metadata

​
delivery_status
Delivery Status · object

Delivery status by channel

​
read
boolean
default:false

Whether the notification has been read

​
read_at
string<date-time> | null

When the notification was read