Manage User Subscriptions & Preferences

Update user preference (single)

POST https://api.fyno.io/v1/{WSID}/{version}/subscriptions/list/{subscription_id}/user

This API enables you to update the channel preference of a user for a particular subscription topic.

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

subscription_idpathstringrequired

Enter the subscription ID to update the channel preference for the subscription topic. To update the user preference for all subscription topics at once (global preference), use 'all' instead of the subscription id.

Body

channelbodyenum (string)required

Allowed valuessmswhatsappemaildiscordslackteamspushvoiceinappwebpush

distinct_idbodystringrequired

statusbodyenum (string)required

Allowed valuesopted-inopted-out

Response

application/json

Subscription updated successfully

SXXXXXXXXXobjectrequired

properties

cURL

curl -X POST 'https://api.fyno.io/v1/{WSID}/{version}/subscriptions/list/{subscription_id}/user' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{"channel": "sms", "distinct_id": "string", "status": "opted-in"}'

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"
  }
}