Manage User Subscriptions & Preferences

Update user preference

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

This API enables you to update the channel preference of a user for multiple subscription topics. In the JSON payload, enter the subscription ID as keys to update the channel preference. To update the user preference for all subscription topics at once (global preference), use 'all' instead of the subscription id.

Note: If the channel configuration for a subscription topic is set to 'required', then the user preference for the channel cannot be updated.

Authorization

Authorizationheaderstringrequired

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

WSIDpathstringrequired

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

versionpathenum (string)required

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

Allowed valueslivetest

Query Parameters

distinct_idquerystringrequired

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

Body

user_preferencebodyobjectrequired

properties

Response

application/json

Subscription updated successfully

SXXXXXXXXXobjectrequired

properties

cURL

curl -X PUT 'https://api.fyno.io/v1/{WSID}/{version}/subscriptions/preference' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"user_preference": {"SXXXXXXXXX": {"discord": "opted-out", "email": "opted-out", "inapp": "opted-out", "push": "opted-out", "slack": "opted-out", "sms": "opted-out", "teams": "opted-out", "voice": "opted-out", "webpush": "opted-out", "whatsapp": "opted-out"}}}'

200

{
  "SXXXXXXXXX": {
    "discord": "opted-out",
    "email": "opted-out",
    "inapp": "opted-out",
    "push": "opted-out",
    "slack": "opted-out",
    "sms": "opted-out",
    "teams": "opted-out",
    "voice": "opted-out",
    "webpush": "opted-out",
    "whatsapp": "opted-out"
  }
}