v1

latestOpenAPI 3.0.02026-07-1352148.0 KB

Partner

Create or update broker

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.

put/partner/v1/brokers/{externalBrokerId}

Path parameters

externalBrokerIdstring required

The ID of the broker from your system.

Request body

namestring required

The full name of the broker.

emailstring required

The email address of the broker.

phonestring nullable

The phone number of the broker.

avatarUrlstring nullable

A URL to the broker's profile picture.

forwardingEmailstring nullable

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

Response

Successful response

status'success' required

Indicates that the operation has succeeded.

messagestring required

A message providing additional information about the operation.

venturuBrokerIdstring nullable

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

venturuProfileUrlstring nullable

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