app.bivri.actor.putPreferences

Replace the authenticated account's own preferences. Every group sent is replaced whole and every group omitted is left as it was, so a client that knows about one group cannot silently reset another it has never heard of. Sending the same preferences twice is the same as sending them once. Preferences are the account's alone: nothing here names another account, and nothing here is served to one.

Details · procedure
Kindprocedure
Authorityactor.bivri.app
Indexed

Procedure

procedure · POST

Input

application/json

Replace the caller's content filter group. All four labels are required together. Omit this group to leave it unchanged.

Replace the caller's complete interest Tag set. Omit this group to leave it unchanged; send an empty array to clear it.

Replace the caller's complete muted Tag set. Omit this group to leave it unchanged; send an empty array to clear it.

Replace the caller's complete muted word set. Omit this group to leave it unchanged; send an empty array to clear it.

Output

application/json

The caller's stored content filter group, or the defaults when none was stored.

The caller's complete stored interest Tag set.

The caller's complete stored muted Tag set, normalized and in lexical order.

The caller's complete stored muted word set, normalized and in lexical order.

Errors

ConsentRequired

The authenticated member has not confirmed age and accepted the Terms and Privacy Policy.

Unauthenticated

Nobody is authenticated, so there are no preferences to replace.

InvalidInput

The request body is not an object, a notification or content filter group is invalid, or interests, mutedWords or mutedTags is not a bounded array of non-empty strings. Nothing was stored.

UnavailableTag

At least one interest is not a Tag present in the indexed Artwork catalog. Nothing was stored.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Read the authenticated account's own preferences. Scoped to the caller and to nobody else: there is no parameter naming whose preferences to read, because one account's preferences are never another account's business. An account that has never set a preference reads the defaults rather than an absence, so a client has nothing to guess.

  • Changes the asking account's preferences.

  • Set notification-related preferences for an account. Requires auth.

  • Pushes the requesting user's social.colibri.beta.actor.settings record to the AppView, so it takes effect immediately instead of waiting for a sync notification. The client writes the record to its own personal space first, then calls this. An absent field leaves the current value unchanged.

  • Set the private preferences attached to the account.