POST
/
v1
/
subscribers
/
{subscriberId}
/
messages
/
markAs
curl --request POST \
  --url https://api.novu.co/v1/subscribers/{subscriberId}/messages/markAs \
  --header 'Content-Type: application/json' \
  --data '{
  "mark": {
    "read": true,
    "seen": true
  },
  "messageId": "<string>"
}'
{
  "data": [
    {
      "_environmentId": "<string>",
      "_feedId": "<string>",
      "_id": "<string>",
      "_messageTemplateId": "<string>",
      "_notificationId": "<string>",
      "_organizationId": "<string>",
      "_subscriberId": "<string>",
      "_templateId": "<string>",
      "channel": "in_app",
      "content": {
        "content": "<string>",
        "styles": {
          "textAlign": "left"
        },
        "type": "text",
        "url": "<string>"
      },
      "createdAt": "<string>",
      "cta": {
        "action": {
          "buttons": [
            {
              "content": "<string>",
              "resultContent": "<string>",
              "type": "primary"
            }
          ],
          "result": {
            "payload": {},
            "type": "primary"
          },
          "status": "pending"
        },
        "data": {
          "url": "<string>"
        },
        "type": "redirect"
      },
      "deviceTokens": [
        "<string>"
      ],
      "directWebhookUrl": "<string>",
      "email": "<string>",
      "errorId": "<string>",
      "errorText": "<string>",
      "lastSeenDate": "<string>",
      "overrides": {},
      "payload": {},
      "phone": "<string>",
      "providerId": "<string>",
      "seen": true,
      "status": "sent",
      "subject": "<string>",
      "subscriber": {
        "__v": 123,
        "_environmentId": "<string>",
        "_id": "<string>",
        "_organizationId": "<string>",
        "avatar": "<string>",
        "channels": [
          {
            "_integrationId": "<string>",
            "credentials": {
              "alertUid": "<string>",
              "channel": "<string>",
              "deviceTokens": [
                "<string>"
              ],
              "externalUrl": "<string>",
              "imageUrl": "<string>",
              "state": "<string>",
              "title": "<string>",
              "webhookUrl": "<string>"
            },
            "integrationIdentifier": "<string>",
            "providerId": "slack"
          }
        ],
        "createdAt": "<string>",
        "deleted": true,
        "email": "<string>",
        "firstName": "<string>",
        "isOnline": true,
        "lastName": "<string>",
        "lastOnlineAt": "<string>",
        "locale": "<string>",
        "phone": "<string>",
        "subscriberId": "<string>",
        "updatedAt": "<string>"
      },
      "template": {
        "_creatorId": "<string>",
        "_environmentId": "<string>",
        "_id": "<string>",
        "_notificationGroupId": "<string>",
        "_organizationId": "<string>",
        "_parentId": "<string>",
        "active": true,
        "critical": true,
        "data": {},
        "deleted": true,
        "deletedAt": "<string>",
        "deletedBy": "<string>",
        "description": "<string>",
        "draft": true,
        "name": "<string>",
        "notificationGroup": {
          "_environmentId": "<string>",
          "_id": "<string>",
          "_organizationId": "<string>",
          "_parentId": "<string>",
          "name": "<string>"
        },
        "preferenceSettings": {
          "chat": true,
          "email": true,
          "in_app": true,
          "push": true,
          "sms": true
        },
        "steps": [
          {
            "_id": "<string>",
            "_parentId": {},
            "_templateId": "<string>",
            "active": true,
            "filters": [
              {
                "children": [
                  {
                    "field": "<string>",
                    "operator": "LARGER",
                    "true": "subscriber",
                    "value": "<string>"
                  }
                ],
                "isNegated": true,
                "type": "BOOLEAN",
                "value": "AND"
              }
            ],
            "metadata": {
              "amount": 123,
              "backoff": true,
              "backoffAmount": 123,
              "backoffUnit": "seconds",
              "digestKey": "<string>",
              "type": "regular",
              "unit": "seconds",
              "updateMode": true
            },
            "name": "<string>",
            "replyCallback": {},
            "shouldStopOnFail": true,
            "template": {},
            "uuid": "<string>",
            "variants": {
              "_id": "<string>",
              "_parentId": {},
              "_templateId": "<string>",
              "active": true,
              "filters": [
                {
                  "children": [
                    {
                      "field": "<string>",
                      "operator": "LARGER",
                      "true": "subscriber",
                      "value": "<string>"
                    }
                  ],
                  "isNegated": true,
                  "type": "BOOLEAN",
                  "value": "AND"
                }
              ],
              "metadata": {
                "amount": 123,
                "backoff": true,
                "backoffAmount": 123,
                "backoffUnit": "seconds",
                "digestKey": "<string>",
                "type": "regular",
                "unit": "seconds",
                "updateMode": true
              },
              "name": "<string>",
              "replyCallback": {},
              "shouldStopOnFail": true,
              "template": {},
              "uuid": "<string>"
            }
          }
        ],
        "tags": [
          "<string>"
        ],
        "triggers": [
          {
            "identifier": "<string>",
            "subscriberVariables": [
              {
                "name": "<string>"
              }
            ],
            "type": "event",
            "variables": [
              {
                "name": "<string>"
              }
            ]
          }
        ],
        "workflowIntegrationStatus": {}
      },
      "templateIdentifier": "<string>",
      "title": "<string>",
      "transactionId": "<string>"
    }
  ]
}

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Path Parameters

subscriberId
string
required

Body

application/json
mark
object
required
messageId
required

Response

201 - application/json
data
object[]