/notifications

POST /notifications

Mark all notifications as read

Mark all unread notifications for an account as read, with optional filtering

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

Request Body

{}

{
  "filters": {
    "event": "lead_created"
  }
}

{
  "filters": {
    "event": "application_submitted",
    "error": false
  }
}

{
  "filters": {}
}

Try it out

Output:

Responses

Description

Notifications marked as read successfully

{
  "updated": 0,
  "message": "string"
}

Description

Unauthorized

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Forbidden - missing required permissions

{
  "error": "string",
  "status": 0,
  "message": "string"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/Error

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
  message:
    type: string
    description: Detailed error message
description: Error response object
required:
  - error

|
export interface Error {
  /** Error message */
  error: string;
  /** HTTP status code */
  status?: number;
  /** Detailed error message */
  message?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /notifications/route.ts

Or the swagger.yaml spec this documentation was generated from: /notifications/swagger.yaml