Timeline Tools

Create Timeline Item

Create a note or checklist in the timeline of a person, organization, property, active lease, or deal/card. Provide content for a note, or title and at least one named checklist item for a checklist. The item must be linked to a parent entity. Write operation: creates a timeline item.

post/v1/mcp/tool/timelines

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/mcp/tool/timelines
  • Auth: API key in header X-Imobzi-Secret

Request body

type'note' | 'checklist' nullable

Type of timeline item to create. Defaults to note. Use checklist when the user asks for a checklist and then provide title and checklist_items.

contentstring nullable

Text to add as a timeline note. Provide content when type='note'. This field is ignored when creating a checklist.

titlestring nullable

Checklist title. Provide it when type='checklist'. This field is ignored when creating a note.

parent_type'person' | 'organization' | 'property' | 'lease' | 'deal' required

Entity to receive the timeline item. Use person for a person, client, lead, or generic contact; organization for a company; property for an imóvel; lease for the active locação associated with a property; and deal for a negócio or cartão. The value contact is not supported.

contact_namestring nullable

Partial or complete contact name. Use parent_type='person' for a person or parent_type='organization' for a company.

contact_emailstring nullable

Exact contact email address, matched case-insensitively. Use with parent_type='person' or parent_type='organization'.

contact_phonestring nullable

Contact phone number; common formatting variations are accepted. Use with parent_type='person' or parent_type='organization'.

contact_codestring nullable

Public CRM contact code, for example 289 or C-289. Use with parent_type='person' or parent_type='organization'.

property_codestring nullable

Complete public property code, for example AP-001. Use it with parent_type='property' or parent_type='lease'.

property_addressstring nullable

Partial or complete property address. Use it with parent_type='property' or parent_type='lease'; lease resolves the active lease for that property.

deal_codeinteger nullable

Numeric code of the parent deal/card, for example 653. For write operations, send only the numeric portion and also provide pipeline_group_name.

pipeline_group_namestring nullable

Display name of the deal/card pipeline. Provide it when parent_type='deal' and deal_code is numeric.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.