Subscriber Preferences not reflected in Get Preferences API and when triggering a workflow
Dear Support,
we creating and updating Subscribers preferences via API (currently testing this integration via PostMan and with Novu configured as self hosted using Docker images version 2.1.1).
What is happening is that the preferences seems to be reflected in the MongoDB and in the Get Subscriber API, but when calling the Get Subscriber Preferences API we can't see them reflected at all; moreover, the subscriber preferences are not considered when triggering the workflow steps (e.g. email:false is still triggering the email, even though the workflow is not marked as "critical").
Is something that we are doing wrong? Please see below the list of API calls that we are making to create, update and get the subscriber and its preferences:
Create subscriber API:
curl --location 'http://localhost:3000/v1/subscribers' \
--header 'Authorization: ApiKey <AK>' \
--header 'Content-Type: application/json' \
--data-raw '{
"subscriberId": "1234",
"email": "[email protected]",
"firstName": "M",
"lastName": "G",
"phone": "+1234567890",
"data" :{}
}'
Update preferences API:
curl --location --request PATCH 'http://localhost:3000/v2/subscribers/1234' \
--header 'Authorization: ApiKey <AK>' \
--header 'Content-Type: application/json' \
--data '{
"channels": {
"email": false,
"in_app": true
}
}'
Get Subscriber API response:
{
"data": {
"firstName": "M",
"lastName": "G",
"email": "[email protected]",
"phone": "+1234567890",
"subscriberId": "1234",
"deleted": false,
"data": {},
"channels": [
{
"email": false,
"in_app": true
}
]
}
}
Get Subscriber preferences API:
curl --location 'http://localhost:3000/v2/subscribers/1234/preferences' \
--header 'Authorization: ApiKey <AK>' \
--header 'Content-Type: application/json' \
--data ''
Response:
{
"data": {
"global": {
"enabled": true,
"channels": {
"email": true,
"sms": true,
"in_app": true
}
},
"workflows": [...]
7 Replies
@MG, you just advanced to level 1!
Update preferences API:
curl --location --request PATCH 'http://localhost:3000/v2/subscribers/1234' \
--header 'Authorization: ApiKey <AK>' \
--header 'Content-Type: application/json' \
--data '{
"channels": {
"email": false,
"in_app": true
}
}'
this request requires workflowid also as far as I remember
From the documentation: "workflowId" (not required): If provided, update workflow specific preferences, otherwise update global preferences
and that's what my goal is: to update the global preferences at subscriber level. From the documentation itself, it's stated that "Subscribers can set global channel preferences, which override individual settings. For instance, if there are 10 workflows, and a subscriber wants to disable SMS notifications for all of them, they can do so with via global preferences."
@MG
As you are self hosting novu, so legacy docs will be relevant for you
https://v0.x-docs.novu.co
Novu
What is Novu? - Novu
Novu is a full-stack (UI, API & GitOps) open source notification infrastructure tool and platform for building, managing, delivering, and monitoring all types of end-user notifications.
@Pawan Jain does it mean that with Self Hosting we can't use version 2.x.x ?
for self hosted instances including 2.x.x, old apis should be used
@Pawan Jain I got it working, I was using the wrong URL to update the preferences. The correct one is: http://localhost:3000/v2/subscribers/1234/preferences (v2 version is working just fine)