Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 4 KB

README.md

File metadata and controls

54 lines (37 loc) · 4 KB

Properties

(subscribers.properties)

Overview

Available Operations

update_online_flag

Used to update the subscriber isOnline flag.

Example Usage

from novu_py import Novu
import os

with Novu(
    secret_key=os.getenv("NOVU_SECRET_KEY", ""),
) as novu:

    res = novu.subscribers.properties.update_online_flag(subscriber_id="<id>", update_subscriber_online_flag_request_dto={
        "is_online": False,
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
subscriber_id str ✔️ N/A
update_subscriber_online_flag_request_dto models.UpdateSubscriberOnlineFlagRequestDto ✔️ N/A
idempotency_key Optional[str] ➖ A header for idempotency purposes
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SubscribersV1ControllerUpdateSubscriberOnlineFlagResponse

Errors

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