Skip to main content
Glama

QuBe Sync: QuickBooks Desktop API for developers

Update lead

update_lead
Read-onlyIdempotent

Builds a v2 lead.update request.

The lead_mod wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).

Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3100 name_in_use, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3170 cannot_modify, 3175 in_use, 3176 locked, 3200 stale_edit_sequence, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "edit_sequence": "<edit_sequence>",
      "full_name": "<full_name>",
      "list_id": "<list_id>"
    },
    "name": "update_lead"
  }
}

Input Schema

NameRequiredDescriptionDefault
statusNoThe status of the lead.
list_idYesQuickBooks' ID for the record. Used over `full_name` when both are sent.
full_nameYesThe record's name, parents first: `Jones:Kitchen:Cabinets`. Not case-sensitive.
main_phoneNoThe main phone number.
request_idNoYour own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`.
company_nameNoThe name of the QuickBooks user’s business, as specified in QuickBooks. `company_name` and Address are used on invoices, checks, and other forms.
edit_sequenceYes`edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`.
include_qbxmlNoAlso return the qbXML this compiles to, for debugging. Not part of the v2 request.
locations_modNo
lead_contacts_modNo
include_ret_elementNo
additional_contact_refNo

Output Schema

NameRequiredDescriptionDefault
urlYesReplace {connection_id} with the customer's connection.
bodyYesThe JSON body: the arguments you passed.
qbxmlNoThe qbXML it compiles to. Only with include_qbxml.
methodYes
headersYesSend with the request. Resent unchanged when no 201 came back, it answers with the request already queued.
webhookYesJSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and idempotentHint=true, so the safety profile is covered. The description earns credit for disclosing the actual output contract (a v2 request to send, plus the webhook payload where the answer arrives, with its response_json shape and status codes) and for enumerating error codes. It does not explain that the caller must dispatch the returned request, nor any auth/permission preconditions beyond the error names.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose statement and return-value sentence are well front-loaded and tight. The 20-item error-code enumeration with paired numeric codes is bulky and dominates the description's length; it is useful reference material but reads as a reference table rather than guidance an agent needs before invoking the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists and annotations cover safety, so the description need not restate return values, yet it still explains the two-part return (request to send, webhook payload). For a 12-parameter mutation-request builder it is close to complete, with the main gap being no statement of the send-and-await-webhook workflow step or auth requirements.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 67% schema description coverage across 12 parameters, the schema carries most of the semantic load, including edit_sequence, list_id precedence over full_name, and status enum values. The description adds only the detail that the qbXML `lead_mod` wrapper is also accepted, which is genuinely useful input-shape information the schema does not convey. Otherwise it adds nothing about individual parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb and resource: it 'Builds a v2 lead.update request' and returns the request plus the webhook payload for the answer. That is a precise statement of what the tool produces, and it usefully reframes an 'update' tool as a request builder. It does not differentiate itself from siblings such as create_lead or the many other update_* tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use or when-not-to-use guidance, and no alternatives are named. The agent must infer from the name and the phrase 'to modify an existing object' in the schema that this is the path for editing a lead rather than creating one. Nothing states prerequisites such as needing the current edit_sequence.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources