Modify subscriber credentials
Subscriber credentials associated to the delivery methods such as slack and push tokens.
This endpoint appends provided credentials and deviceTokens to the existing ones.
Authorization
Authorization
<token>API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
In: header
Request Body
application/json
RequiredproviderId
RequiredstringThe provider identifier for the credentials
"slack" | "discord" | "msteams" | "mattermost" | "ryver" | "zulip" | "grafana-on-call" | "getstream" | "rocket-chat" | "whatsapp-business" | "fcm" | "apns" | "expo" | "one-signal" | "pushpad" | "push-webhook" | "pusher-beams"
integrationIdentifier
stringThe integration identifier
credentials
RequiredobjectCredentials payload for the specified provider
Path Parameters
subscriberId
RequiredstringHeader Parameters
idempotency-key
stringA header for idempotency purposes
Response Body
OK
_id
stringThe 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.
firstName
stringThe first name of the subscriber.
lastName
stringThe last name of the subscriber.
email
string | nullThe email address of the subscriber.
phone
stringThe phone number of the subscriber.
avatar
stringThe URL of the subscriber's avatar image.
locale
stringThe locale setting of the subscriber, indicating their preferred language or region.
subscriberId
RequiredstringThe identifier used to create this subscriber, which typically corresponds to the user ID in your system.
channels
array<object>An array of channel settings associated with the subscriber.
topics
Deprecatedarray<string>An array of topics that the subscriber is subscribed to.
isOnline
booleanIndicates whether the subscriber is currently online.
lastOnlineAt
stringThe timestamp indicating when the subscriber was last online, in ISO 8601 format.
_organizationId
RequiredstringThe unique identifier of the organization to which the subscriber belongs.
_environmentId
RequiredstringThe unique identifier of the environment associated with this subscriber.
deleted
RequiredbooleanIndicates whether the subscriber has been deleted.
createdAt
RequiredstringThe timestamp indicating when the subscriber was created, in ISO 8601 format.
updatedAt
RequiredstringThe timestamp indicating when the subscriber was last updated, in ISO 8601 format.
__v
numberThe version of the subscriber document.
data
object | nullAdditional custom data for the subscriber
timezone
stringTimezone of the subscriber