Skip to main content

adminUserPreferenceUpdate

Update a preference of an administrative user.

Replaces the stored value as a whole. The owner, type, key and scope of a preference cannot be changed. With a role, the preference of any admin user can be updated.

Possible errors:

  • ADMIN_USER_PREFERENCE_NOT_FOUND_ERROR: No such preference, or it belongs to another admin user
  • ADMIN_USER_PREFERENCE_AUTH_ERROR: The request neither identifies an admin user nor carries a role
  • ADMIN_USER_PREFERENCE_UPDATE_ERROR: Error occurred while updating the preference

AUTH: Role=[user.OWNER,user.EDITOR] OR ('user is authenticated')

adminUserPreferenceUpdate(
  id: ID!
  input: AdminUserPreferenceUpdateInput!
): AdminUserPreference!

Arguments​

adminUserPreferenceUpdate.id ● ID! non-null scalar​

Unique identifier of the preference to update.

adminUserPreferenceUpdate.input ● AdminUserPreferenceUpdateInput! non-null input​

Update parameters for the preference.

Type​

AdminUserPreference object​

A single preference of an administrative user, such as the column layout of one table or the chosen theme. The value is opaque to the platform: its shape is owned by the client that stores it.