Get user preference

GET

https://api.fyno.io/v1/:WSID/:version/subscriptions/preference

GET

/v1/:WSID/:version/subscriptions/preference

1 import requests
2 
3 url = "https://api.fyno.io/v1/FYXXXXXXXX/live/subscriptions/preference"
4 
5 querystring = {"distinct_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","event_list":"false"}
6 
7 headers = {"Authorization": "Bearer <token>"}
8 
9 response = requests.get(url, headers=headers, params=querystring)
10 
11 print(response.json())

Try it

200Retrieved

1 {
2   "meta": {
3     "all": {
4       "preference": {
5         "discord": "opted-out",
6         "email": "opted-out",
7         "inapp": "opted-out",
8         "push": "opted-out",
9         "slack": "opted-out",
10         "sms": "opted-out",
11         "teams": "opted-out",
12         "voice": "opted-out",
13         "whatsapp": "opted-out"
14       },
15       "updated_at": {
16         "discord": "string",
17         "email": "string",
18         "inapp": "string",
19         "push": "string",
20         "slack": "string",
21         "sms": "string",
22         "teams": "string",
23         "voice": "string",
24         "webpush": "string",
25         "whatsapp": "string"
26       }
27     }
28   },
29   "result": {
30     "Section1": [
31       {
32         "channel_config": {
33           "discord": "on",
34           "email": "on",
35           "inapp": "on",
36           "push": "on",
37           "slack": "on",
38           "sms": "on",
39           "teams": "on",
40           "voice": "on",
41           "webpush": "on",
42           "whatsapp": "on"
43         },
44         "description": "string",
45         "is_global_opted_out": {
46           "discord": true,
47           "email": true,
48           "inapp": true,
49           "push": true,
50           "slack": true,
51           "sms": true,
52           "teams": true,
53           "voice": true,
54           "webpush": true,
55           "whatsapp": true
56         },
57         "name": "string",
58         "notification_events": [
59           {
60             "event_id": "string",
61             "event_name": "string"
62           }
63         ],
64         "preference": {
65           "discord": "opted-in",
66           "email": "opted-in",
67           "inapp": "opted-in",
68           "push": "opted-in",
69           "slack": "opted-in",
70           "sms": "opted-in",
71           "teams": "opted-in",
72           "voice": "opted-in",
73           "webpush": "opted-in",
74           "whatsapp": "opted-in"
75         },
76         "subscription_id": "string",
77         "updated_at": {
78           "discord": "string",
79           "email": "string",
80           "inapp": "string",
81           "push": "string",
82           "slack": "string",
83           "sms": "string",
84           "teams": "string",
85           "voice": "string",
86           "webpush": "string",
87           "whatsapp": "string"
88         }
89       }
90     ]
91   }
92 }

This API enables you to get all the subscriptions topics (with sections) defined in your workspace along with the opted-in/opted-out preference of a particular user.

Authentication

AuthorizationBearer

Enter your API Key. If you don't have it already, you can create one from the API Keys page within your Fyno account

Path parameters

WSIDstringRequired

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

versionenumRequiredDefaults to live

Specify the version for which you would like to manage the user profile.

Allowed values:

Query parameters

distinct_idstringRequired

Enter the distinct ID that you currently use to identify the user.

event_listbooleanOptionalDefaults to false

Set this value to 'true' to receive list of notification events attached to each subscription topic.

Response

Preference fetched successfully

metaobject

resultobject

Authentication

Path parameters

Query parameters

Response

Errors