README.md

SubscribersPreferences

(subscribersPreferences)

Overview

Available Operations

• list - Get subscriber preferences

list

Get subscriber global and workflow specific preferences

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use novu;

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



$response = $sdk->subscribersPreferences->list(
    subscriberId: '<id>',
    idempotencyKey: '<value>'

);

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

Parameters

Parameter	Type	Required	Description
subscriberId	string	✔️	N/A
idempotencyKey	?string	➖	A header for idempotency purposes

Response

?Operations\SubscribersControllerGetSubscriberPreferencesResponse

Errors

Error Type	Status Code	Content Type
Errors\ErrorDto	414	application/json
Errors\ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
Errors\ValidationErrorDto	422	application/json
Errors\ErrorDto	500	application/json
Errors\APIException	4XX, 5XX	*/*