Skip to main content
PUT
/
partner
/
v1
/
listings
/
{externalListingId}
Create or update listing
curl --request PUT \
  --url https://www.venturu.com/api/partner/v1/listings/{externalListingId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": {},
  "businessType": "<string>",
  "location": {
    "country": "<string>",
    "visibility": {},
    "streetAddress1": "<string>",
    "streetAddress2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "brokerExternalId": "<string>",
  "title": "<string>",
  "description": "<string>",
  "establishedAt": {},
  "financials": {},
  "training": {
    "available": true,
    "description": "<string>",
    "duration": "<string>",
    "cost": 123
  },
  "property": {
    "propertyKind": {},
    "areaSqft": 123,
    "rentData": {
      "frequency": {},
      "amount": 123,
      "leaseRenewable": true,
      "leaseNegotiable": true,
      "leaseExpiration": {},
      "leaseDetails": "<string>"
    },
    "ownedData": {
      "propertyIncludedInPrice": true,
      "propertyAskingPrice": 123,
      "propertyDetails": "<string>"
    }
  },
  "financing": {
    "financingAvailable": true,
    "sbaPrequalified": true,
    "minimumDownPayment": 123,
    "buyerCanAssumeLoan": true
  },
  "photos": [
    {
      "url": "<string>",
      "sortKey": 123
    }
  ]
}
'
import requests

url = "https://www.venturu.com/api/partner/v1/listings/{externalListingId}"

payload = {
    "status": {},
    "businessType": "<string>",
    "location": {
        "country": "<string>",
        "visibility": {},
        "streetAddress1": "<string>",
        "streetAddress2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
    },
    "brokerExternalId": "<string>",
    "title": "<string>",
    "description": "<string>",
    "establishedAt": {},
    "financials": {},
    "training": {
        "available": True,
        "description": "<string>",
        "duration": "<string>",
        "cost": 123
    },
    "property": {
        "propertyKind": {},
        "areaSqft": 123,
        "rentData": {
            "frequency": {},
            "amount": 123,
            "leaseRenewable": True,
            "leaseNegotiable": True,
            "leaseExpiration": {},
            "leaseDetails": "<string>"
        },
        "ownedData": {
            "propertyIncludedInPrice": True,
            "propertyAskingPrice": 123,
            "propertyDetails": "<string>"
        }
    },
    "financing": {
        "financingAvailable": True,
        "sbaPrequalified": True,
        "minimumDownPayment": 123,
        "buyerCanAssumeLoan": True
    },
    "photos": [
        {
            "url": "<string>",
            "sortKey": 123
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: {},
    businessType: '<string>',
    location: {
      country: '<string>',
      visibility: {},
      streetAddress1: '<string>',
      streetAddress2: '<string>',
      city: '<string>',
      state: '<string>',
      postalCode: '<string>'
    },
    brokerExternalId: '<string>',
    title: '<string>',
    description: '<string>',
    establishedAt: {},
    financials: {},
    training: {available: true, description: '<string>', duration: '<string>', cost: 123},
    property: {
      propertyKind: {},
      areaSqft: 123,
      rentData: {
        frequency: {},
        amount: 123,
        leaseRenewable: true,
        leaseNegotiable: true,
        leaseExpiration: {},
        leaseDetails: '<string>'
      },
      ownedData: {
        propertyIncludedInPrice: true,
        propertyAskingPrice: 123,
        propertyDetails: '<string>'
      }
    },
    financing: {
      financingAvailable: true,
      sbaPrequalified: true,
      minimumDownPayment: 123,
      buyerCanAssumeLoan: true
    },
    photos: [{url: '<string>', sortKey: 123}]
  })
};

fetch('https://www.venturu.com/api/partner/v1/listings/{externalListingId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.venturu.com/api/partner/v1/listings/{externalListingId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => [
        
    ],
    'businessType' => '<string>',
    'location' => [
        'country' => '<string>',
        'visibility' => [
                
        ],
        'streetAddress1' => '<string>',
        'streetAddress2' => '<string>',
        'city' => '<string>',
        'state' => '<string>',
        'postalCode' => '<string>'
    ],
    'brokerExternalId' => '<string>',
    'title' => '<string>',
    'description' => '<string>',
    'establishedAt' => [
        
    ],
    'financials' => [
        
    ],
    'training' => [
        'available' => true,
        'description' => '<string>',
        'duration' => '<string>',
        'cost' => 123
    ],
    'property' => [
        'propertyKind' => [
                
        ],
        'areaSqft' => 123,
        'rentData' => [
                'frequency' => [
                                
                ],
                'amount' => 123,
                'leaseRenewable' => true,
                'leaseNegotiable' => true,
                'leaseExpiration' => [
                                
                ],
                'leaseDetails' => '<string>'
        ],
        'ownedData' => [
                'propertyIncludedInPrice' => true,
                'propertyAskingPrice' => 123,
                'propertyDetails' => '<string>'
        ]
    ],
    'financing' => [
        'financingAvailable' => true,
        'sbaPrequalified' => true,
        'minimumDownPayment' => 123,
        'buyerCanAssumeLoan' => true
    ],
    'photos' => [
        [
                'url' => '<string>',
                'sortKey' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.venturu.com/api/partner/v1/listings/{externalListingId}"

	payload := strings.NewReader("{\n  \"status\": {},\n  \"businessType\": \"<string>\",\n  \"location\": {\n    \"country\": \"<string>\",\n    \"visibility\": {},\n    \"streetAddress1\": \"<string>\",\n    \"streetAddress2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"brokerExternalId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"establishedAt\": {},\n  \"financials\": {},\n  \"training\": {\n    \"available\": true,\n    \"description\": \"<string>\",\n    \"duration\": \"<string>\",\n    \"cost\": 123\n  },\n  \"property\": {\n    \"propertyKind\": {},\n    \"areaSqft\": 123,\n    \"rentData\": {\n      \"frequency\": {},\n      \"amount\": 123,\n      \"leaseRenewable\": true,\n      \"leaseNegotiable\": true,\n      \"leaseExpiration\": {},\n      \"leaseDetails\": \"<string>\"\n    },\n    \"ownedData\": {\n      \"propertyIncludedInPrice\": true,\n      \"propertyAskingPrice\": 123,\n      \"propertyDetails\": \"<string>\"\n    }\n  },\n  \"financing\": {\n    \"financingAvailable\": true,\n    \"sbaPrequalified\": true,\n    \"minimumDownPayment\": 123,\n    \"buyerCanAssumeLoan\": true\n  },\n  \"photos\": [\n    {\n      \"url\": \"<string>\",\n      \"sortKey\": 123\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://www.venturu.com/api/partner/v1/listings/{externalListingId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": {},\n  \"businessType\": \"<string>\",\n  \"location\": {\n    \"country\": \"<string>\",\n    \"visibility\": {},\n    \"streetAddress1\": \"<string>\",\n    \"streetAddress2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"brokerExternalId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"establishedAt\": {},\n  \"financials\": {},\n  \"training\": {\n    \"available\": true,\n    \"description\": \"<string>\",\n    \"duration\": \"<string>\",\n    \"cost\": 123\n  },\n  \"property\": {\n    \"propertyKind\": {},\n    \"areaSqft\": 123,\n    \"rentData\": {\n      \"frequency\": {},\n      \"amount\": 123,\n      \"leaseRenewable\": true,\n      \"leaseNegotiable\": true,\n      \"leaseExpiration\": {},\n      \"leaseDetails\": \"<string>\"\n    },\n    \"ownedData\": {\n      \"propertyIncludedInPrice\": true,\n      \"propertyAskingPrice\": 123,\n      \"propertyDetails\": \"<string>\"\n    }\n  },\n  \"financing\": {\n    \"financingAvailable\": true,\n    \"sbaPrequalified\": true,\n    \"minimumDownPayment\": 123,\n    \"buyerCanAssumeLoan\": true\n  },\n  \"photos\": [\n    {\n      \"url\": \"<string>\",\n      \"sortKey\": 123\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://www.venturu.com/api/partner/v1/listings/{externalListingId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": {},\n  \"businessType\": \"<string>\",\n  \"location\": {\n    \"country\": \"<string>\",\n    \"visibility\": {},\n    \"streetAddress1\": \"<string>\",\n    \"streetAddress2\": \"<string>\",\n    \"city\": \"<string>\",\n    \"state\": \"<string>\",\n    \"postalCode\": \"<string>\"\n  },\n  \"brokerExternalId\": \"<string>\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"establishedAt\": {},\n  \"financials\": {},\n  \"training\": {\n    \"available\": true,\n    \"description\": \"<string>\",\n    \"duration\": \"<string>\",\n    \"cost\": 123\n  },\n  \"property\": {\n    \"propertyKind\": {},\n    \"areaSqft\": 123,\n    \"rentData\": {\n      \"frequency\": {},\n      \"amount\": 123,\n      \"leaseRenewable\": true,\n      \"leaseNegotiable\": true,\n      \"leaseExpiration\": {},\n      \"leaseDetails\": \"<string>\"\n    },\n    \"ownedData\": {\n      \"propertyIncludedInPrice\": true,\n      \"propertyAskingPrice\": 123,\n      \"propertyDetails\": \"<string>\"\n    }\n  },\n  \"financing\": {\n    \"financingAvailable\": true,\n    \"sbaPrequalified\": true,\n    \"minimumDownPayment\": 123,\n    \"buyerCanAssumeLoan\": true\n  },\n  \"photos\": [\n    {\n      \"url\": \"<string>\",\n      \"sortKey\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "message": "<string>",
  "venturuListingId": 123,
  "venturuListingUrl": "<string>"
}
{
  "status": "success",
  "message": "<string>",
  "venturuListingId": 123,
  "venturuListingUrl": "<string>"
}

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.