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": [
    {
      "neighborhood": "<string>",
      "city": "<string>",
      "county": "<string>",
      "state": "<string>",
      "country": "<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.