Manage User Subscriptions & Preferences

Get user preference

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.

get/{WSID}/{version}/subscriptions/preference

Path parameters

WSIDstring required

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

version'live' | 'test' required

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

Query parameters

distinct_idstring required

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

event_listtrue | false

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

Response

Preference fetched successfully

Changes

Changed in 2 of the 35 revisions of this API.18

Feb 17, 2025ee2cf82f4e6a4See the full diff
- ○
  the response property _message became required for the status 400
  response-property-became-required
- ○
  the response property _message became required for the status 401
  response-property-became-required
- ○
  the response property status became required for the status 400
  response-property-became-required
- ○
  the response property status became required for the status 401
  response-property-became-required
Feb 12, 2025758a3fb292b914See the full diff
- ○
  the response property meta became required for the status 200
  response-property-became-required
- ○
  the response property meta/all became required for the status 200
  response-property-became-required
- ○
  the response property meta/all/preference became required for the status 200
  response-property-became-required
- ○
  the response property meta/all/updated_at became required for the status 200
  response-property-became-required
- ○
  the response property result became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1 became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/channel_config became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/description became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/is_global_opted_out became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/name became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/notification_events became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/preference became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/subscription_id became required for the status 200
  response-property-became-required
- ○
  the response property result/Section1/items/updated_at became required for the status 200
  response-property-became-required

Full history