Skip to main content
PUT
/
partner
/
v1
/
brokers
/
{externalBrokerId}
Create or update broker
curl --request PUT \
  --url https://www.venturu.com/api/partner/v1/brokers/{externalBrokerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "avatarUrl": "<string>",
  "forwardingEmail": "<string>",
  "profile": {
    "bio": "<string>",
    "website": "<string>",
    "linkedInUrl": "<string>"
  },
  "licenses": [
    {
      "licenseNumber": "<string>",
      "state": "<string>",
      "country": "<string>"
    }
  ],
  "serviceAreas": [
    {
      "state": "<string>",
      "country": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "county": "<string>"
    }
  ]
}
'
import requests

url = "https://www.venturu.com/api/partner/v1/brokers/{externalBrokerId}"

payload = {
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "avatarUrl": "<string>",
    "forwardingEmail": "<string>",
    "profile": {
        "bio": "<string>",
        "website": "<string>",
        "linkedInUrl": "<string>"
    },
    "licenses": [
        {
            "licenseNumber": "<string>",
            "state": "<string>",
            "country": "<string>"
        }
    ],
    "serviceAreas": [
        {
            "state": "<string>",
            "country": "<string>",
            "neighborhood": "<string>",
            "city": "<string>",
            "county": "<string>"
        }
    ]
}
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({
    name: '<string>',
    email: '<string>',
    phone: '<string>',
    avatarUrl: '<string>',
    forwardingEmail: '<string>',
    profile: {bio: '<string>', website: '<string>', linkedInUrl: '<string>'},
    licenses: [{licenseNumber: '<string>', state: '<string>', country: '<string>'}],
    serviceAreas: [
      {
        state: '<string>',
        country: '<string>',
        neighborhood: '<string>',
        city: '<string>',
        county: '<string>'
      }
    ]
  })
};

fetch('https://www.venturu.com/api/partner/v1/brokers/{externalBrokerId}', 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/brokers/{externalBrokerId}",
  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([
    'name' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'avatarUrl' => '<string>',
    'forwardingEmail' => '<string>',
    'profile' => [
        'bio' => '<string>',
        'website' => '<string>',
        'linkedInUrl' => '<string>'
    ],
    'licenses' => [
        [
                'licenseNumber' => '<string>',
                'state' => '<string>',
                'country' => '<string>'
        ]
    ],
    'serviceAreas' => [
        [
                'state' => '<string>',
                'country' => '<string>',
                'neighborhood' => '<string>',
                'city' => '<string>',
                'county' => '<string>'
        ]
    ]
  ]),
  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/brokers/{externalBrokerId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"avatarUrl\": \"<string>\",\n  \"forwardingEmail\": \"<string>\",\n  \"profile\": {\n    \"bio\": \"<string>\",\n    \"website\": \"<string>\",\n    \"linkedInUrl\": \"<string>\"\n  },\n  \"licenses\": [\n    {\n      \"licenseNumber\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  ],\n  \"serviceAreas\": [\n    {\n      \"state\": \"<string>\",\n      \"country\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"county\": \"<string>\"\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/brokers/{externalBrokerId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"avatarUrl\": \"<string>\",\n  \"forwardingEmail\": \"<string>\",\n  \"profile\": {\n    \"bio\": \"<string>\",\n    \"website\": \"<string>\",\n    \"linkedInUrl\": \"<string>\"\n  },\n  \"licenses\": [\n    {\n      \"licenseNumber\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  ],\n  \"serviceAreas\": [\n    {\n      \"state\": \"<string>\",\n      \"country\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"county\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"avatarUrl\": \"<string>\",\n  \"forwardingEmail\": \"<string>\",\n  \"profile\": {\n    \"bio\": \"<string>\",\n    \"website\": \"<string>\",\n    \"linkedInUrl\": \"<string>\"\n  },\n  \"licenses\": [\n    {\n      \"licenseNumber\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"<string>\"\n    }\n  ],\n  \"serviceAreas\": [\n    {\n      \"state\": \"<string>\",\n      \"country\": \"<string>\",\n      \"neighborhood\": \"<string>\",\n      \"city\": \"<string>\",\n      \"county\": \"<string>\"\n    }\n  ]\n}"

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
externalBrokerId
string
required

The ID of the broker from your system.

Body

application/json
​
name
string
required

The full name of the broker.

​
email
string
required

The email address of the broker.

​
phone
string | null

The phone number of the broker.

​
avatarUrl
string | null

A URL to the broker's profile picture.

​
forwardingEmail
string | null

If leads should be forwarded to a specific email address (i.e. in case of CRMs), this value can be specified.

​
profile
object | null

Additional profile information about the broker.

​
licenses
object[] | null

A list of licenses held by the broker.

​
serviceAreas
object[] | null

A list of service areas covered by the broker.

Response

Successful response

​
status
enum<string>
required

Indicates that the operation has succeeded.

Available options:
success
​
message
string
required

A message providing additional information about the operation.

​
venturuBrokerId
string | null

The Venturu ID of the created or updated broker, if the operation was successful.

​
venturuProfileUrl
string | null

A URL to the broker's Venturu profile, if the operation was successful.