---
title: "Create or update broker"
method: PUT
path: "/partner/v1/brokers/{externalBrokerId}"
tags: ["Partner"]
---

# Create or update broker

`PUT /partner/v1/brokers/{externalBrokerId}`

Create or update a broker in Venturu's system. If the broker with the specified external ID already exists, their information will be updated. If not, a new broker will be created.

## Path parameters

- `externalBrokerId` string, required — The ID of the broker from your system.

## Request body

- PutBrokerRequestSchema
  - `name` string, required — The full name of the broker.
  - `email` string, required — The email address of the broker.
  - `phone` string, nullable — The phone number of the broker.
  - `avatarUrl` string, nullable — A URL to the broker's profile picture.
  - `forwardingEmail` string, nullable — If leads should be forwarded to a specific email address (i.e. in case of CRMs), this value can be specified.
  - `profile` object, nullable — Additional profile information about the broker.
    - `bio` string, nullable — A short biography of the broker.
    - `website` string, nullable — The broker's personal or professional website.
    - `linkedInUrl` string, nullable — The broker's LinkedIn profile URL.
  - `licenses` object[], nullable — A list of licenses held by the broker.
    - `licenseNumber` string, required — The license number of the broker.
    - `state` string, required — The state where the license is valid. It is recommended that this is specified as the full name of the state.
    - `country` string, required — The country where the license is valid. It is recommended that this is specified as a two-letter ISO country code.
  - `serviceAreas` object[], nullable — A list of service areas covered by the broker.
    - `neighborhood` string, nullable — The neighborhood served by the broker.
    - `city` string, nullable — The city served by the broker.
    - `county` string, nullable — The county served by the broker.
    - `state` string, required — The state served by the broker. It is recommended that this is specified as the full name of the state.
    - `country` string, required — The country served by the broker. It is recommended that this is specified as a two-letter ISO country code.

## Response `200`

Successful response

- PutBrokerResponseSchema
  - `status` 'success', required — Indicates that the operation has succeeded.
  - `message` string, required — A message providing additional information about the operation.
  - `venturuBrokerId` string, nullable — The Venturu ID of the created or updated broker, if the operation was successful.
  - `venturuProfileUrl` string, nullable — A URL to the broker's Venturu profile, if the operation was successful.

## Other responses

- `201` — HTTP 201

---

[API](https://skmtc.net/venturu/apis/venturu-api-documentation.md) · [All operations](https://skmtc.net/venturu/apis/venturu-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/venturu/venturu-api-documentation/versions/8f58809101f1/schema)