Pipelines
Deal boards and their stages. Resolves a deal's board and stage ids.
List pipelines
The brokerage's deal boards, each with its stages in order. This is how a deal's board_id and stage_id become readable.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
List pipelines › 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.
Create a pipeline
Adds a pipeline to your team, the same as Add pipeline in BrokerPlus. The key's broker owns it. Without stages, it starts with the standard stages. The new pipeline goes after your team's other pipelines.
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.
Create a pipeline › Request Body
nameWhat the brokerage calls the pipeline.
descriptionFree-text note on what the pipeline is for.
allowed_deal_typesDeal types that land on this pipeline by default. Omit it for no preference.
The stages, in order. Omit it to start with the standard stages.
Create a pipeline › Responses
Success
successAlways true on a successful response.
The requested record.
Delete a pipeline
Removes a pipeline, the same as Delete in BrokerPlus. When deals are on the pipeline, BrokerPlus refuses the delete unless you send archive_deals=true. With it, the deals go to the archive with the pipeline, the same as when a broker confirms the delete. You cannot delete the broker's last pipeline.
path Parameters
idResource id.
query Parameters
archive_dealsSend true to archive the deals on the pipeline with it. Without it, a pipeline that has deals is not deleted.
Delete a pipeline › Responses
Success
successAlways true on a successful response.
The requested record.
Update a pipeline
Changes the name, description, or default deal types of a pipeline. Use the stage endpoints for its stages.
path Parameters
idResource id.
Update a pipeline › Request Body
nameWhat the brokerage calls the pipeline.
descriptionFree-text note. Send null to clear it.
allowed_deal_typesDeal types that land on this pipeline by default. Send an empty list for no preference.
Update a pipeline › Responses
Success
successAlways true on a successful response.
The requested record.
Put pipelines in order
Sets the order of your team's pipelines, the same as a drag of the pipeline tabs. A new deal lands on the first pipeline that accepts its type, so the order also changes where new deals go. Returns the pipelines in the new order.
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.
Put pipelines in order › Request Body
idsEvery pipeline id of your team, in the new order. The first pipeline that accepts a deal type is where a new deal of that type lands.
Put pipelines in order › 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.
Add a stage to a pipeline
Adds a column to a pipeline. A key of an archived stage restores that stage, so the deals that name it show in it again. Returns the pipeline.
path Parameters
idResource 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.
Add a stage to a pipeline › Request Body
key^[a-z0-9_-]+$ · requiredMachine-readable slug, unique within the pipeline. You cannot change it later. A key of an archived stage restores that stage.
labelDisplay name shown to brokers.
descriptionWhat is true of a deal in this stage, in the brokerage's words.
color^#[0-9a-fA-F]{6}$Swatch for the column, as a hex color.
positionOrder within the pipeline. Omit it to add the stage after the last one.
exclude_from_booktrue for a stage that holds paid-out mortgages. Defaults to false.
stops_automated_outreachtrue stops all automated messages to the clients of a deal in this stage. Only a broker who can change automations can set it. Defaults to false.
The full list of what a deal must have before it can move into the stage. It replaces the list the stage has. Send an empty list to require nothing more than the earlier stages.
Add a stage to a pipeline › Responses
Success
successAlways true on a successful response.
The requested record.
Put a pipeline's stages in order
Sets the order of the columns of a pipeline. Send every stage of the pipeline. Returns the pipeline.
path Parameters
idResource 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.
Put a pipeline's stages in order › Request Body
idsEvery stage id of this pipeline, in the new order, first to last.
Put a pipeline's stages in order › Responses
Success
successAlways true on a successful response.
The requested record.
Delete a stage
Archives a column of a pipeline. BrokerPlus refuses it while an active deal is in the stage: move those deals first. To restore the stage, add a stage with the same key.
path Parameters
idResource id.
stage_idResource id.
Delete a stage › Responses
Success
successAlways true on a successful response.
The requested record.
Update a stage
Changes a column of a pipeline, and what a deal must have before it can move into it. requirements replaces the full list. GET /deals/{id}/stage-requirements shows what a deal still needs. Returns the pipeline.
path Parameters
idResource id.
stage_idResource id.
Update a stage › Request Body
labelDisplay name shown to brokers.
descriptionWhat is true of a deal in this stage. Send null to clear it.
color^#[0-9a-fA-F]{6}$Swatch for the column, as a hex color. Send null to clear it.
exclude_from_booktrue for a stage that holds paid-out mortgages.
stops_automated_outreachtrue stops all automated messages to the clients of the deals in this stage, including the deals in it now. false starts them again. Only a broker who can change automations can change it.
The full list of what a deal must have before it can move into the stage. It replaces the list the stage has. Send an empty list to require nothing more than the earlier stages.
Update a stage › Responses
Success
successAlways true on a successful response.
The requested record.