Call lists
Lists of people to phone, worked one row at a time, and the call scripts read on those calls.
List call scripts
The broker's own call scripts, last changed first: the questions the broker reads on a call, in sections. A script the broker retired is not listed.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List call scripts › 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.
Make a call script
Makes a call script on the broker's team, the same as the Scripts pane in BrokerPlus. A question fills nothing in the application: it is a question to ask.
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.
Make a call script › Request Body
nameThe name of the script.
estimated_minutesAbout how long the call takes, in minutes, from 1 to 240.
The sections of the script, in order. At most 20.
descriptionWhat the script is for.
Make a call script › Responses
Success
successAlways true on a successful response.
The requested record.
Retire a call script
Retires the script. It is no longer listed, but a call that already used it still names it. A retired script cannot be changed or brought back.
path Parameters
idResource id.
Retire a call script › Responses
Success
successAlways true on a successful response.
The requested record.
Update a call script
Changes the fields you send. sections replaces every section of the script.
path Parameters
idResource id.
Update a call script › Request Body
nameThe name of the script.
descriptionWhat the script is for.
estimated_minutesAbout how long the call takes, in minutes, from 1 to 240.
The sections of the script, in order. At most 20.
Update a call script › Responses
Success
successAlways true on a successful response.
The requested record.
List call lists
The broker's call lists, last changed first, with how many people are on each and how many are still to call. Read the people with GET /call-lists/{id}/entries.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List call lists › 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.
Make a call list
Makes a call list on the broker's team, with the contacts or deals you name. Add more people later with POST /call-lists/{id}/entries. Nobody is called or sent anything.
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.
Make a call list › Request Body
nameThe name of the list.
The people to put on the list, at most 500. A contact or deal the broker cannot reach is left out, and a person named two times is put on once.
Make a call list › Responses
Success
successAlways true on a successful response.
The requested record.
Rename a call list
Changes the name of the list.
path Parameters
idResource id.
Rename a call list › Request Body
nameThe new name of the list.
Rename a call list › Responses
Success
successAlways true on a successful response.
The requested record.
Make a call list from rows
Makes a call list from rows of names, numbers, and emails, for example the rows of a spreadsheet. Each row is matched to a contact by email, then by number. A row that matches nobody stays on the list only, unless you send add_to_contacts. Read the file yourself and send its rows: this call does not take a file.
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.
Make a call list from rows › Request Body
nameThe name of the new list.
The people on the list, at most 5000, in order. BrokerPlus matches each one to a contact by email, then by number. A row named two times is put on once.
add_to_contactsDefaults to false: a row that matches no contact stays on the list only. With true, BrokerPlus adds each of those rows to the contacts.
Make a call list from rows › Responses
Success
successAlways true on a successful response.
The requested record.
List the people on a call list
The rows of a call list, in the order the broker works them, each with its outcome and note.
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
statusOnly rows with this outcome.
List the people on a call list › 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 people to a call list
Puts contacts, deals, or people typed in by name on the list. A person already on the list is not added again, and their outcome and note stay as they are. A contact or deal the broker cannot reach is left out.
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 people to a call list › Request Body
Contacts or deals to put on the list, at most 500.
People typed in by name, at most 50. BrokerPlus matches each one to a contact by email, then by number. A person who matches nobody is added to the contacts, unless add_to_contacts is false.
Add people to a call list › Responses
Success
successAlways true on a successful response.
The requested record.
Record a call outcome
Sets the outcome of a row, its note, or both. The outcome is a field, not a step: any outcome can follow any other, as in BrokerPlus.
path Parameters
idResource id.
entry_idResource id.
Record a call outcome › Request Body
statusThe outcome of the call. Any outcome can follow any other, as in BrokerPlus. Leaving pending records who worked the row and when; going back to pending clears both.
noteThe broker's note on the row. Null clears it.
Record a call outcome › Responses
Success
successAlways true on a successful response.
The requested record.