PATCH
/
v2
/
subscribers
/
{subscriberId}

Authorizations

Authorization
string
header
required

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

Headers

idempotency-key
string

A header for idempotency purposes

Path Parameters

subscriberId
string
required

Body

application/json
avatar
string | null

Avatar URL or identifier

data
object | null

Additional custom data for the subscriber

email
string | null

Email address of the subscriber

firstName
string | null

First name of the subscriber

lastName
string | null

Last name of the subscriber

locale
string | null

Locale of the subscriber

phone
string | null

Phone number of the subscriber

subscriberId
string | null

Unique identifier of the subscriber

timezone
string | null

Timezone of the subscriber

Response

200 - application/json
_environmentId
string
required

The unique identifier of the environment associated with this subscriber.

_organizationId
string
required

The unique identifier of the organization to which the subscriber belongs.

createdAt
string
required

The timestamp indicating when the subscriber was created, in ISO 8601 format.

deleted
boolean
required

Indicates whether the subscriber has been deleted.

subscriberId
string
required

The identifier used to create this subscriber, which typically corresponds to the user ID in your system.

updatedAt
string
required

The timestamp indicating when the subscriber was last updated, in ISO 8601 format.

__v
number

The version of the subscriber document.

_id
string

The internal ID generated by Novu for your subscriber. This ID does not match the subscriberId used in your queries. Refer to subscriberId for that identifier.

avatar
string

The URL of the subscriber's avatar image.

channels
object[]

An array of channel settings associated with the subscriber.

data
object | null

Additional custom data for the subscriber

email
string | null

The email address of the subscriber.

firstName
string

The first name of the subscriber.

isOnline
boolean

Indicates whether the subscriber is currently online.

lastName
string

The last name of the subscriber.

lastOnlineAt
string

The timestamp indicating when the subscriber was last online, in ISO 8601 format.

locale
string

The locale setting of the subscriber, indicating their preferred language or region.

phone
string

The phone number of the subscriber.

timezone
string

Timezone of the subscriber

topics
string[]
deprecated

An array of topics that the subscriber is subscribed to.