NotificationAPI

https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua
Admin
NotificationAPI is a comprehensive REST API for sending notifications across multiple channels...
Tokens:10,323
Snippets:42
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET /{clientId}/users/{userId}/validateUser

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Client ID and User ID Example. This endpoint validates user authentication using client and user IDs.

```APIDOC
## GET /{clientId}/users/{userId}/validateUser

### Description
Client ID and User ID Example

### Method
GET

### Endpoint
`/{clientId}/users/{userId}/validateUser`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
  - Example: `CLIENT_ID`
- **userId** (string) - Required - User identifier
  - Example: `USER_ID`

### Request Example
(No request body)

### Response
#### Success Response (200)
(No specific response schema provided in the documentation)

#### Response Example
(No specific response example provided in the documentation)
```

--------------------------------

### GET /{clientId}/auth/validateAuthenticate

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Client ID & Client Secret Example. This endpoint validates client authentication using a client ID.

```APIDOC
## GET /{clientId}/auth/validateAuthenticate

### Description
Client ID & Client Secret Example

### Method
GET

### Endpoint
`/{clientId}/auth/validateAuthenticate`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
  - Example: `CLIENT_ID`

### Request Example
(No request body)

### Response
#### Success Response (200)
(No specific response schema provided in the documentation)

#### Response Example
(No specific response example provided in the documentation)
```

--------------------------------

### Get In-App Notifications

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Retrieves in-app notifications for a specified user.

```APIDOC
## GET /{clientId}/users/{userId}/notifications/INAPP_WEB

### Description
Get in-app notifications for a user

### Method
GET

### Endpoint
`/{clientId}/users/{userId}/notifications/INAPP_WEB`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
- **userId** (string) - Required - User identifier

#### Header Parameters
- **Accept** (string) - Optional - `application/json`

#### Request Body
- **count** (integer) - Optional - Number of notifications to retrieve
- **before** (string) - Optional - Timestamp to retrieve notifications before

### Request Example
```json
{
  "count": 20,
  "before": "2024-04-04T19:53:23Z"
}
```

### Response
#### Success Response (200)
- **notifications** (array) - List of in-app notifications
  - **id** (string) - Notification ID
  - **seen** (boolean) - Whether the notification has been seen
  - **title** (string) - Notification title
  - **redirectURL** (string) - URL to redirect to
  - **imageURL** (string) - URL for the notification image
  - **date** (string) - Timestamp of the notification

#### Response Example
```json
{
  "notifications": [
    {
      "id": "3924f8a9-2b39-4837-be5f-4e0ed0e52ba1",
      "seen": false,
      "title": "You have a new disputed valued at $100.",
      "redirectURL": "https://www.notificationapi.com/abc-xyz",
      "imageURL": "https://assets-global.website-files.com/5f5a9b2a0c682fc717d94b8c/5f66593fc2c2e1390606f2cb_chargeflow-io-stripe-logo.svg",
      "date": "2024-04-03T21:41:20.220Z"
    },
    {
      "id": "875fd131-62d0-486b-b48d-5b1beb1ed483",
      "seen": true,
      "title": "You have a new disputed valued at $100.",
      "redirectURL": "https://www.notificationapi.com/abc-xyz",
      "imageURL": "https://assets-global.website-files.com/5f5a9b2a0c682fc717d94b8c/5f66593fc2c2e1390606f2cb_chargeflow-io-stripe-logo.svg",
      "date": "2024-04-03T20:57:37.407Z"
    }
  ]
}
```
```

--------------------------------

### Get In-App Notifications

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Fetches in-app notifications for a specified user. It requires the client ID and user ID. An optional 'before' parameter can be used to retrieve notifications before a specific timestamp.

```HTTP
GET /{clientId}/users/{userId}/notifications/INAPP_WEB

{
  "count": 20,
  "before": "2024-04-04T19:53:23Z"
}
```

--------------------------------

### Get Unread Count

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Retrieves the count of unread in-app notifications for a user.

```APIDOC
## GET /{clientId}/users/{userId}/unread/INAPP_WEB

### Description
Get count of unread in-app notifications

### Method
GET

### Endpoint
`/{clientId}/users/{userId}/unread/INAPP_WEB`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
- **userId** (string) - Required - User identifier

#### Header Parameters
- **Accept** (string) - Optional - `application/json`

### Response
#### Success Response (200)
- **count** (integer) - The number of unread notifications

#### Response Example
```json
{
  "count": 1
}
```
```

--------------------------------

### Get Unread Notification Count

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Retrieves the count of unread in-app notifications for a specific user. This endpoint requires the client ID and user ID.

```HTTP
GET /{clientId}/users/{userId}/unread/INAPP_WEB
```

--------------------------------

### Create Default Template (POST)

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Creates a default template for a given notification. This endpoint requires the environment ID and notification ID as path parameters. The response indicates success.

```bash
POST /{envId}/notifications/{notificationId}/defaulttemplate
```

--------------------------------

### Default Template Options by Channel (OPTIONS)

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Provides CORS options for the default template of a specific channel. This endpoint requires environment ID, notification ID, and channel as path parameters.

```bash
OPTIONS /{envId}/notifications/{notificationId}/defaulttemplate/{channel}
```

--------------------------------

### Template Options by Channel and ID (OPTIONS)

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Provides CORS options for a specific template identified by channel and template ID. This endpoint requires environment ID, notification ID, channel, and template ID as path parameters.

```bash
OPTIONS /{envId}/notifications/{notificationId}/templates/{channel}/{templateId}
```

--------------------------------

### Template Management API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Manage notification templates, including updating, creating, and handling CORS options for default and specific templates.

```APIDOC
## PATCH /{envId}/notifications/{notificationId}/defaulttemplate/{channel}

### Description
Update the default template for a specific notification channel.

### Method
PATCH

### Endpoint
`/{envId}/notifications/{notificationId}/defaulttemplate/{channel}`

### Parameters
#### Path Parameters
- **envId** (string) - Required - Environment identifier.
- **notificationId** (string) - Required - Notification identifier.
- **channel** (string) - Required - Channel identifier.

#### Header Parameters
- **Content-Type** (string) - Optional - `application/json`
- **Accept** (string) - Optional - `application/json`

#### Request Body
- **templateId** (string) - Required - The ID of the template to set as default.

### Response
#### Success Response (200)
- **title** (string) - Indicates the successful update of the template, typically "Template".

#### Error Response (404)
- Description: Template not found.
```

```APIDOC
## OPTIONS /{envId}/notifications/{notificationId}/defaulttemplate/{channel}

### Description
Provides CORS headers for the default template endpoint by channel.

### Method
OPTIONS

### Endpoint
`/{envId}/notifications/{notificationId}/defaulttemplate/{channel}`

### Parameters
#### Path Parameters
- **envId** (string) - Required - Environment identifier.
- **notificationId** (string) - Required - Notification identifier.
- **channel** (string) - Required - Channel identifier.

### Response
#### Success Response (200)
- Contains CORS headers.
```

```APIDOC
## POST /{envId}/notifications/{notificationId}/defaulttemplate

### Description
Create a default template for a given notification.

### Method
POST

### Endpoint
`/{envId}/notifications/{notificationId}/defaulttemplate`

### Parameters
#### Path Parameters
- **envId** (string) - Required - Environment identifier.
- **notificationId** (string) - Required - Notification identifier.

### Response
#### Success Response (200)
- Indicates successful creation of the default template.
```

```APIDOC
## OPTIONS /{envId}/notifications/{notificationId}/defaulttemplate

### Description
Provides CORS headers for the default template endpoint.

### Method
OPTIONS

### Endpoint
`/{envId}/notifications/{notificationId}/defaulttemplate`

### Parameters
#### Path Parameters
- **envId** (string) - Required - Environment identifier.
- **notificationId** (string) - Required - Notification identifier.

### Response
#### Success Response (200)
- Contains CORS headers.
```

```APIDOC
## OPTIONS /{envId}/notifications/{notificationId}/templates/{channel}/{templateId}

### Description
Provides CORS headers for a specific template endpoint, identified by channel and template ID.

### Method
OPTIONS

### Endpoint
`/{envId}/notifications/{notificationId}/templates/{channel}/{templateId}`

### Parameters
#### Path Parameters
- **envId** (string) - Required - Environment identifier.
- **notificationId** (string) - Required - Notification identifier.
- **channel** (string) - Required - Channel identifier.
- **templateId** (string) - Required - Template identifier.

### Response
#### Success Response (200)
- Contains CORS headers.
```

--------------------------------

### Default Template Options (OPTIONS)

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Provides CORS options for the default template of a notification. This endpoint requires environment ID and notification ID as path parameters.

```bash
OPTIONS /{envId}/notifications/{notificationId}/defaulttemplate
```

--------------------------------

### Update User Preferences

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Allows a user to manage their own notification preferences.

```APIDOC
## POST /{clientId}/users/{userId}/preferences

### Description
User endpoint to manage their own notification preferences

### Method
POST

### Endpoint
`/{clientId}/users/{userId}/preferences`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
- **userId** (string) - Required - User identifier

#### Header Parameters
- **Content-Type** (string) - Optional - `application/json`
- **Accept** (string) - Optional - `application/json`

#### Request Body
- **channel** (string) - Required - The notification channel
- **notificationId** (string) - Required - The ID of the notification
- **delivery** (string) - Required - The delivery method for the notification
- **subNotificationId** (string) - Optional - The sub-notification identifier

### Request Example
```json
[
  {
    "channel": "<string>",
    "notificationId": "<string>",
    "delivery": "<string>",
    "subNotificationId": "<string>"
  }
]
```

### Response
#### Success Response (200 - Subscribe to Notification)
- **UserPreferences** (array)
  - **envId** (string) - Environment ID
  - **userId** (string) - User ID
  - **notificationId** (string) - Notification ID
  - **channelsStates** (array) - States of the channels

#### Response Example
```json
{
  "UserPreferences": [
    {
      "envId": "24nojpnrsdc53fkslha0roov05",
      "userId": "USER_ID",
      "notificationId": "invitation",
      "channelsStates": []
    }
  ]
}
```
```

--------------------------------

### Query Notification Logs

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Search and retrieve notification delivery logs and analytics based on specified filters.

```APIDOC
## POST /{clientId}/logs/query

### Description
Search and retrieve notification delivery logs and analytics.

### Method
POST

### Endpoint
`/{clientId}/logs/query`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
  - Example: `CLIENT_ID`

#### Header Parameters
- **Content-Type** (string) - Optional - `application/json`
- **Accept** (string) - Optional - `application/json`

#### Request Body
- **dateRangeFilter** (object) - Optional - Filter logs by date range.
  - **startTime** (number) - Required - Start time in epoch milliseconds.
  - **endTime** (number) - Required - End time in epoch milliseconds.
- **notificationFilter** (array of strings) - Optional - Filter logs by notification IDs.
- **channelFilter** (array of strings) - Optional - Filter logs by channels.
- **userFilter** (array of strings) - Optional - Filter logs by user identifiers.
- **statusFilter** (array of strings) - Optional - Filter logs by delivery status.
- **trackingIds** (array of strings) - Optional - Filter logs by tracking IDs.
- **requestFilter** (array of strings) - Optional - Filter logs by request identifiers.
- **envIdFilter** (array of strings) - Optional - Filter logs by environment IDs.
- **customFilter** (string) - Optional - Apply custom filtering logic.

### Request Example
```json
{
  "dateRangeFilter": {
    "startTime": 1678886400000,
    "endTime": 1678972800000
  },
  "notificationFilter": ["notification_id_1"],
  "channelFilter": ["EMAIL"],
  "userFilter": ["user_id_1"],
  "statusFilter": ["SUCCESS"],
  "trackingIds": ["tracking_id_1"],
  "requestFilter": ["request_id_1"],
  "envIdFilter": ["env_id_1"],
  "customFilter": "custom_filter_string"
}
```

### Response
#### Success Response (200)
- **logs** (array) - Array of log objects.
  - **trackingId** (string) - Unique identifier for the log entry.
  - **envId** (string) - Environment identifier.
  - **status** (string) - Delivery status (e.g., SUCCESS, FAILED).
  - **request** (object) - Details about the notification request.
    - **notificationId** (string) - Identifier of the notification.
    - **mergeTags** (object) - Merge tags used in the notification.
      - **itemId** (string) - Example item ID.
      - **itemName** (string) - Example item name.
    - **user** (object) - User details.
      - **id** (string) - User ID.
      - **email** (string) - User email address.
  - **channels** (array of strings) - Channels through which the notification was sent.
  - **channelsObj** (object) - Object indicating which channels were used.
    - **EMAIL** (boolean) - True if email channel was used.
    - **INAPP_WEB** (boolean) - True if in-app web channel was used.

#### Response Example
```json
{
  "logs": [
    {
      "trackingId": "f3e3e5f3-a568-4911-ae21-667550d0ecb6",
      "envId": "24nojpnrsdc53fkslha0roov05",
      "status": "SUCCESS",
      "request": {
        "notificationId": "item_approved",
        "mergeTags": {
          "itemId": "testItemId",
          "itemName": "testItemName"
        },
        "user": {
          "id": "xyz-abc-123",
          "email": "xyz@abc.com"
        }
      },
      "channels": ["EMAIL", "INAPP_WEB"],
      "channelsObj": {
        "EMAIL": true,
        "INAPP_WEB": true
      }
    }
  ]
}
```
```

--------------------------------

### Query Logs (POST)

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Searches and retrieves notification delivery logs and analytics. This endpoint requires a clientId and accepts a JSON request body for filtering logs by date range, notification, channel, user, status, tracking IDs, request details, environment ID, or custom filters.

```bash
POST /{clientId}/logs/query

Content-Type: application/json
Accept: application/json

{
  "dateRangeFilter": {
    "startTime": "<number>",
    "endTime": "<number>"
  },
  "notificationFilter": ["<string>"],
  "channelFilter": ["<Channels>"],
  "userFilter": ["<string>"],
  "statusFilter": ["<string>"],
  "trackingIds": ["<string>"],
  "requestFilter": ["<string>"],
  "envIdFilter": ["<string>"],
  "customFilter": "<string>"
}
```

--------------------------------

### POST /sender

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Send a notification to a user across multiple channels. This endpoint allows for detailed configuration of the notification content, user targeting, and delivery channels.

```APIDOC
## POST /sender

### Description
Send a notification to a user across multiple channels.

### Method
POST

### Endpoint
`/{clientId}/sender`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
  - Example: `CLIENT_ID`

#### Header Parameters
- **Content-Type** (string) - Optional - `application/json`
- **Accept** (string) - Optional - `application/json`

#### Request Body
- **notificationId** (string) - Required - ID of the notification from the dashboard.
- **user** (object) - Required - User details for notification delivery.
  - **id** (string) - Required - User's unique identifier.
  - **number** (string) - Required - User's phone number.
  - **email** (string) - Required - User's email address.
- **mergeTags** (object) - Optional - Key-value pairs for personalizing notification content.
  - **firstName** (string) - Example: `Sahand`
- **templateId** (string) - Required - ID of the template to use for the notification.
- **subNotificationId** (string) - Optional - A secondary identifier for the notification.
- **forceChannels** (array) - Optional - An array of channels to force delivery through (e.g., `["WEB_PUSH", "SMS"]`).
- **schedule** (string) - Optional - Schedule time for the notification.
- **secondaryId** (string) - Optional - Another secondary identifier.
- **replace** (object) - Optional - Object for replacing content.
- **options** (object) - Optional - Options for specific channels.
  - **email** (object) - Optional - Email specific options.
    - **attachments** (array) - Optional - Array of attachment objects.
      - **filename** (string) - Required - Name of the attachment.
      - **url** (string) - Required - URL of the attachment.
    - **ccAddresses** (array) - Optional - Array of CC email addresses.
    - **fromName** (string) - Optional - Sender's name for email.
    - **fromAddress** (string) - Optional - Sender's email address.
    - **bccAddresses** (array) - Optional - Array of BCC email addresses.
    - **replyToAddresses** (array) - Optional - Array of reply-to email addresses.
  - **apn** (object) - Optional - Apple Push Notification specific options.
    - **collapseId** (string) - Optional - Collapse ID for APN.
    - **threadId** (string) - Optional - Thread ID for APN.
    - **badge** (number) - Optional - Badge count for APN.
    - **sound** (string) - Optional - Sound for APN notification.
    - **expiry** (number) - Optional - Expiry time for APN notification.
    - **priority** (number) - Optional - Priority for APN notification.
    - **contentAvailable** (boolean) - Optional - Content available flag for APN.
  - **fcm** (object) - Optional - Firebase Cloud Messaging specific options.
    - **android** (object) - Optional - Android specific FCM options.
      - **restrictedPackageName** (string) - Optional - Restricted package name for Android FCM.
      - **collapseKey** (string) - Optional - Collapse key for Android FCM.
      - **priority** (string) - Optional - Priority for Android FCM (e.g., `high`).
      - **ttl** (number) - Optional - Time-to-live for Android FCM messages.

### Request Example
```json
{
  "notificationId": "NOTIFICATION_ID_FROM_DASHBOARD",
  "user": {
    "id": "END_USER_ID",
    "number": "+15005550006",
    "email": "END_USER_EMAIL"
  },
  "mergeTags": {
    "firstName": "Sahand"
  },
  "templateId": "<string>",
  "subNotificationId": "<string>",
  "forceChannels": [
    "WEB_PUSH",
    "SMS"
  ],
  "schedule": "<string>",
  "secondaryId": "<string>",
  "replace": {},
  "options": {
    "email": {
      "attachments": [
        {
          "filename": "<string>",
          "url": "<string>"
        }
      ],
      "ccAddresses": ["<string>"],
      "fromName": "<string>",
      "fromAddress": "<string>",
      "bccAddresses": ["<string>"],
      "replyToAddresses": ["<string>"]
    },
    "apn": {
      "collapseId": "<string>",
      "threadId": "<string>",
      "badge": "<number>",
      "sound": "<string>",
      "expiry": "<number>",
      "priority": "<number>",
      "contentAvailable": "<boolean>"
    },
    "fcm": {
      "android": {
        "restrictedPackageName": "<string>",
        "collapseKey": "<string>",
        "priority": "high",
        "ttl": "<number>"
      }
    }
  }
}
```

### Response
#### Error Response (500)
- **trackingId** (string) - The tracking ID for the operation.
- **messages** (array) - An array of messages related to the response.

#### Response Example
```json
{
  "trackingId": "7c2fdacb-9636-478d-baa5-9e135945de91",
  "messages": []
}
```
```

--------------------------------

### Send Notification API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Sends a notification to a user across multiple channels. It requires a clientId and accepts a JSON request body containing notification details, user information, merge tags, and options for different channels like email, APN, and FCM.  Dependencies include the client ID for routing.

```HTTP
POST /{clientId}/sender

{
  "notificationId": "NOTIFICATION_ID_FROM_DASHBOARD",
  "user": {
    "id": "END_USER_ID",
    "number": "+15005550006",
    "email": "END_USER_EMAIL"
  },
  "mergeTags": {
    "firstName": "Sahand"
  },
  "templateId": "<string>",
  "subNotificationId": "<string>",
  "forceChannels": [
    "WEB_PUSH",
    "SMS"
  ],
  "schedule": "<string>",
  "secondaryId": "<string>",
  "replace": {},
  "options": {
    "email": {
      "attachments": [
        {
          "filename": "<string>",
          "url": "<string>"
        }
      ],
      "ccAddresses": ["<string>"],
      "fromName": "<string>",
      "fromAddress": "<string>",
      "bccAddresses": ["<string>"],
      "replyToAddresses": ["<string>"]
    },
    "apn": {
      "collapseId": "<string>",
      "threadId": "<string>",
      "badge": "<number>",
      "sound": "<string>",
      "expiry": "<number>",
      "priority": "<number>",
      "contentAvailable": "<boolean>"
    },
    "fcm": {
      "android": {
        "restrictedPackageName": "<string>",
        "collapseKey": "<string>",
        "priority": "high",
        "ttl": "<number>"
      }
    }
  }
}
```

--------------------------------

### POST /{clientId}/user_preferences/{userId}

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Update User Preferences (Admin endpoint). Allows administrators to update user notification preferences.

```APIDOC
## POST /{clientId}/user_preferences/{userId}

### Description
Update User Preferences (Admin endpoint)

### Method
POST

### Endpoint
`/{clientId}/user_preferences/{userId}`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
  - Example: `CLIENT_ID`
- **userId** (string) - Required - User identifier
  - Example: `USER_ID`

#### Headers
- **Content-Type** (string) - Optional - `application/json`
- **Accept** (string) - Optional - `application/json`

#### Request Body
An array of objects, where each object represents a notification preference. It can include `notificationId`, `subNotificationId` (optional), `channel`, and `delivery` methods.

**Example Structure**: 
```json
[
  {
    "notificationId": "<string>"
  },
  {
    "notificationId": "<string>",
    "channel": "<string>",
    "delivery": "<string>"
  },
  {
    "notificationId": "<string>",
    "subNotificationId": "<string>",
    "channel": "<string>",
    "delivery": "<string>"
  }
]
```

### Request Example
```json
[
  {
    "notificationId": "invitation"
  }
]
```

### Response
#### Success Response (200 - Subscribe to Notification)
- **UserPreferences** (array) - An array containing the updated user preferences.
  - **envId** (string) - The environment ID.
  - **userId** (string) - The user ID.
  - **notificationId** (string) - The notification ID.
  - **channelsStates** (array) - An array representing the state of channels for this notification.

#### Response Example
```json
{
  "UserPreferences": [
    {
      "envId": "24nojpnrsdc53fkslha0roov05",
      "userId": "USER_ID",
      "notificationId": "invitation",
      "channelsStates": []
    }
  ]
}
```
```

--------------------------------

### Update User Notification Preferences

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Enables a user to manage their own notification preferences, including channel, delivery, and subscription status for specific notifications. This endpoint requires the client ID and user ID.

```HTTP
POST /{clientId}/users/{userId}/preferences

[
  {
    "channel": "<string>",
    "notificationId": "<string>",
    "delivery": "<string>",
    "subNotificationId": "<string>"
  }
]
```

--------------------------------

### Sub-Notification Options - Sub Notifications API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Provides CORS options for the sub-notification endpoint. It requires environment, notification, and sub-notification identifiers.

```http
OPTIONS /{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}
```

--------------------------------

### Delete User Data

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Removes all user data and preferences.

```APIDOC
## DELETE /{clientId}/users/{userId}

### Description
Remove all user data and preferences

### Method
DELETE

### Endpoint
`/{clientId}/users/{userId}`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
- **userId** (string) - Required - User identifier

### Response
#### Success Response (200)
Success
```

--------------------------------

### Create Sub-Notification - Sub Notifications API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Creates or updates a sub-notification. It requires client, notification, and sub-notification identifiers. The request body accepts a JSON object with a 'title' field.

```http
PUT /{clientId}/notifications/{notificationId}/subNotifications/{subNotificationId}
```

```json
{
  "title": "<string>"
}
```

```json
{
  "accountId": "24nojpnrsdc53fkslha0roov05",
  "notificationId": "project_approval",
  "subNotificationId": "proj_abc",
  "title": "Project ABC"
}
```

--------------------------------

### Validate User - Authentication API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Validates a user using the client ID and user ID. This endpoint is part of the Authentication API and requires both client and user identifiers.

```http
GET /{clientId}/users/{userId}/validateUser
```

--------------------------------

### Mark Notification as Read

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Marks specific notifications as read for a user.

```APIDOC
## PATCH /{clientId}/users/{userId}/unread/INAPP_WEB

### Description
Mark specific notifications as read

### Method
PATCH

### Endpoint
`/{clientId}/users/{userId}/unread/INAPP_WEB`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
- **userId** (string) - Required - User identifier

#### Request Body
- **notificationId** (string) - Required - The ID of the notification to mark as read

### Request Example
```json
{
  "notificationId": "TRACKING_ID"
}
```

### Response
#### Success Response (200)
Success
```

--------------------------------

### OPTIONS /{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

CORS options for sub-notification endpoint. This endpoint handles CORS preflight requests for sub-notification operations.

```APIDOC
## OPTIONS /{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}

### Description
CORS options for sub-notification endpoint

### Method
OPTIONS

### Endpoint
`/{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}`

### Parameters
#### Path Parameters
- **envId** (string) - Required - Environment identifier
- **notificationId** (string) - Required - Notification identifier
- **subNotificationId** (string) - Required - Sub-notification identifier

### Request Example
(No request body)

### Response
#### Success Response (200)
- **Headers**: 
  - `Access-Control-Allow-Origin`: Specifies allowed origin.
  - `Access-Control-Allow-Methods`: Specifies allowed HTTP methods.
  - `Access-Control-Allow-Headers`: Specifies allowed request headers.
```

--------------------------------

### Validate Client Authentication - Authentication API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Validates client authentication using the provided client ID. This endpoint is part of the Authentication API.

```http
GET /{clientId}/auth/validateAuthenticate
```

--------------------------------

### Update Default Template by Channel (PATCH)

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Updates the default template for a specific notification channel. This endpoint requires environment ID, notification ID, and channel as path parameters, and accepts a JSON request body containing the template ID.

```bash
PATCH /{envId}/notifications/{notificationId}/defaulttemplate/{channel}

Content-Type: application/json
Accept: application/json

{
  "templateId": "<string>"
}
```

--------------------------------

### Update User Preferences (Admin) - User Preferences API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Updates user preferences for notifications as an admin. It requires client and user identifiers. The request body is an array of objects specifying notification details and channels.

```http
POST /{clientId}/user_preferences/{userId}
```

```json
[
  {
    "notificationId": "<string>"
  },
  {
    "notificationId": "<string>",
    "channel": "<string>",
    "delivery": "<string>"
  },
  {
    "notificationId": "<string>",
    "subNotificationId": "<string>",
    "channel": "<string>",
    "delivery": "<string>"
  }
]
```

```json
{
  "UserPreferences": [
    {
      "envId": "24nojpnrsdc53fkslha0roov05",
      "userId": "USER_ID",
      "notificationId": "invitation",
      "channelsStates": []
    }
  ]
}
```

--------------------------------

### Patch In-App Notification

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Marks notifications as read, clicked, or archived for a user.

```APIDOC
## PATCH /{clientId}/users/{userId}/notifications/INAPP_WEB

### Description
Mark notifications as read, clicked, or archived

### Method
PATCH

### Endpoint
`/{clientId}/users/{userId}/notifications/INAPP_WEB`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
- **userId** (string) - Required - User identifier

#### Header Parameters
- **Accept** (string) - Optional - `application/json`

#### Request Body
- **trackingIds** (array of strings) - Required - List of notification tracking IDs
- **opened** (string) - Optional - Indicates if notifications were opened
- **clicked** (string) - Optional - Indicates if notifications were clicked
- **archived** (string) - Optional - Indicates if notifications were archived
- **actioned1** (string) - Optional - Indicates if action 1 was taken
- **actioned2** (string) - Optional - Indicates if action 2 was taken
- **reply** (object) - Optional - Reply details
  - **date** (string) - Required - Date of the reply
  - **message** (string) - Required - Message content

### Request Example
```json
{
  "trackingIds": ["<string>"],
  "opened": "<string>",
  "clicked": "<string>",
  "archived": "<string>",
  "actioned1": "<string>",
  "actioned2": "<string>",
  "reply": {
    "date": "<string>",
    "message": "<string>"
  }
}
```

### Response
#### Success Response (200)
Success
```

--------------------------------

### PUT /{clientId}/notifications/{notificationId}/subNotifications/{subNotificationId}

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Create subNotification. This endpoint creates a sub-notification within a given notification.

```APIDOC
## PUT /{clientId}/notifications/{notificationId}/subNotifications/{subNotificationId}

### Description
Create subNotification

### Method
PUT

### Endpoint
`/{clientId}/notifications/{notificationId}/subNotifications/{subNotificationId}`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
  - Example: `CLIENT_ID`
- **notificationId** (string) - Required - Notification identifier
- **subNotificationId** (string) - Required - Sub-notification identifier

#### Headers
- **Content-Type** (string) - Optional - `application/json`
- **Accept** (string) - Optional - `application/json`

#### Request Body
- **title** (string) - Required - The title of the sub-notification

### Request Example
```json
{
  "title": "<string>"
}
```

### Response
#### Success Response (200)
- **accountId** (string) - The account ID.
- **notificationId** (string) - The notification ID.
- **subNotificationId** (string) - The sub-notification ID.
- **title** (string) - The title of the sub-notification.

#### Response Example
```json
{
  "accountId": "24nojpnrsdc53fkslha0roov05",
  "notificationId": "project_approval",
  "subNotificationId": "proj_abc",
  "title": "Project ABC"
}
```
```

--------------------------------

### Unsubscribe User from Notifications

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Allows a user to unsubscribe from notifications or specific channels. This endpoint requires the client ID and user ID, and accepts optional query parameters for token, channel, and notification IDs.

```HTTP
POST /{clientId}/users/{userId}/unsubscribe?token=TOKEN&channel=CHANNEL_TYPE&notificationId=NOTIFICATION_ID&subNotificationId=SUB_NOTIFICATION_ID
```

--------------------------------

### Unsubscribe User

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Unsubscribes a user from notifications or specific channels.

```APIDOC
## POST /{clientId}/users/{userId}/unsubscribe

### Description
Unsubscribe user from notifications or channels

### Method
POST

### Endpoint
`/{clientId}/users/{userId}/unsubscribe`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
- **userId** (string) - Required - User identifier

#### Query Parameters
- **token** (string) - Optional - Unsubscribe token
- **channel** (string) - Optional - Channel type to unsubscribe from
- **notificationId** (string) - Optional - Notification identifier to unsubscribe from
- **subNotificationId** (string) - Optional - Sub-notification identifier to unsubscribe from

### Response
#### Success Response (200)
Success
```

--------------------------------

### Mark Notification as Read

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Marks specific in-app notifications as read. This endpoint requires the client ID, user ID, and a request body containing the notification ID to be marked as read.

```HTTP
PATCH /{clientId}/users/{userId}/unread/INAPP_WEB

{
  "notificationId": "TRACKING_ID"
}
```

--------------------------------

### Delete User Data

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Removes all user data and preferences associated with a given client ID and user ID. This is a destructive operation.

```HTTP
DELETE /{clientId}/users/{userId}
```

--------------------------------

### Patch In-App Notification Status

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Updates the status of in-app notifications, such as marking them as read, clicked, or archived. This endpoint requires the client ID and user ID, along with a request body specifying the actions to perform.

```HTTP
PATCH /{clientId}/users/{userId}/notifications/INAPP_WEB

{
  "trackingIds": ["<string>"],
  "opened": "<string>",
  "clicked": "<string>",
  "archived": "<string>",
  "actioned1": "<string>",
  "actioned2": "<string>",
  "reply": {
    "date": "<string>",
    "message": "<string>"
  }
}
```

--------------------------------

### Update Scheduled Notification API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Updates a previously scheduled notification. It requires both a client ID and a tracking ID for the notification. The request body can include updated scheduling information, user details, merge tags, template ID, and channel-specific options for email, APN, and FCM. Dependencies include the client ID and tracking ID.

```HTTP
PATCH /{clientId}/schedule/{trackingId}

{
  "schedule": "<string>",
  "secondaryId": "<string>",
  "replace": {},
  "options": {
    "fcm": {
      "android": {
        "restrictedPackageName": "<string>",
        "collapseKey": "<string>",
        "priority": "high",
        "ttl": "<number>"
      }
    },
    "email": {
      "attachments": [
        {
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "ccAddresses": ["<string>"],
      "fromName": "<string>",
      "fromAddress": "<string>",
      "bccAddresses": ["<string>"],
      "replyToAddresses": ["<string>"]
    },
    "apn": {
      "collapseId": "<string>",
      "threadId": "<string>",
      "badge": "<number>",
      "sound": "<string>",
      "expiry": "<number>",
      "priority": "<number>",
      "contentAvailable": "<boolean>"
    }
  },
  "mergeTags": {},
  "templateId": "<string>",
  "subNotificationId": "<string>",
  "forceChannels": [
    "PUSH",
    "INAPP_WEB"
  ],
  "user": {
    "id": "<string>",
    "number": "<string>",
    "email": "<string>"
  }
}
```

--------------------------------

### PATCH /schedule/{trackingId}

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Update a scheduled notification. This endpoint allows modification of the schedule time, content, and delivery options for a previously scheduled notification.

```APIDOC
## PATCH /schedule/{trackingId}

### Description
Update a scheduled notification.

### Method
PATCH

### Endpoint
`/{clientId}/schedule/{trackingId}`

### Parameters
#### Path Parameters
- **clientId** (string) - Required - Client identifier
  - Example: `CLIENT_ID`
- **trackingId** (string) - Required - Tracking identifier of the scheduled notification.

#### Header Parameters
- **Content-Type** (string) - Optional - `application/json`

#### Request Body
- **schedule** (string) - Optional - The new schedule time for the notification.
- **secondaryId** (string) - Optional - A secondary identifier.
- **replace** (object) - Optional - Object for replacing content.
- **options** (object) - Optional - Options for specific channels.
  - **fcm** (object) - Optional - Firebase Cloud Messaging specific options.
    - **android** (object) - Optional - Android specific FCM options.
      - **restrictedPackageName** (string) - Optional - Restricted package name for Android FCM.
      - **collapseKey** (string) - Optional - Collapse key for Android FCM.
      - **priority** (string) - Optional - Priority for Android FCM (e.g., `high`).
      - **ttl** (number) - Optional - Time-to-live for Android FCM messages.
  - **email** (object) - Optional - Email specific options.
    - **attachments** (array) - Optional - Array of attachment objects.
      - **name** (string) - Required - Name of the attachment.
      - **url** (string) - Required - URL of the attachment.
    - **ccAddresses** (array) - Optional - Array of CC email addresses.
    - **fromName** (string) - Optional - Sender's name for email.
    - **fromAddress** (string) - Optional - Sender's email address.
    - **bccAddresses** (array) - Optional - Array of BCC email addresses.
    - **replyToAddresses** (array) - Optional - Array of reply-to email addresses.
  - **apn** (object) - Optional - Apple Push Notification specific options.
    - **collapseId** (string) - Optional - Collapse ID for APN.
    - **threadId** (string) - Optional - Thread ID for APN.
    - **badge** (number) - Optional - Badge count for APN.
    - **sound** (string) - Optional - Sound for APN notification.
    - **expiry** (number) - Optional - Expiry time for APN notification.
    - **priority** (number) - Optional - Priority for APN notification.
    - **contentAvailable** (boolean) - Optional - Content available flag for APN.
- **mergeTags** (object) - Optional - Key-value pairs for personalizing notification content.
- **templateId** (string) - Optional - The ID of the template to use.
- **subNotificationId** (string) - Optional - A secondary identifier for the notification.
- **forceChannels** (array) - Optional - An array of channels to force delivery through (e.g., `["PUSH", "INAPP_WEB"]`).
- **user** (object) - Optional - User details for notification delivery.
  - **id** (string) - Required - User's unique identifier.
  - **number** (string) - Required - User's phone number.
  - **email** (string) - Required - User's email address.

### Response
#### Success Response (200)
- Success

### Response Example
Success
```

--------------------------------

### Delete Sub-Notification - Sub Notifications API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Deletes a sub-notification. It requires environment, notification, and sub-notification identifiers. Successful deletion returns a 204 status code.

```http
DELETE /{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}
```

--------------------------------

### DELETE /{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Delete subNotification. This endpoint deletes a sub-notification.

```APIDOC
## DELETE /{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}

### Description
Delete subNotification

### Method
DELETE

### Endpoint
`/{envId}/notifications/{notificationId}/subNotifications/{subNotificationId}`

### Parameters
#### Path Parameters
- **envId** (string) - Required - Environment identifier
- **notificationId** (string) - Required - Notification identifier
- **subNotificationId** (string) - Required - Sub-notification identifier

### Request Example
(No request body)

### Response
#### Success Response (204)
- No content returned on successful deletion.

#### Error Response (404)
- Not Found: Indicates the specified sub-notification does not exist.
```

--------------------------------

### Delete Scheduled Notification API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Deletes a scheduled notification. This API requires both the client ID and the tracking ID of the notification to be deleted. It is a simple DELETE request and returns a success status upon successful deletion. Dependencies include the client ID and tracking ID.

```HTTP
DELETE /{clientId}/schedule/{trackingId}
```

--------------------------------

### Delete In-App Notification API

Source: https://drive.google.com/file/d/1fMawFnKv0Q0HrDrjNZWIdmwb4xd-HMua/view

Deletes an In-App Notification from a user's inbox. This operation requires an environment ID and accepts a JSON request body specifying the notification to be deleted using its ID and optionally a user or secondary ID. It returns a success status upon completion.

```HTTP
POST /{envId}/sender/retract

{
  "notificationId": "<string>",
  "userId": "<string>",
  "secondaryId": "<string>",
  "subNotificationId": "<string>"
}
```
Tokens:
Raw