Skip to main content
PUT
Create or update listing

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

externalListingId
string
required

The ID of the listing from your system.

Body

application/json
status
object
required
businessType
string
required

The type of business being listed (e.g., 'Restaurant', etc.).

location
object
required

Location information about the business.

brokerExternalId
string | null

The ID of the broker this listing belongs to (from your system). Use this if the broker already exists.

broker
object

A complete broker object to create or update along with the listing. Use this to create both broker and listing in a single call.

title
string | null

A short title for the listing. Note that this title will not be used publicly.

description
string | null

A detailed description of the listing. Note that we may optimize the description based on the listing's overall parameters.

establishedAt
object | null

The date when the business was established (ISO 8601 format).

financials
object | null

Financial details of the listing.

training
object | null

Details about training provided to the new business owner.

property
object | null

Information about a business' property.

financing
object | null

Details about financing options available for the listing.

photos
object[] | null

A list of photos associated with the listing.

Response

Successful response

status
enum<string>
required

Indicates that the operation was successful.

Available options:
success
message
string
required

A message providing additional information about the operation.

venturuListingId
number | null

The Venturu ID of the listing.

venturuListingUrl
string | null

The URL of the listing on Venturu. Note that this field may be missing if we failed to generate a slug for the listing but may show up later.