Manage User Subscriptions & Preferences

Update user preference (single)

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

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.

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

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

    • 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

  • 758a3fb292b931See the full diff
    • the request property channel became required

      request-property-became-required

    • the request property distinct_id became required

      request-property-became-required

    • the request property status became required

      request-property-became-required

    • the response property SXXXXXXXXX became required for the status 200

      response-property-became-required