import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SingleSubscriberResponse;
import co.novu.api.subscribers.requests.UpdateSubscriberOnlineStatusRequest;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
String subscriberId = "<SUBSCRIBER_ID>";
UpdateSubscriberOnlineStatusRequest request = new UpdateSubscriberOnlineStatusRequest();
request.setIsOnline(true);
SingleSubscriberResponse response = novu.updateSubscriberOnlineStatus(request, subscriberId);
}
}
{
"data": {
"__v": "number",
"_environmentId": "string",
"_id": "string",
"_organizationId": "string",
"avatar": "string",
"channels": [
{
"_integrationId": "string",
"credentials": {
"channel": "string",
"deviceTokens": [
"string"
],
"webhookUrl": "string"
},
"integrationIdentifier": "string",
"providerId": "slack"
}
],
"createdAt": "string",
"deleted": "boolean",
"email": "string",
"firstName": "string",
"isOnline": "boolean",
"lastName": "string",
"lastOnlineAt": "string",
"locale": "string",
"phone": "string",
"subscriberId": "string",
"updatedAt": "string"
}
}
Subscribers
Update subscriber online status
Update the subscriber online status by its unique key identifier subscriberId
PATCH
/
v1
/
subscribers
/
{subscriberId}
/
online-status
import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SingleSubscriberResponse;
import co.novu.api.subscribers.requests.UpdateSubscriberOnlineStatusRequest;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
String subscriberId = "<SUBSCRIBER_ID>";
UpdateSubscriberOnlineStatusRequest request = new UpdateSubscriberOnlineStatusRequest();
request.setIsOnline(true);
SingleSubscriberResponse response = novu.updateSubscriberOnlineStatus(request, subscriberId);
}
}
{
"data": {
"__v": "number",
"_environmentId": "string",
"_id": "string",
"_organizationId": "string",
"avatar": "string",
"channels": [
{
"_integrationId": "string",
"credentials": {
"channel": "string",
"deviceTokens": [
"string"
],
"webhookUrl": "string"
},
"integrationIdentifier": "string",
"providerId": "slack"
}
],
"createdAt": "string",
"deleted": "boolean",
"email": "string",
"firstName": "string",
"isOnline": "boolean",
"lastName": "string",
"lastOnlineAt": "string",
"locale": "string",
"phone": "string",
"subscriberId": "string",
"updatedAt": "string"
}
}
Enter your API key in the
Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80eimport co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SingleSubscriberResponse;
import co.novu.api.subscribers.requests.UpdateSubscriberOnlineStatusRequest;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
String subscriberId = "<SUBSCRIBER_ID>";
UpdateSubscriberOnlineStatusRequest request = new UpdateSubscriberOnlineStatusRequest();
request.setIsOnline(true);
SingleSubscriberResponse response = novu.updateSubscriberOnlineStatus(request, subscriberId);
}
}
{
"data": {
"__v": "number",
"_environmentId": "string",
"_id": "string",
"_organizationId": "string",
"avatar": "string",
"channels": [
{
"_integrationId": "string",
"credentials": {
"channel": "string",
"deviceTokens": [
"string"
],
"webhookUrl": "string"
},
"integrationIdentifier": "string",
"providerId": "slack"
}
],
"createdAt": "string",
"deleted": "boolean",
"email": "string",
"firstName": "string",
"isOnline": "boolean",
"lastName": "string",
"lastOnlineAt": "string",
"locale": "string",
"phone": "string",
"subscriberId": "string",
"updatedAt": "string"
}
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Body
application/json
Response
Ok
The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See subscriberId for that
Channels settings for subscriber
Show child attributes
Show child attributes
Was this page helpful?