API ReferenceUser Subscriptions

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.

Path parameters

WSIDstringRequired

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

versionenumRequired

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

Allowed values:
subscription_idstringRequired

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.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
channelenumRequired
distinct_idstringRequired
statusenumRequired
Allowed values:

Response

This endpoint returns an object.
SXXXXXXXXXobject

Errors