Preferences

class matterapi.endpoints.async_api.PreferencesApi(client: matterapi.client.base.BaseClient, skip_response_parsing: bool = False)

Endpoints for saving and modifying user preferences.

async delete_preferences(user_id: str, *, json_body: Union[List[matterapi.models.Preference], Dict]) → matterapi.models.StatusOK

Delete user’s preferences

Delete a list of the user’s preferences.

Permissions:

Must be logged in as the user being updated or have the edit_other_users permission.

Api Reference:

DeletePreferences

async get_preferences(user_id: str) → List[matterapi.models.Preference]

Get the user’s preferences

Get a list of the user’s preferences.

Permissions:

Must be logged in as the user being updated or have the edit_other_users permission.

Api Reference:

GetPreferences

async get_preferences_by_category(user_id: str, category: str) → List[matterapi.models.Preference]

List a user’s preferences by category

Lists the current user’s stored preferences in the given category.

Permissions:

Must be logged in as the user being updated or have the edit_other_users permission.

Api Reference:

GetPreferencesByCategory

async get_preferences_by_category_by_name(user_id: str, category: str, preference_name: str) → matterapi.models.Preference

Get a specific user preference

Gets a single preference for the current user with the given category and name.

Permissions:

Must be logged in as the user being updated or have the edit_other_users permission.

Api Reference:

GetPreferencesByCategoryByName

async update_preferences(user_id: str, *, json_body: Union[List[matterapi.models.Preference], Dict]) → matterapi.models.StatusOK

Save the user’s preferences

Save a list of the user’s preferences.

Permissions:

Must be logged in as the user being updated or have the edit_other_users permission.

Api Reference:

UpdatePreferences