Client tracker
The stages a client sees on their hub, in the broker's words, and the stages each deal reached.
List tracker stages
The stages of the client tracker, in order. The tracker belongs to the team that the key acts in, and every deal of that team shows these stages to its client. The list is not paginated: a tracker has at most 60 stages.
List tracker stages › Responses
Success
successAlways true on a successful response.
Every stage of the tracker, in order.
Add a tracker stage
Adds a stage at the end of the tracker. If the team removed a stage with the same key, this brings it back, with the dates deals reached it. The client sees the new stage on every deal of the team at once, so a key with the no_sending limit cannot do this.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add a tracker stage › Request Body
labelThe stage name that the client reads. 1 to 60 characters.
descriptionThe sentence under the stage. Up to 240 characters.
client_noteThe note from the broker while the deal is at this stage. Up to 1000 characters.
board_stage_keysThe pipeline stage keys that match this stage. Up to 40. Defaults to none.
Add a tracker stage › Responses
Success
successAlways true on a successful response.
The requested record.
Update the tracker note
Sets the note that the client's hub shows at a stage that has no note of its own. The client sees it at once, so a key with the no_sending limit cannot do this.
Update the tracker note › Request Body
noteThe new note. Up to 1000 characters. Null or an empty string removes it.
Update the tracker note › Responses
Success
successAlways true on a successful response.
The requested record.
Reorder tracker stages
Sets the order of every stage of the tracker. Send every stage id once. Returns the stages in the new order. The client sees the new order at once, so a key with the no_sending limit cannot do this.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Reorder tracker stages › Request Body
idsEvery stage id of the tracker, in the new order. Send each stage once, and no other id.
Reorder tracker stages › Responses
Success
successAlways true on a successful response.
Every stage of the tracker, in order.
Fill an empty tracker
Adds the standard five stages to a tracker that has none. It never changes a tracker that has a stage. The client sees the stages at once, so a key with the no_sending limit cannot do this.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Fill an empty tracker › Responses
Success
successAlways true on a successful response.
Every stage of the tracker, in order.
Remove a tracker stage
Removes the stage from the tracker of every deal. BrokerPlus keeps the dates deals reached it: add a stage with the same key to bring it back with them.
path Parameters
idResource id.
Remove a tracker stage › Responses
Success
successAlways true on a successful response.
The requested record.
Update a tracker stage
Changes what the client reads, or which pipeline stages match. The key does not change, so the automations that name the stage keep working. The client sees the change at once, so a key with the no_sending limit cannot do this.
path Parameters
idResource id.
Update a tracker stage › Request Body
labelThe new stage name. The key stays the same.
descriptionThe new sentence under the stage. Null removes it.
client_noteThe new note for this stage. Null removes it.
board_stage_keysThe pipeline stage keys that match this stage. Replaces the list.
Update a tracker stage › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a deal's tracker
The client tracker of one deal, as the client sees it: each stage, the day the deal reached it, the note from the broker, and whether the tracker disagrees with the deal's pipeline stage.
path Parameters
idResource id.
Retrieve a deal's tracker › Responses
Success
successAlways true on a successful response.
The requested record.
Show a stage as reached
Shows the stage as reached now, the same as a click on the stage in BrokerPlus. The client sees the stage as reached, with every earlier stage, and the automations and partner updates that start on a reached stage run. The response is the deal's tracker. A key with the no_sending limit cannot do this. Supports Idempotency-Key.
path Parameters
idResource id.
stageIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Show a stage as reached › Request Body optional
reached_on^(?:(?:\d\d[2468][04…The day the deal reached the stage, as YYYY-MM-DD. The client sees this date. Defaults to today. On a stage the deal already reached, this changes its date.
Show a stage as reached › Responses
Success
successAlways true on a successful response.
The requested record.
Take a stage back down
The client no longer sees the stage as reached, and every later stage goes back down with it. BrokerPlus forgets the dates of those stages. This sends nothing and starts no automation, so a key with the no_sending limit can do it. A stage that is not reached stays as it is.
path Parameters
idResource id.
stageIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Take a stage back down › Responses
Success
successAlways true on a successful response.
The requested record.
List the deal's tracker links
The links that still show this deal's tracker to a realtor, a lawyer or someone else outside the brokerage, newest first. BrokerPlus no longer makes these links: a partner now gets one partner hub for every file, with POST /partner-hubs. A link does not include its address, which BrokerPlus never kept.
path Parameters
idResource id.
List the deal's tracker links › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Take back a tracker link
The link stops working at once, as Revoke on the link in BrokerPlus. BrokerPlus keeps it with revoked_at set, so the broker can see it was used. Nobody is told.
path Parameters
idResource id.
linkIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Take back a tracker link › Responses
Success
successAlways true on a successful response.
The requested record.