Sign in
User Preferences

Get user subscription topic

Returns a user's opt-in status and channel choices for one subscription topic, or the effective default if they have set no override.

get/users/{user_id}/preferences/{topic_id}

Path parameters

user_idstring required

A unique identifier associated with the user whose preferences you wish to retrieve.

topic_idstring required

A unique identifier associated with a subscription topic.

Query parameters

tenant_idstring nullable

Query the preferences of a user for this specific tenant context.

Response

Changes

Changed in 2 of the 55 revisions of this API.210

  • f76bed79a91328See the full diff
    • ▲

      the topic/default_status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the topic/status response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ○

      added PreferenceStatus to the topic/default_status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added PreferenceStatus to the topic/status response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed the OPTED_IN enum value from the topic/default_status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the OPTED_IN enum value from the topic/status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the OPTED_OUT enum value from the topic/default_status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the OPTED_OUT enum value from the topic/status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the REQUIRED enum value from the topic/default_status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the REQUIRED enum value from the topic/status response property for the response status 200

      response-property-enum-value-removed

  • e67d027395332See the full diff
    • ○

      api tag User Preferences added

      api-tag-added

    • ○

      api tag UsersPreferences removed

      api-tag-removed