Delete a message

DELETE

/

v1

/

messages

/

{messageId}

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

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



$response = $sdk->messages->delete(
    messageId: '507f1f77bcf86cd799439011'
);

if ($response->deleteMessageResponseDto !== null) {
    // handle response
}

{
  "acknowledged": true,
  "status": "deleted"
}

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

Response

OK

acknowledged

boolean

required

A boolean stating the success of the action

status

enum<string>

required

The status enum for the performed action

Available options:

deleted

List all messages

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

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



$response = $sdk->messages->delete(
    messageId: '507f1f77bcf86cd799439011'
);

if ($response->deleteMessageResponseDto !== null) {
    // handle response
}

{
  "acknowledged": true,
  "status": "deleted"
}