FYfynoio
Manage User Subscriptions & Preferences

Update user preference (single)

Changed on

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.

post/{WSID}/{version}/subscriptions/list/{subscription_id}/user

Request

  • Base URL
    https://api.fyno.io/v1
  • URL
    https://api.fyno.io/v1/{WSID}/{version}/subscriptions/list/{subscription_id}/user
  • Auth
    HTTP bearer

Path parameters

WSIDstring required

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

versionstring required

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

subscription_idstring required

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.

Request body

channel'sms' | 'whatsapp' | 'email' | 'discord' | 'slack' | 'teams' | 'push' | 'voice' | 'inapp' | 'webpush' required
distinct_idstring required
status'opted-in' | 'opted-out' required

Response

Subscription updated successfully

Changes

  • f620f85db863Revision changes
    • breaking

      removed the enum value live from the path request parameter version

    • breaking

      removed the enum value test from the path request parameter version

  • ee2cf82f4e6aRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status