Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Listing → Update

AI-generated

Summary

Update a ShareTribe listing with selected fields, optionally returning a simplified response

Inputs

  • simplify — Whether to return a simplified version of the response
  • listingId (required) — ID of the listing to update
  • speculative — Whether to preview the changes without actually updating the listing. Returns what the updated listing would look like.
  • fieldsToReturn — Choose from the list, or specify IDs using an expression.
  • authorFields — Choose from the list, or specify IDs using an expression.
  • listingFields — Add or update fields for the listing.
  • privateData — Private data fields to add or update.
  • publicData — Public data fields to add or update.
  • price — Amount and minor units (e.g., cents for USD).
  • fieldDeletions — Field to delete from extended data.

Output shape

a single listing object

If simplify is true only the selected fields are returned; speculative mode returns a preview without persisting changes; optional fields may be omitted.

Examples

Example 1: Update a listing's title and price, returning simplified response

listingId=550e8400-e29b-41d4-a716-446655440000, simplify=true, fieldsToReturn=["title","price"], listingFields.title="Cozy Studio", listingFields.price.amount=15000, listingFields.price.currency=USD

Example 2: Preview an update without persisting changes

listingId=550e8400-e29b-41d4-a716-446655440000, speculative=true, fieldsToReturn=["title","price"], listingFields.title="Updated Title"

Example 3: Delete a metadata field from the listing

fieldDeletions.deletions.dataType=metadata, fieldDeletions.deletions.fieldPath=metadataValues.mode

Links

Discussion