Business & Operations

BoldTrail BackOffice

by Inside Real Estate

Overview

Use BoldTrail BackOffice to track real estate transactions, send documents for e-signature, and keep checklists and commissions moving through the connected BoldTrail BackOffice integration.

Tools

add_transaction_checklist

ChatGPT

Add a checklist to the transaction

add_transaction_checklists

ChatGPT

Add multiple checklists to the transaction

add_transaction_comment

ChatGPT

Add a comment to a transaction

add_transaction_task_comment

ChatGPT

Add task's comment

app__get_document_viewer_data

ChatGPT

Called by the Document viewer app, never by you. Returns document metadata and a temporary file URL.

app__get_signature_package_editor_data

ChatGPT

Called by the signature editor, never by you. Returns a package's forms, fields, roles and file URLs.

app__save_signature_package_markup

ChatGPT

Called by the signature editor, never by you. Saves its field and signature-box layout.

apply_buyer_offer_checklist_template

ChatGPT

Add a checklist template's tasks to the buyer offer. By default tasks are appended, so applying the same template twice duplicates them. With replace_todo_tasks: true the existing To Do tasks and their comments are deleted first.

apply_commission_plan

ChatGPT

Apply commission plan

approve_review_document

ChatGPT

Approve a document submitted for review, at the first or the second review stage. Without finalize the decision is a draft: nothing is emailed and it can still be changed; send_reviewed_email makes it final. With finalize: true it is final at once, with no email. Returns nothing on success; read the task again to see its new status. Follow the review guidance (skill://review-transaction-documents/SKILL.md, or guide_for_review_transaction_documents) before deciding.

approve_task_exemption

ChatGPT

Approve a task's request to waive its document requirement. Without finalize the decision is a draft: nothing is emailed and it can still be changed; send_reviewed_email makes it final. With finalize: true it is final at once, with no email. Returns nothing on success; read the task again to see its new status.

assign_commission_plan_to_user

ChatGPT

Assing commission plan to user

assign_document_to_transaction_task

ChatGPT

Attach a document that is already in the transaction to a checklist task, satisfying that task's document requirement. The document has to exist first - upload it, or create it from a library template found with search_library_documents. A task holds one document at a time; unassign_transaction_task_document frees it.

complete_buyer_offer_task

ChatGPT

Complete task

complete_transaction_task

ChatGPT

Mark a checklist task complete. It succeeds only once the task already meets its requirements (a document attached if one is required, and no review still pending), so this is the last step, never the first. When the task has no document yet, do NOT simply ask the user to upload one. Read the task first: if it carries required_document_ids, expand them with get_transaction_checklist_task and include=required_documents to learn what is actually wanted, and say so by name. Then offer the routes that fit, without assuming which the user needs - attach a file they already have (upload it, then assign_document_to_transaction_task), or start from a matching library template found with search_library_documents, following the create_signature_package guidance when the document needs signatures. When no document should be needed at all, request_task_exemption is the honest answer.

convert_document_to_signature_package

ChatGPT

Turn a document that is already in the transaction into the signature package itself, so signature boxes can be placed on it and it can be sent for electronic signature. The document keeps its id, its name and its place.

create_buyer_offer

ChatGPT

Creates new buyer offer API to create new buyer offer. Call get_schema_for_buyer_offers first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

create_contact

ChatGPT

Creates a BoldTrail BackOffice contact. Account custom fields are passed flat, one top-level key per field, keyed by the field uid. Call get_schema_for_contacts first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

create_incoming_transaction

ChatGPT

Add incoming transactions Create or update incoming transactions.<br/> Update will happen in case incoming transaction with the same external_id and source_id already exists.<br/> Note: if existing transaction was already accepted of declined, its updates will be ignored.

create_signature_package

ChatGPT

Use this when the user wants to send documents for electronic signature and they are not a signature package yet. You have to consult the create_signature_package guidance before this tool, - it carries the required flow and its irreversible steps. If you can load Agent Skills from this server, load the create-signature-package skill (skill://create-signature-package/SKILL.md); otherwise call guide_for_create_signature_package. Never call this tool without that guidance. Create a NEW signature package document from one or more existing documents. Returns the package's document_id, which every other signature-package tool takes as its document_id argument.

create_transaction

ChatGPT

Use this when the user wants to add a new deal (listing, purchase or lease) to BoldTrail BackOffice. Creates a BoldTrail BackOffice transaction (real estate deal). You have to consult the create_transaction guidance before this tool - it gives the correct status, representing sides, and the account's real, account-specific fields with their requirements. If you can load Agent Skills from this server, load the create-transaction skill (skill://create-transaction/SKILL.md); otherwise call guide_for_create_transaction. Never call this tool without that guidance. Call get_schema_for_transactions first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

create_transaction_checklist_task

ChatGPT

Create a new tasks in specified transaction checklists

create_user

ChatGPT

Create user Call get_schema_for_users first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

delete_buyer_offer

ChatGPT

Permanently deletes buyer offer Permanently deletes buyer offer and all associated with it data including documents. In most of the cases updating buyer offer state to "withdrawn" is preferable to deletion.

delete_contact

ChatGPT

Remove contact by ID

delete_transaction

ChatGPT

Delete transaction by ID

delete_transaction_checklist

ChatGPT

Delete checklist by ID

delete_transaction_checklist_task

ChatGPT

Remove taks by ID

delete_transaction_contact_participant

ChatGPT

Remove contact from transaction

delete_transaction_document

ChatGPT

Remove transaction's document

delete_transaction_user_participant

ChatGPT

Remove user from transaction

fill_document_package_fields

ChatGPT

Use this when the user wants a signature package's fields filled in. Writes values into a document (signature, esign) package fillable fields. Refuses once the package is sent for signature or signed. You have to consult the fill_document_package_fields guidance before this tool. If you can load Agent Skills from this server, load the fill-document-package-fields skill (skill://fill-document-package-fields/SKILL.md)

finalize_transaction_commissions

ChatGPT

Finalize transaction commissions

get_account_details

ChatGPT

Get account by ID

get_buyer_offer

ChatGPT

Get buyer offer by ID

get_buyer_offer_document

ChatGPT

Get buyer offer's document

get_buyer_offer_task

ChatGPT

Get task by ID

get_closed_transaction_fields_schema

ChatGPT

Get specific closed/cancelled transaction fields schema Once the transaction is closed or cancelled, it's schema is archived and remains the same even though it's updated in account settings. For active transaction this schema equals the one you get from get_schema_for_transactions

get_commission_plan

ChatGPT

Get commission plan by ID

get_contact

ChatGPT

Get contact by ID

get_contact_fields

ChatGPT

Get contact fields

get_contact_lead_sources

ChatGPT

Get contact lead sources

get_contact_types

ChatGPT

Get contact types

get_current_user_details

ChatGPT

Get current user details

get_document_package_fields

ChatGPT

Use this when you need a signature package's fillable fields or their current values. Returns fillable package fields by document, including geometry, values and bindings. Works in any package state. First consult guide_for_fill_document_package_fields or use skill://fill-document-package-fields/SKILL.md.

get_document_page_ranges

ChatGPT

Identify the source documents and their page ranges within a multi-page document package. Use when has_package is true. A package may preserve the boundaries of the separate documents from which it was built and identify appended e-sign audit trail pages. Each range gives the source document's name with its first and last page in the package; the range named e-sign audit trail is the pages added after signing. Refused when the boundaries cannot be determined.

get_document_rejection_reasons

ChatGPT

Get document rejection reasons

get_email_templates

ChatGPT

Get email templates

get_field_clauses

ChatGPT

Returns approved clauses for one document package field. Fields with clauses include clauses_count in get_document_package_fields.

get_general_ledger_transaction

ChatGPT

Get General Ledger Transaction by ID

get_incoming_transaction

ChatGPT

Get incoming transaction by ID

get_onboarding_checklist_assignees

ChatGPT

Get onboarding checklist assignees

get_report

ChatGPT

Retrieve report data Note: Report data is limited. The maximum number of rows returned is not more than 1000 All query parameters except timezone are filters (see Report Filters above), in a form field=filter_value Below we show reference set of parameters which covers all data types so it'll be clear how to use them.

get_schema_for_buyer_offers

ChatGPT

Get current buyer offers schema Returns the buyer offer fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means. You pass a field to a write tool as a flat top-level argument keyed by its uid, but when you read a record back that same field appears keyed by its label. They are the same field; use an entry's uid/label pair to connect the two.

get_schema_for_contacts

ChatGPT

Get current contacts schema Returns the contact fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means. You pass a field to a write tool as a flat top-level argument keyed by its uid, but when you read a record back that same field appears keyed by its label. They are the same field; use an entry's uid/label pair to connect the two.

get_schema_for_transactions

ChatGPT

Get current transactions schema Returns the transaction fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means. You pass a field to a write tool as a flat top-level argument keyed by its uid, but when you read a record back that same field appears keyed by its label. They are the same field; use an entry's uid/label pair to connect the two.

get_schema_for_users

ChatGPT

Get current account's user field schema Returns the user fields configured for the account, both built-in and account level custom ones. Each entry describes one field — see the response schema for what each key means. You pass a field to a write tool as a flat top-level argument keyed by its uid, but when you read a record back that same field appears keyed by its label. They are the same field; use an entry's uid/label pair to connect the two.

get_signature_package

ChatGPT

Read a signature package: its documents in order, its roles with the contacts bound to them, and a derived readiness block saying whether the package can still be edited and what is still missing before it can be sent. ALWAYS call this before acting on an existing package - readiness.blocking tells you what remains, so you never have to track wizard state yourself. document_id is the id create_signature_package returned.

get_transaction

ChatGPT

Get transaction by ID

get_transaction_checklist

ChatGPT

Get transaction checklist by ID

get_transaction_checklist_task

ChatGPT

One checklist task in full. required_document_ids names the library documents this task requires, as bare ids; pass include=required_documents to get each one by name, with the library it comes from, including whether that library is open to the caller (is_access_allowed). An id with no matching entry is deleted or sits in a library the caller cannot reach.

get_transaction_commission_info

ChatGPT

Get commission info

get_transaction_contact_participant

ChatGPT

Get contact-participant by Contact ID

get_transaction_document

ChatGPT

One document of a transaction: its name, page count, content type, review and e-sign state, and url, a link to download the file itself. The link works for 15 minutes; call again for a fresh one. url is null while the file is still being processed.

get_transaction_new_offer_link

ChatGPT

Get new offer link

get_transaction_offer

ChatGPT

Get offer by ID

get_transaction_offer_attachment

ChatGPT

Get offer attachment by ID

get_transaction_roles

ChatGPT

Get transaction roles

get_transaction_types

ChatGPT

Get transaction types

get_transaction_user_participant

ChatGPT

Get user-participants by user ID

get_user

ChatGPT

Get user by ID

get_user_permissions

ChatGPT

Get user permissions

guide_for_create_signature_package

ChatGPT

Use this before sending a document for signature - returns the required guidance for create_signature_package. Use the create-signature-package skill (skill://create-signature-package/SKILL.md) instead of calling if you can.

guide_for_create_transaction

ChatGPT

Use this before creating a transaction - returns the required guidance for create_transaction. Use the create-transaction skill (skill://create-transaction/SKILL.md) instead of calling if you can.

guide_for_fill_document_package_fields

ChatGPT

Use this before reading or filling a signature package's fields - returns the required guidance for get_document_package_fields and fill_document_package_fields. Use the fill-document-package-fields skill (skill://fill-document-package-fields/SKILL.md) instead of calling if you can.

guide_for_review_transaction_documents

ChatGPT

Use this before reviewing, approving or rejecting documents submitted for review - returns the required guidance for the review tools and for checking a document's content. Use the review-transaction-documents skill (skill://review-transaction-documents/SKILL.md) instead of calling if you can.

guide_for_upload_document

ChatGPT

Use this before adding a document to a transaction - returns the required guidance for choosing between the three upload tools. Use the upload-document skill (skill://upload-document/SKILL.md) instead of calling if you can.

list_accounts

ChatGPT

The BoldTrail BackOffice accounts - companies (brokerages, offices, branches, locations) - this user belongs to and may act in, with the numeric id each one takes as account_id. The way to get that id when the server instructions do not list the accounts.

list_activities

ChatGPT

List available activities in account The fields of the response are dynamic and limited by at most 200 records. Following parameters allow to paginate and filter the output.

list_all_transaction_tasks

ChatGPT

Every task in one transaction, across all of its checklists — any assignee, any status. Each task carries its status, its comments (newest first), its document requirements, and the document it holds, if any.

list_buyer_offer_checklist_templates

ChatGPT

List available checklist templates

list_buyer_offer_documents

ChatGPT

Get list of buyer offer's documents

list_buyer_offer_tasks

ChatGPT

Get list of tasks

list_buyer_offers

ChatGPT

List available buyer offers The resulting list will be limited by at most 1000 records. Followig parameters allow to paginate and filter the output.

list_commission_plans

ChatGPT

List of available commission plans

list_contacts

ChatGPT

List available contacts in account Contacts the calling user can see, ordered by id. Each contact has its name, email and contact type; with full_info=1 it also has phone, address, assignee and the account's custom fields, flat (one top-level key per field, keyed by field label). The resulting list will be limited by at most 1000 records.

list_deleted_general_ledger_transactions

ChatGPT

List Deleted General Ledger Transactions

list_deleted_transactions

ChatGPT

List Deleted Transactions

list_general_ledger_account_groups

ChatGPT

Groups of the chart of accounts with id, name and type; resolves a general ledger account's group_id.

list_general_ledger_accounts

ChatGPT

Chart of accounts: active general ledger accounts with id, number, name, type and group_id.

list_general_ledger_transactions

ChatGPT

List General Ledger Transactions

list_incoming_transactions

ChatGPT

List available incoming transactions The resulting list will be limited by at most 1000 records. Following parameters allow to paginate and filter the output.

list_my_incomplete_transaction_tasks

ChatGPT

The calling user's own to-do list: incomplete tasks assigned to them, across all active transactions they participate in. Caller-scoped — a different user gets a different list from the same arguments. Cannot be filtered by transaction; use list_all_transaction_tasks for that. Earliest deadline first, at most 200 (truncation is not marked).

list_onboarding_checklist_templates

ChatGPT

List of available onboarding's checklists templates

list_pending_review_documents

ChatGPT

Use this when the user wants to review, approve or reject documents submitted for review. The review queue of the calling user: one row per transaction with something to decide, holding the documents waiting for review (review_document_ids) and the tasks asking for an exemption (exempted_tasks_ids). Only the review stages the caller may decide are returned. You have to consult the review guidance before working the queue - it gives the work order, how to read a document, and how to judge its content. If you can load Agent Skills from this server, load the review-transaction-documents skill (skill://review-transaction-documents/SKILL.md); otherwise call guide_for_review_transaction_documents.

list_report_filters

ChatGPT

List of filters and available filter options for specified report

list_reports

ChatGPT

List available reports in account

list_transaction_checklist_tasks

ChatGPT

Every task in one checklist of a transaction — any assignee, any status.

list_transaction_checklist_templates

ChatGPT

List available checklist templates

list_transaction_checklists

ChatGPT

List of available transaction's checklists

list_transaction_comments

ChatGPT

List of transaction's comments

list_transaction_commission_items

ChatGPT

Get the list of transaction commission items

list_transaction_contact_participants

ChatGPT

List of contact-participants

list_transaction_documents

ChatGPT

List the documents attached to a transaction. File URLs are not included — call get_transaction_document for the one document you need to download.

list_transaction_offers

ChatGPT

List available offers in transaction

list_transaction_participants

ChatGPT

List of transaction participants

list_transaction_task_comments

ChatGPT

List of task's comments

list_transaction_user_participants

ChatGPT

List of user-participants

list_transactions

ChatGPT

List available transactions The resulting list will be limited by at most 1000 records. Following parameters allow to paginate and filter the output.

list_user_commission_plans

ChatGPT

List commission plans assigned to user

list_users

ChatGPT

List available users in account The resulting list will be limited by at most 1000 records. Followig parameters allow to paginate and filter the output.

move_buyer_offer_task_to_in_progress

ChatGPT

Move task to "in progress"

move_buyer_offer_task_to_todo

ChatGPT

Move task to "todo"

reject_review_document

ChatGPT

Reject a document submitted for review, at the first or the second review stage. comment is required and is what the submitter reads. Without finalize the decision is a draft: nothing is emailed and it can still be changed; send_reviewed_email makes it final. With finalize: true it is final at once, with no email. Returns nothing on success; read the task again to see its new status. Follow the review guidance (skill://review-transaction-documents/SKILL.md, or guide_for_review_transaction_documents) before deciding.

reject_task_exemption

ChatGPT

Reject a task's request to waive its document requirement. comment is required and is what the submitter reads. Without finalize the decision is a draft: nothing is emailed and it can still be changed; send_reviewed_email makes it final. With finalize: true it is final at once, with no email. Returns nothing on success; read the task again to see its new status.

rename_transaction_document

ChatGPT

Rename document Allows to change existing document name

replace_transaction_commission_items

ChatGPT

Replace transaction commission items

request_buyer_offer_task_exemption

ChatGPT

Ask an approver to waive a buyer offer task's document requirement, for a task where no document should be needed at all. The request goes to another person for a decision and is recorded in the buyer offer's activity. This is not a way around a document that is genuinely required.

request_task_exemption

ChatGPT

Ask an approver to waive a task's document requirement, for a task where no document should be needed at all. This is not a way around a document that is genuinely required - see complete_transaction_task for the routes to produce one.

resend_signature_request

ChatGPT

Email an already-sent signature request again to one signer who has not signed yet - the usual answer to "they never got it". This does NOT change the document, the signature boxes, or the signer list: it re-delivers the same email to the same address. signer_email and signer_name must match the values the request was SENT with, character for character - read them from the document's esign signers, not from a contact you rebound afterwards.

revoke_document_approval

ChatGPT

Undo a review decision and put the document back to waiting for review, one step back. Works on an approval, draft or final, and on a rejection that is still a draft; a final rejection is undone by resubmitting the document with submit_document_for_review, after which it can be approved or rejected again. A second-stage decision returns to waiting for the second review, and a document waiting for the second review returns to the first stage, which needs the first-stage review permission. Returns nothing on success; read the task again to see its new status.

revoke_task_exemption

ChatGPT

Undo an approved exemption. The task returns from done to exemption requested and needs an approver decision again.

search_buyer_offers

ChatGPT

Search buyer offer

search_contacts

ChatGPT

Search contacts

search_library_documents

ChatGPT

Search the account's document libraries for a blank template - a listing agreement, a disclosure, a referral agreement. Reach for this whenever a document is needed and none exists yet: to satisfy a checklist task that requires one, or to build a signature package. keyword is REQUIRED and matches document names: every whitespace-separated word must appear in the name, in any order, case-insensitively. There is no way to list everything - the libraries are far too large. Returns each match with its library and folder

search_transactions

ChatGPT

Search transaction

search_users

ChatGPT

Search users

send_reviewed_email

ChatGPT

Finalize the reviewer's pending (not yet sent) approve and reject decisions on every task of a transaction, and email the outcome. Draft decisions become final, and approved document tasks move to complete. The email goes to the transaction owner and to each cc user or contact. Contacts are people outside the account, and the email includes notes and each rejected task's latest comment. Call this after approve or reject calls made without finalize. Returns nothing on success; read the tasks again to see their new statuses.

send_signature_request

ChatGPT

Send a prepared signature package for electronic signature. IRREVERSIBLE: this emails every signer immediately and cannot be undone. Confirm the signer list with the user first. Call get_signature_package first and clear readiness.blocking: a signing role with no contact bound is SILENTLY SKIPPED at send time and its signature boxes are discarded, so the document goes out missing those signatures with no error reported. Draft the email with the user and pass email_template unless they want the standard wording. Once sent, the package rejects all edits.

split_transaction_document

ChatGPT

Cut one page range out of a transaction PDF into a new document; call once per piece. The original remains unchanged. The new document goes to the transaction's unsorted documents, or straight onto the checklist task given in task_id. When the PDF has_package, call get_document_page_ranges first to learn where each document inside it begins and ends.

submit_checklist_documents_for_review

ChatGPT

Submit for review, at once, every document in one checklist of a transaction that is attached to a task requiring it and is not yet approved or waiting for review. Emails the account users who review documents, and records the submission in the transaction's activity, which public transaction share links show to people outside the account. Returns nothing on success; read the tasks again to see their new statuses.

submit_document_for_review

ChatGPT

Submit one document, attached to a checklist task, for review. The task moves to waiting for review, the reviewers see it in their review queue, and the submission is recorded in the transaction's activity, which public transaction share links show to people outside the account. Also resubmits a document after a final rejection. Returns nothing on success; read the task again to see its new status.

unassign_commission_plan_from_user

ChatGPT

Unassign commission plan from user

unassign_transaction_task_document

ChatGPT

Unassign task's document

uncomplete_transaction_task

ChatGPT

Mark task as incomplete Transitions the task from 'complete' status back to 'todo' status. This allows reopening a previously completed task.

update_buyer_offer

ChatGPT

Updates buyer offer Allows to update existing buyer offer Update will affect only specified fields, all other fields will be preserve their values. Call get_schema_for_buyer_offers first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

update_buyer_offer_participants

ChatGPT

Update buyer offer participants

update_contact

ChatGPT

Updates a BoldTrail BackOffice contact. Only the specified attributes are updated. Account custom fields are passed flat, one top-level key per field, keyed by the field uid. Call get_schema_for_contacts first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

update_signature_package_documents

ChatGPT

Set which documents a signature package contains and in what order. Send the COMPLETE ordered list of document ids every time - it REPLACES the current list, so any id you leave out is removed from the package, and the array order becomes the page order of the combined document. Call get_signature_package first to read the current list. Rejected once the package has been sent for signature or signed.

update_signature_package_roles

ChatGPT

Set the roles of a signature package - who signs, who is only referenced by merge fields, and which contact or user is bound to each. Send the COMPLETE role list every time: it REPLACES the current one, and a role you leave out is deleted along with its signature boxes. Call get_signature_package first, echo back the roles you are keeping (including their identifier), and send identifier: null for roles you are adding. A signing role with no contact_ref is silently skipped at send time, so bind every signer before sending. Rejected once the package has been sent or signed.

update_transaction

ChatGPT

Updates transaction Allows to update existing transaction Update will affect only specified fields, all other fields will be preserve their values. \ updated_at and created_at are read-only fields* Call get_schema_for_transactions first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

update_transaction_checklist

ChatGPT

Updates checklist name Allows to update existing checklist name

update_transaction_checklist_task

ChatGPT

Update task

update_transaction_comment

ChatGPT

Update a comment

update_transaction_contact_participant

ChatGPT

Update contact participation

update_transaction_task_comment

ChatGPT

Update task's comment

update_transaction_user_participant

ChatGPT

Update user participation

update_user

ChatGPT

Update user Call get_schema_for_users first. Pass this account's fields as extra top-level arguments keyed by each entry's uid; they are not listed in this tool's inputSchema.

update_user_permissions

ChatGPT

Update user permissions

upload_document_to_buyer_offer_by_sending_file_bytes

ChatGPT

Attach a document to a buyer offer by uploading its bytes yourself, in two steps: (1) call this tool to get a short-lived signed upload URL; (2) send the file to that URL as an HTTP multipart/form-data POST with a form field named file (e.g. curl -F "file=@document.pdf" "<signed_url>"). PRECONDITION: you can make outbound HTTP requests to arbitrary external URLs (agents with shell or network access can; fully sandboxed agents with no external network cannot). This is currently the ONLY way to upload a buyer-offer document: unlike transactions, buyer offers have no public-URL upload and no interactive file-picker widget.

upload_document_to_transaction_by_sending_file_bytes

ChatGPT

Use this when the user wants to add a document to a transaction and you hold the file's bytes but no public URL. Attach a document to a transaction by uploading its bytes yourself, in two steps: (1) call this tool to get a short-lived signed upload URL; (2) send the file to that URL as an HTTP multipart/form-data POST with a form field named file (e.g. curl -F "file=@document.pdf" "<signed_url>"). PRECONDITION: you can make outbound HTTP requests to arbitrary external URLs -- agents with shell or network access can; sandboxed agents with no outbound network cannot, and MUST use upload_document_to_transaction_via_file_picker_app instead. This is one of THREE ways to add a transaction document; use it when you have the file's bytes but no public URL. Pass task_id to file the document on a checklist task; omit it and the document lands in the transaction's Unsorted folder. You have to consult the upload guidance before this tool -- it gives the choice between the three upload tools, the client limits that rule some of them out, and how to file the document on a task. If you can load Agent Skills from this server, load the upload-document skill (skill://upload-document/SKILL.md); otherwise call guide_for_upload_document.

upload_document_to_transaction_using_public_url

ChatGPT

Use this when the user wants to add a document to a transaction and you have a public download URL for the file. Attach a document to a transaction from a URL that Brokermint's server downloads for you: you supply a link and the server fetches the file from it. PRECONDITION: you already have, or can produce, a publicly reachable download URL for the file (e.g. a pre-signed S3 link) -- the server must be able to fetch it without authentication. This is one of THREE ways to add a transaction document, and the one to prefer whenever a public URL exists. Pass task_id to file the document on a checklist task; omit it and the document lands in the transaction's Unsorted folder. You have to consult the upload guidance before this tool -- it gives the choice between the three upload tools, the client limits that rule some of them out, and how to file the document on a task. If you can load Agent Skills from this server, load the upload-document skill (skill://upload-document/SKILL.md); otherwise call guide_for_upload_document.

upload_document_to_transaction_via_file_picker_app

ChatGPT

Use this when the user wants to add a document to a transaction and you can neither use a public URL nor send the file yourself. Attach a document to a transaction by opening an interactive file-picker widget in the user's client; the HUMAN then picks and uploads the file themselves (this tool never receives file data). Pass task_id to file the document on a checklist task; omit it to drop the document in the transaction's Unsorted folder. PRECONDITION: the client can render MCP UI apps. This is one of THREE ways to add a transaction document: the last resort for most clients, since it forces a manual click even when the user already shared the file with you -- but the ONLY option for a client that cannot make outbound HTTP requests. You have to consult the upload guidance before this tool -- it gives the choice between the three upload tools, the client limits that rule some of them out, and how to file the document on a task. If you can load Agent Skills from this server, load the upload-document skill (skill://upload-document/SKILL.md); otherwise call guide_for_upload_document.

upsert_transaction_contact_participant

ChatGPT

Add / update contact participation

upsert_transaction_user_participant

ChatGPT

Add / update user participation

view_document

ChatGPT

Open a Brokermint document (PDF) in the interactive Document viewer.

view_signature_package

ChatGPT

Open a signature package in the interactive editor so the user can place signature and initial boxes on the pages and fill in merge fields. This is the only way boxes get placed - they are positions on a page, so you must not guess them; hand off here instead. Bind the roles with update_signature_package_roles first when you can - the editor colours the boxes by role - but binding can follow; nothing here waits on it. This call only opens the editor and changes nothing. Box placements the user makes are saved by the editor, not by this call; when the user is done there, it tells you.

void_transaction_checklist

ChatGPT

Void checklist by ID

add_transaction_checklist

Claude

add_transaction_checklists

Claude

add_transaction_comment

Claude

add_transaction_task_comment

Claude

apply_buyer_offer_checklist_template

Claude

apply_commission_plan

Claude

approve_review_document

Claude

approve_task_exemption

Claude

assign_commission_plan_to_user

Claude

assign_document_to_transaction_task

Claude

complete_buyer_offer_task

Claude

complete_transaction_task

Claude

convert_document_to_signature_package

Claude

create_buyer_offer

Claude

create_contact

Claude

create_incoming_transaction

Claude

create_signature_package

Claude

create_transaction

Claude

create_transaction_checklist_task

Claude

create_user

Claude

delete_buyer_offer

Claude

delete_contact

Claude

delete_transaction

Claude

delete_transaction_checklist

Claude

delete_transaction_checklist_task

Claude

delete_transaction_contact_participant

Claude

delete_transaction_document

Claude

delete_transaction_user_participant

Claude

fill_document_package_fields

Claude

finalize_transaction_commissions

Claude

get_account_details

Claude

get_buyer_offer

Claude

get_buyer_offer_document

Claude

get_buyer_offer_task

Claude

get_closed_transaction_fields_schema

Claude

get_commission_plan

Claude

get_contact

Claude

get_contact_fields

Claude

get_contact_lead_sources

Claude

get_contact_types

Claude

get_current_user_details

Claude

get_document_package_fields

Claude

get_document_page_ranges

Claude

get_document_rejection_reasons

Claude

get_email_templates

Claude

get_field_clauses

Claude

get_general_ledger_transaction

Claude

get_incoming_transaction

Claude

get_onboarding_checklist_assignees

Claude

get_report

Claude

get_schema_for_buyer_offers

Claude

get_schema_for_contacts

Claude

get_schema_for_transactions

Claude

get_schema_for_users

Claude

get_signature_package

Claude

get_transaction

Claude

get_transaction_checklist

Claude

get_transaction_checklist_task

Claude

get_transaction_commission_info

Claude

get_transaction_contact_participant

Claude

get_transaction_document

Claude

get_transaction_new_offer_link

Claude

get_transaction_offer

Claude

get_transaction_offer_attachment

Claude

get_transaction_roles

Claude

get_transaction_types

Claude

get_transaction_user_participant

Claude

get_user

Claude

get_user_permissions

Claude

guide_for_create_signature_package

Claude

guide_for_create_transaction

Claude

guide_for_fill_document_package_fields

Claude

guide_for_upload_document

Claude

list_accounts

Claude

list_activities

Claude

list_all_transaction_tasks

Claude

list_buyer_offer_checklist_templates

Claude

list_buyer_offer_documents

Claude

list_buyer_offer_tasks

Claude

list_buyer_offers

Claude

list_commission_plans

Claude

list_contacts

Claude

list_deleted_general_ledger_transactions

Claude

list_deleted_transactions

Claude

list_general_ledger_account_groups

Claude

list_general_ledger_accounts

Claude

list_general_ledger_transactions

Claude

list_incoming_transactions

Claude

list_my_incomplete_transaction_tasks

Claude

list_onboarding_checklist_templates

Claude

list_pending_review_documents

Claude

list_report_filters

Claude

list_reports

Claude

list_transaction_checklist_tasks

Claude

list_transaction_checklist_templates

Claude

list_transaction_checklists

Claude

list_transaction_comments

Claude

list_transaction_commission_items

Claude

list_transaction_contact_participants

Claude

list_transaction_documents

Claude

list_transaction_offers

Claude

list_transaction_participants

Claude

list_transaction_task_comments

Claude

list_transaction_user_participants

Claude

list_transactions

Claude

list_user_commission_plans

Claude

list_users

Claude

move_buyer_offer_task_to_in_progress

Claude

move_buyer_offer_task_to_todo

Claude

reject_review_document

Claude

reject_task_exemption

Claude

rename_transaction_document

Claude

replace_transaction_commission_items

Claude

request_buyer_offer_task_exemption

Claude

request_task_exemption

Claude

resend_signature_request

Claude

revoke_document_approval

Claude

revoke_task_exemption

Claude

search_buyer_offers

Claude

search_contacts

Claude

search_library_documents

Claude

search_transactions

Claude

search_users

Claude

send_reviewed_email

Claude

send_signature_request

Claude

split_transaction_document

Claude

submit_checklist_documents_for_review

Claude

submit_document_for_review

Claude

unassign_commission_plan_from_user

Claude

unassign_transaction_task_document

Claude

uncomplete_transaction_task

Claude

update_buyer_offer

Claude

update_buyer_offer_participants

Claude

update_contact

Claude

update_signature_package_documents

Claude

update_signature_package_roles

Claude

update_transaction

Claude

update_transaction_checklist

Claude

update_transaction_checklist_task

Claude

update_transaction_comment

Claude

update_transaction_contact_participant

Claude

update_transaction_task_comment

Claude

update_transaction_user_participant

Claude

update_user

Claude

update_user_permissions

Claude

upload_document_to_buyer_offer_by_sending_file_bytes

Claude

upload_document_to_transaction_by_sending_file_bytes

Claude

upload_document_to_transaction_using_public_url

Claude

upload_document_to_transaction_via_file_picker_app

Claude

upsert_transaction_contact_participant

Claude

upsert_transaction_user_participant

Claude

view_document

Claude

view_signature_package

Claude

void_transaction_checklist

Claude

Capabilities

InteractiveWrites

Links

Documentation ↗Privacy Policy ↗

App Stats

312

Tools

ChatGPT, Claude

Platforms