BlueSuite Developers
MCPTool reference

Leads

BlueSuite MCP tools for leads

See connection and authentication and workflow rules before calling these tools.

Related REST API and behavior.

create_new_lead

Create a brand-new lead in one call: contact + optional property + request, atomically linked. Use this for the common "new inquiry" happy path where all three records are new. For existing contacts, existing properties, or adding another request/property to an existing contact, use the per-entity tools instead (create_contact, create_contact_property, create_request). Property is optional, omit it if the inquiry has no specific service address; the request will be created without a property link. Returns the created contact_id, property_id (or null), request_id, plus the full created request for follow-up calls.

Parameters

FieldType / accepted valuesRequiredDetails
contactobjectYesContact fields for the new lead.
contact.first_namestringWhen parent suppliedFirst name (required)
contact.last_namestringWhen parent suppliedLast name (required)
contact.emailstringNoPrimary email address
contact.phonestringNoPrimary phone number
contact.secondary_emailstringNoSecondary email address
contact.secondary_phonestringNoSecondary phone number
contact.companystringNoCompany name
contact.company_departmentstringNoDepartment within company
contact.company_positionstringNoPosition/title at company
contact.title"mr", "mrs", "miss", "ms", "dr", "prof", "rev"NoHonorific title
contact.type"none", "customer", "lead", "former_customer", "contractor", "partner", "vendor", "other"NoContact type. Default: 'lead' (the typical value for a new inquiry). Omit unless you specifically need a different value. Default: "lead".
contact.owner_idstringNoUUID of the contact owner. Use list_users to resolve names. Format: uuid.
contact.custom_fieldsobjectNoCustom field values
propertyobjectNoOptional property (service address) to create and link to the contact. Omit when the lead has no specific address yet.
property.addressobjectWhen parent suppliedProperty address
property.address.streetstringNoStreet address line 1
property.address.street_2stringNoStreet address line 2
property.address.citystringNoCity
property.address.statestringNoState/province
property.address.postal_codestringNoPostal/zip code
property.address.countrystringNoCountry
property.property_type"single-family", "apartment", "complex", "townhouse", "land", "commercial", "other"NoProperty type. Default: 'single-family'. Omit unless you specifically need a different value. Default: "single-family".
property.role"owner", "tenant", "manager", "agent", "other"NoContact's role for this property. Default: 'owner'. Omit unless you specifically need a different value. Default: "owner".
requestobjectYesService request fields. contact_id and property_id are set automatically.
request.namestringNoRequest name/title
request.assignee_idstringNoUUID of assigned team member. Use list_users to resolve a user name to a UUID. Format: uuid.
request.detailsstringNoRequest details/description
request.assessmentstringNoAssessment notes
request.requested_onstringNoDate the request was made (YYYY-MM-DD)
request.status"new", "responded", "overdue", "converted", "rejected", "archived"NoRequest status. Default: 'new'. Omit unless you specifically need a different value. Default: "new".
request.custom_fieldsobjectNoCustom field values

Result

FieldType / accepted valuesRequiredDetails
dataobject or nullYesThe affected record, or the result of the operation. Null when nothing matched.

The downloadable tool schemas include the full input and output contracts. Tables describe schema-level required fields; cross-field rules still apply.

On this page