Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Actions28

User → Update

AI-generated

Summary

Update user

Inputs

  • simplify — Whether to return a simplified version of the response
  • userId (required) — ID of the user to update
  • speculative — Whether to preview the changes without actually updating the user. Returns what the updated user would look like.
  • userFields — Choose from the list, or specify IDs using an expression.
  • profileFields —
  • privateData — Private Data for this resource. In JSON mode: top-level shallow merge only — set a key to null to remove it. In manual mode: supports dot-notation (e.g. address.city) to set nested keys. Learn more.
  • protectedData — Protected Data for this resource. In JSON mode: top-level shallow merge only — set a key to null to remove it. In manual mode: supports dot-notation (e.g. address.city) to set nested keys. Learn more.
  • publicData — Public Data for this resource. In JSON mode: top-level shallow merge only — set a key to null to remove it. In manual mode: supports dot-notation (e.g. address.city) to set nested keys. Learn more.
  • fieldDeletions — Fields to delete from the user's extended data.

Output shape

a single updated user object

When simplify is true the response is a simplified version; otherwise the full user record is returned; optional fields can be requested via userFields; pagination is not applicable; errors are signaled by HTTP status codes and an error object.

Examples

Example 1: Update user's display name and email address

Set userId to the target user ID, set profileFields.displayName and profileFields.email to new values, and include 'displayName' and 'email' in userFields to have them returned.

Example 2: Preview changes without saving

Set userId, set speculative to true, optionally configure profileFields for fields to preview, and optionally specify userFields to control returned fields.

Example 3: Delete a field from user extended data

Add an entry to fieldDeletions with dataType 'publicData' and fieldPath 'publicData.someField' for the target user ID.

Links

Discussion