BlueSuite Developers
MCPTool reference

Contact Properties

BlueSuite MCP tools for contact properties

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

Related REST API and behavior.

list_properties

List properties (service addresses) across the workspace with optional search by street, city, state, or zip code. Returns linked contact IDs.

Parameters

FieldType / accepted valuesRequiredDetails
searchstringNoSearch by street, city, state, or postal code
property_type"single-family", "apartment", "complex", "townhouse", "land", "commercial", "other"NoFilter by property type
pageintegerNoPage number (default: 1)
per_pageintegerNoResults per page (default: 25) minimum: 1. maximum: 100.
sort_by"id", "property_type", "created_at", "modified_at"NoField to sort by
sort_direction"asc", "desc"NoSort direction

Result

FieldType / accepted valuesRequiredDetails
dataarray of objectYesThe matching records for this page.
paginationobjectNoHow many more pages of results exist. Absent when the API returned an unpaged result.
pagination.pageintegerWhen parent suppliedCurrent page number, 1-based.
pagination.per_pageintegerWhen parent suppliedNumber of results per page.
pagination.total_pagesintegerWhen parent suppliedTotal number of pages available.

list_contact_properties

List all properties (service addresses) for a contact

Parameters

FieldType / accepted valuesRequiredDetails
contact_idintegerYesContact ID

Result

FieldType / accepted valuesRequiredDetails
dataarray of objectYesThe matching records for this page.
paginationobjectNoHow many more pages of results exist. Absent when the API returned an unpaged result.
pagination.pageintegerWhen parent suppliedCurrent page number, 1-based.
pagination.per_pageintegerWhen parent suppliedNumber of results per page.
pagination.total_pagesintegerWhen parent suppliedTotal number of pages available.

create_contact_property

Add a property (service address) to a contact

Parameters

FieldType / accepted valuesRequiredDetails
contact_idintegerYesContact ID
addressobjectYesProperty address
address.streetstringNoStreet address line 1
address.street_2stringNoStreet address line 2
address.citystringNoCity
address.statestringNoState/province
address.postal_codestringNoPostal/zip code
address.countrystringNoCountry
property_type"single-family", "apartment", "complex", "townhouse", "land", "commercial", "other"NoProperty type (default: single-family)
role"owner", "tenant", "manager", "agent", "other"NoContact role for this property (default: owner)

Result

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

update_contact_property

Update a property for a contact

Parameters

FieldType / accepted valuesRequiredDetails
contact_idintegerYesContact ID
property_idJSON valueYesProperty ID
addressobjectNoProperty address
address.streetstringNoStreet address line 1
address.street_2stringNoStreet address line 2
address.citystringNoCity
address.statestringNoState/province
address.postal_codestringNoPostal/zip code
address.countrystringNoCountry
property_type"single-family", "apartment", "complex", "townhouse", "land", "commercial", "other"NoProperty type
role"owner", "tenant", "manager", "agent", "other"NoContact role for this property

Result

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

delete_contact_property

Delete a property from a contact

Parameters

FieldType / accepted valuesRequiredDetails
contact_idintegerYesContact ID
property_idJSON valueYesProperty ID

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