Get user preference | Fyno Documentation

curl -G https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference \
     -H "Authorization: Bearer <apiKey>" \
     -d distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
     -d event_list=false

{
  "meta": {
    "all": {
      "preference": {
        "discord": "opted-out",
        "email": "opted-out",
        "inapp": "opted-out",
        "push": "opted-out",
        "slack": "opted-out",
        "sms": "opted-out",
        "teams": "opted-out",
        "voice": "opted-out",
        "whatsapp": "opted-out"
      },
      "updated_at": {
        "discord": "string",
        "email": "string",
        "inapp": "string",
        "push": "string",
        "slack": "string",
        "sms": "string",
        "teams": "string",
        "voice": "string",
        "webpush": "string",
        "whatsapp": "string"
      }
    }
  },
  "result": {
    "Section1": [
      {
        "channel_config": {
          "discord": "on",
          "email": "on",
          "inapp": "on",
          "push": "on",
          "slack": "on",
          "sms": "on",
          "teams": "on",
          "voice": "on",
          "webpush": "on",
          "whatsapp": "on"
        },
        "description": "string",
        "is_global_opted_out": {
          "discord": true,
          "email": true,
          "inapp": true,
          "push": true,
          "slack": true,
          "sms": true,
          "teams": true,
          "voice": true,
          "webpush": true,
          "whatsapp": true
        },
        "name": "string",
        "notification_events": [
          {
            "event_id": "string",
            "event_name": "string"
          }
        ],
        "preference": {
          "discord": "opted-in",
          "email": "opted-in",
          "inapp": "opted-in",
          "push": "opted-in",
          "slack": "opted-in",
          "sms": "opted-in",
          "teams": "opted-in",
          "voice": "opted-in",
          "webpush": "opted-in",
          "whatsapp": "opted-in"
        },
        "subscription_id": "string",
        "updated_at": {
          "discord": "string",
          "email": "string",
          "inapp": "string",
          "push": "string",
          "slack": "string",
          "sms": "string",
          "teams": "string",
          "voice": "string",
          "webpush": "string",
          "whatsapp": "string"
        }
      }
    ]
  }
}

This API enables you to get all the subscriptions topics (with sections) defined in your workspace along with the opted-in/opted-out preference of a particular user.

Authentication

AuthorizationBearer

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

WSIDstringRequired

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

versionstringRequired

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

Query parameters

distinct_idstringRequired

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

event_listbooleanOptionalDefaults to false

Set this value to 'true' to receive list of notification events attached to each subscription topic.

Response

Preference fetched successfully

metaobject

resultobject

Errors

400

Bad Request Error

401

Unauthorized Error