Skip to main content
POST
/
v1
/
subscribers
/
{subscriberId}
/
messages
/
{messageId}
/
actions
/
{type}
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use novu;
use novu\Models\Components;
use novu\Models\Operations;

$sdk = novu\Novu::builder()
    ->setSecurity(
        'YOUR_SECRET_KEY_HERE'
    )
    ->build();

$request = new Operations\SubscribersV1ControllerMarkActionAsSeenRequest(
    messageId: '<id>',
    type: '<value>',
    subscriberId: '<id>',
    markMessageActionAsSeenDto: new Components\MarkMessageActionAsSeenDto(
        status: Components\MarkMessageActionAsSeenDtoStatus::Pending,
    ),
);

$response = $sdk->subscribers->messages->updateAsSeen(
    request: $request
);

if ($response->messageResponseDto !== null) {
    // handle response
}
{
  "_environmentId": "<string>",
  "_organizationId": "<string>",
  "_notificationId": "<string>",
  "_subscriberId": "<string>",
  "createdAt": "<string>",
  "transactionId": "<string>",
  "read": true,
  "seen": true,
  "cta": {
    "type": "redirect",
    "data": {
      "url": "<string>"
    },
    "action": {
      "buttons": [
        {
          "content": "<string>",
          "resultContent": "<string>"
        }
      ],
      "result": {
        "payload": {}
      }
    }
  },
  "_id": "<string>",
  "_templateId": "<string>",
  "_messageTemplateId": "<string>",
  "subscriber": {
    "subscriberId": "<string>",
    "_organizationId": "<string>",
    "_environmentId": "<string>",
    "deleted": true,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "_id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "avatar": "<string>",
    "locale": "<string>",
    "channels": [
      {
        "credentials": {
          "webhookUrl": "https://example.com/webhook",
          "channel": "general",
          "deviceTokens": [
            "token1",
            "token2",
            "token3"
          ],
          "alertUid": "12345-abcde",
          "title": "Critical Alert",
          "imageUrl": "https://example.com/image.png",
          "state": "resolved",
          "externalUrl": "https://example.com/details"
        },
        "_integrationId": "<string>",
        "integrationIdentifier": "<string>"
      }
    ],
    "topics": [
      "<string>"
    ],
    "isOnline": true,
    "lastOnlineAt": "<string>",
    "__v": 123,
    "data": {},
    "timezone": "<string>"
  },
  "template": {
    "name": "<string>",
    "description": "<string>",
    "active": true,
    "draft": true,
    "preferenceSettings": {
      "email": true,
      "sms": false,
      "in_app": true,
      "chat": false,
      "push": true
    },
    "critical": true,
    "tags": [
      "<string>"
    ],
    "steps": [
      {
        "_id": "<string>",
        "uuid": "<string>",
        "name": "<string>",
        "_templateId": "<string>",
        "active": true,
        "shouldStopOnFail": true,
        "template": {},
        "filters": [
          {
            "isNegated": true,
            "children": [
              {
                "field": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "_parentId": "<string>",
        "metadata": {
          "amount": 123,
          "digestKey": "<string>",
          "backoff": true,
          "backoffAmount": 123,
          "updateMode": true
        },
        "replyCallback": {
          "active": true,
          "url": "<string>"
        },
        "variants": [
          {
            "_id": "<string>",
            "uuid": "<string>",
            "name": "<string>",
            "_templateId": "<string>",
            "active": true,
            "shouldStopOnFail": true,
            "template": {},
            "filters": [
              {
                "isNegated": true,
                "children": [
                  {
                    "field": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            ],
            "_parentId": "<string>",
            "metadata": {
              "amount": 123,
              "digestKey": "<string>",
              "backoff": true,
              "backoffAmount": 123,
              "updateMode": true
            },
            "replyCallback": {
              "active": true,
              "url": "<string>"
            }
          }
        ]
      }
    ],
    "_organizationId": "<string>",
    "_creatorId": "<string>",
    "_environmentId": "<string>",
    "triggers": [
      {
        "type": "event",
        "identifier": "<string>",
        "variables": [
          {
            "name": "<string>"
          }
        ],
        "subscriberVariables": [
          {
            "name": "<string>"
          }
        ]
      }
    ],
    "_notificationGroupId": "<string>",
    "deleted": true,
    "deletedAt": "<string>",
    "deletedBy": "<string>",
    "_id": "<string>",
    "_parentId": "<string>",
    "notificationGroup": {
      "name": "<string>",
      "_environmentId": "<string>",
      "_organizationId": "<string>",
      "_id": "<string>",
      "_parentId": "<string>"
    },
    "data": {},
    "workflowIntegrationStatus": {}
  },
  "templateIdentifier": "<string>",
  "deliveredAt": [
    "<string>"
  ],
  "lastSeenDate": "<string>",
  "lastReadDate": "<string>",
  "content": [
    {
      "content": "<string>",
      "url": "<string>",
      "styles": {}
    }
  ],
  "subject": "<string>",
  "snoozedUntil": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "directWebhookUrl": "<string>",
  "providerId": "<string>",
  "deviceTokens": [
    "<string>"
  ],
  "title": "<string>",
  "_feedId": "<string>",
  "errorId": "<string>",
  "errorText": "<string>",
  "payload": {},
  "overrides": {},
  "contextKeys": [
    "tenant:org-123",
    "region:us-east-1"
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

Headers

​
idempotency-key
string

A header for idempotency purposes

Path Parameters

​
messageId
string
required
​
subscriberId
string
required

Body

application/json
​
status
enum<string>
required

Message action status

Available options:
pending,
done
​
payload
object

Message action payload

Response

Created

​
_environmentId
string
required

Environment ID where the message is sent

​
_organizationId
string
required

Organization ID associated with the message

​
_notificationId
string
required

Notification ID associated with the message

​
_subscriberId
string
required

Subscriber ID associated with the message

​
createdAt
string
required

Creation date of the message

​
transactionId
string
required

Transaction ID associated with the message

​
channel
enum<string>
required

Channel type through which the message is sent

Available options:
in_app,
email,
sms,
chat,
push
​
read
boolean
required

Indicates if the message has been read

​
seen
boolean
required

Indicates if the message has been seen

​
cta
object
required

Call to action associated with the message

​
status
enum<string>
required

Status of the message

Available options:
sent,
error,
warning
​
_id
string

Unique identifier for the message

​
_templateId
string | null

Template ID associated with the message

​
_messageTemplateId
string | null

Message template ID

​
subscriber
object

Subscriber details, if available

​
template
object

Workflow template associated with the message

​
templateIdentifier
string

Identifier for the message template

​
deliveredAt
string[]

Array of delivery dates for the message, if the message has multiple delivery dates, for example after being snoozed

​
lastSeenDate
string

Last seen date of the message, if available

​
lastReadDate
string

Last read date of the message, if available

​
content

Content of the message, can be an email block or a string

​
subject
string

Subject of the message, if applicable

​
snoozedUntil
string

Date when the message will be unsnoozed

​
email
string

Email address associated with the message, if applicable

​
phone
string

Phone number associated with the message, if applicable

​
directWebhookUrl
string

Direct webhook URL for the message, if applicable

​
providerId
string

Provider ID associated with the message, if applicable

​
deviceTokens
string[]

Device tokens associated with the message, if applicable

​
title
string

Title of the message, if applicable

​
_feedId
string | null

Feed ID associated with the message, if applicable

​
errorId
string

Error ID if the message has an error

​
errorText
string

Error text if the message has an error

​
payload
object

The payload that was used to send the notification trigger

​
overrides
object

Provider specific overrides used when triggering the notification

​
contextKeys
string[]

Context (single or multi) in which the message was sent

Example:
["tenant:org-123", "region:us-east-1"]