Lofty
App · 25 actions
Manage Lofty leads, notes, tasks, team references, transactions, and webhooks.
Actions
| Action | What it does |
|---|---|
| Create lead | Create Lead |
| Create note | Create Note |
| Create task | Create Task |
| Create webhook | Create Webhook |
| Delete lead | Delete Lead |
| Delete note | Delete Note |
| Delete task | Delete Task |
| Delete webhook | Delete Webhook |
| Finish task | Finish Task |
| Get lead | Get Lead |
| Get my profile | Get the current user's profile |
| Get note | Get a note by ID |
| Get task | Get Task |
| List lead pipelines | List Lead Pipelines |
| List leads | List Leads |
| List members | Team Members |
| List notes | List Notes |
| List tags | List Tags |
| List tasks | List Tasks |
| List transactions | List Transactions |
| List webhooks | List Webhooks |
| Unfinish task | Unfinish Task |
| Update lead | Update Lead |
| Update note | Update Note |
| Update task | Update Task |
Create lead
Create Lead
Inputs
- Cannot text
cannot_texttrue/false - false: can send message to the lead
- Cannot call
cannot_calltrue/false - false: can call to the lead
- Cannot email
cannot_emailtrue/false - false: can email to the lead
- First name
first_nametextRequired - The first/given name of the lead Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
- Last name
last_nametext - The last/family name of the lead Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
- Emails
emailslist - A list of email addresses associated with the lead
- Phones
phoneslist - A list of phone numbers associated with the lead. (No more than 20 characters per phone)
- Lead types
lead_typeslist - Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7), Homeowner (8), Landlord (9)
- Assigned user id
assigned_user_idtext - ID of the agent to directly assign this lead to. When provided, automatic lead routing is skipped. When omitted or empty, the lead is routed automatically based on routing rules.
- Street address
street_addresstext - The streetAddress associated with the lead. Deprecated: please use the streetAddress field in property instead.
- City
citytext - The city associated with the lead. Deprecated: please use the city field in property instead.
- State
statetext - The state associated with the lead. Deprecated: please use the state field in property instead.
- Zip code
zip_codetext - ZipCode. Deprecated: please use the zipCode field in property instead.
- Referred by
referred_bytext - The referee of the lead
- Stage
stagetext - The stage the lead is in, less than 20 characters
- Groups
groupslist - The groups the lead is in. Caution: Max limit 30 characters. If you exceed the limit, the import will succeed, but only import 30 characters in front. Deprecated, use segments instead.
- Segments
segmentslist - The segments the lead is in. Caution: Max limit 30 characters. If you exceed the limit, the import will succeed, but only import 30 characters in front.
- Tags
tagslist - The tags associated with the lead. All existing tags will be updated based on this call. Caution: Max limit 64 characters. If you exceed the limit, the import will succeed, but only import 64 characters in front.
- Tags add
tags_addlist - The tags associated with the lead. All existing tags will be retained, only add new tags based on this call. Caution: Max limit 64 characters. If you exceed the limit, the import will succeed, but only import 64 characters in front.
- Source
sourcetext - The source of the lead
- Inquiry
inquiryobject - LeadInquirys
- Property
propertyobject - Lead property or mailing address details
- Unsubscription
unsubscriptiontrue/false - Unsubscription the email
- Welcome email
welcome_emailtrue/false - send Welcome Email. (Not supporting update)
- Lead alert
lead_alerttrue/false - send new lead alert email. (Not supporting update)
- Custom attribute list
custom_attribute_listlist - User customized field
- Birthday
birthdaytext - The birthday of the lead(pattern:MMM d, yyyy)
- Lead routing
lead_routingtrue/false - Deprecated. Lead routing is now automatically applied when `assignedUserId` is not provided. This field has no effect.
- Assign group id
assign_group_idtext - Specifies which routing rule scope to apply when automatic lead routing is triggered (i.e., `assignedUserId` is not provided). Set to `-1` to use company-level routing rules. Set to a specific office ID to use that office's routing rules. If omitted, default routing rules will be applied according to the.
- Buying time frame
buying_time_frametext - buying time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Pre qual
pre_qualtext - Pre-qual, `Yes` or `No`.
- House to sell
house_to_selltext - House to Sell, `Yes` or `No`.
- Fthb
fthbtext - first time home buyer, `Yes` or `No`.
- With buyer agent
with_buyer_agenttext - With buyer Agent, `Yes` or `No`.
- Selling time frame
selling_time_frametext - selling time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Mortgage
mortgagetext - Mortgage, `Yes` or `No`.
- Buy house
buy_housetext - Buy a house, `Yes` or `No`.
- With listing agent
with_listing_agenttext - With listing agent, `Yes` or `No`.
- Lead transaction
lead_transactionobject - Lead transaction.
- Lead family member list
lead_family_member_listlist - A list of family members associated with the lead. You can add up to 4 family members.
- Language
languagetext - The lead's abbreviated language, `en`, `fr`, `de`, `es`, `zh-CN`, `zh-TW`, `ja`
- Content
contenttext - Note content
- Is pin
is_pintrue/false - Pin this note or not
- Ownership id
ownership_idtext - The entity ID for the ownership scope. Required when `ownershipScope` is `OFFICE` (pass the office ID) or `PERSONAL` (pass the agent's user ID). Ignored when `ownershipScope` is `TEAM`.
- Ownership scope
ownership_scopetext - Controls the visibility scope of the lead. `TEAM`: Account-wide: visible to all users in this Lofty client account. `OFFICE`: visible only within the specified office (requires `ownershipId`). `PERSONAL`: visible only to the specified agent (requires `ownershipId`). Defaults to `PERSONAL` scope owned by the.
- Default inquiry param
default_inquiry_paramtrue/false - Default inquiry param.
- Specified assign group id
specified_assign_group_idtrue/false - Specified assign group id.
Outputs
dataobject- Response containing the lead ID.
Example output
{
"data": {
"leadId": 1
}
}Create note
Create Note
Inputs
- Content
contenttextRequired - Note content. Silently truncated to 2000 characters.
- Lead id
lead_idtextRequired - ID of the lead this note belongs to. Must be accessible to the caller.
- Is pin
is_pintrue/falseRequired - Whether to pin this note to the top of the lead's timeline.
Outputs
dataobject- Wrapped response for POST /v1.0/notes. The new note's ID is returned under the 'noteId' key.
Example output
{
"data": {
"noteId": 1
}
}Create task
Create Task
Inputs
- Content
contenttext - Description of the task
- Lead id
lead_idtext - The ID of the lead this task is related to
- Type
typetextRequired - The type of the task. Could be `Other`, `Call`, `Email`, `Text`, `Appointment`One of:
Other,Call,Email,Text,Appointment. - Assigned role
assigned_roletext - Role the task should be assigned to (Agent or Assistant)One of:
Agent,Assistant. - Start at
start_atdate and time - When this task/appointment should start. ISO8601 format in specified timezone, e.g., '2026-03-01T15:00:00-08:00'
- End at
end_atdate and time - When this task/appointment should end. ISO8601 format in specified timezone, e.g., '2026-03-01T16:00:00-08:00'. For regular tasks, this represents the deadline
- Time zone code
time_zone_codetext - Timezone code for this task/appointment
- Address
addresstext - Address/location for appointment type tasks
Outputs
dataobject- Wrapped response for POST /v2.0/tasks. The new task's ID is returned under the 'taskId' key.
Example output
{
"data": {
"taskId": 1
}
}Create webhook
Create Webhook
Inputs
- List id
list_idtextRequired - Event type to subscribe to. See the Webhooks tag description for the full list of supported event types.One of:
1,2,3,4,5,6,7,8,9,10,11,12. - Callback url
callback_urltextRequired - Callback URL that receives event payloads. Must be HTTPS and reachable from the Lofty backend.
- Limit
limitnumber - Maximum number of events to include in a single callback batch. Default 100, maximum 5000.From 1 to 5000. Default:
100. - Permission mode
permission_modenumber - Recipient resolution mode. `0` = assignment-based (default): callbacks fire for leads assigned to the subscribing user, or for company owners/admins. `1` = ownership-based: callbacks also fire for any lead the subscribing user manages by ownership (their team / office / personally owned), regardless of.One of:
0,1. Default:0.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {
"callbackUrl": "example",
"limit": 1,
"listId": 1,
"permissionMode": 1,
"subscribeId": 1,
"teamId": 1,
"vendorId": 1
}
}Delete lead
Delete Lead
Inputs
- Lead id
lead_idtextRequired - ID of the lead to trash.
- Reason
reasontextRequired - Free-text reason recorded with the trash operation.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {}
}Delete note
Delete Note
Inputs
- Note id
note_idtextRequired - ID of the note to delete.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {}
}Delete task
Delete Task
Inputs
- Task id
task_idtextRequired - ID of the task or appointment to delete.
Outputs
dataobject- Generic message response
Example output
{
"data": {
"message": "example"
}
}Delete webhook
Delete Webhook
Inputs
- Subscribe id
subscribe_idtextRequired - ID of the webhook subscription to delete.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {}
}Finish task
Finish Task
Inputs
- Task id
task_idtextRequired - ID of the task or appointment to finish.
Outputs
dataobject- Generic message response
Example output
{
"data": {
"message": "example"
}
}Get lead
Get Lead
Inputs
- Lead id
lead_idtextRequired - ID of the lead to retrieve.
- With trash
with_trashtrue/false - When true, include trashed leads in the lookup.Default:
false.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {
"assignCompletionStatus": false,
"assignTime": "example",
"assignedUser": "example",
"assignedUserId": 1,
"birthday": "example",
"buyHouse": "example",
"buyingTimeFrame": "example",
"cannotCall": false,
"cannotEmail": false,
"cannotText": false,
"city": "example",
"createTime": "example",
"customAttributes": [],
"customRoleList": [],
"emails": [],
"facebook": "example",
"firstName": "example",
"fthb": "example",
"groups": [],
"hiddenFlag": false,
"houseToSell": "example",
"language": "example",
"lastName": "example",
"lastTouch": "example",
"lastUpdateTime": "example",
"lastVisit": "example",
"leadFamilyMemberList": [],
"leadId": 1,
"leadInquiry": {
"bathroomsMax": "example",
"bathroomsMin": "example",
"bedroomsMax": 1,
"bedroomsMin": 1,
"createTime": "example",
"defaultValue": false,
"id": 1,
"leadUserId": 1,
"locations": [],
"modifyByAgent": false,
"priceMax": 1,
"priceMin": 1,
"propertyType": [],
"updateTime": "example"
},
"leadPropertyList": [],
"leadSource": 1,
"leadTypes": [],
"leadUserId": 1,
"lenderUserId": 1,
"mortgage": "example",
"opportunity": "High Interest",
"ownershipId": 1,
"ownershipScope": "example",
"phoneConsentStates": [],
"phoneStatuses": [],
"phones": [],
"pondId": 1,
"pondName": "example",
"preQual": "example",
"referredBy": "example",
"score": 1,
"segments": [],
"sellingTimeFrame": "example",
"source": "example",
"stage": "example",
"stageId": 1,
"state": "example",
"streetAddress": "example",
"tags": [],
"teamId": 1,
"twitter": "example",
"unsubscription": false,
"withBuyerAgent": "example",
"withListingAgent": "example",
"zipCode": "example"
}
}Get my profile
Get the current user's profile
Inputs
None.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {
"accountStatus": "example",
"agentInfo": {
"agentPid": "example",
"companyAddress": "example",
"companyName": "example",
"licenseId": "example",
"licenses": [],
"position": "example"
},
"assignedLeadCount": 1,
"email": "example",
"firstLetter": "example",
"firstName": "example",
"group": {
"agentCount": 1,
"allowManageSub": false,
"boundNumber": "example",
"chargePlanServiceId": "example",
"childPath": "example",
"city": "example",
"createTime": "example",
"creatorId": 1,
"defaultFlag": false,
"email": "example",
"id": 1,
"image": "example",
"layer": 1,
"name": "example",
"notUnit": false,
"parentId": 1,
"path": "example",
"payerId": 1,
"phone": "example",
"phoneCode": "example",
"phoneCountry": "example",
"showInSite": false,
"state": "example",
"status": "ACTIVE",
"streetAddress": "example",
"teamId": 1,
"type": 1,
"unit": false,
"updateTime": "example",
"webSiteUrl": "example",
"websiteOwnerId": 1,
"zipcode": "example"
},
"groupId": 1,
"groupName": "example",
"id": 1,
"invitorUserId": 1,
"isAdmin": false,
"lastName": "example",
"memberUserId": 1,
"newLeadCount": 1,
"phoneNumber": "example",
"role": 1,
"roleName": "example",
"status": 1,
"teamId": 1,
"timeZoneId": "example",
"virtualNumber": "example"
}
}Get note
Get a note by ID
Inputs
- Note id
note_idtextRequired - ID of the note to retrieve.
Outputs
dataobject- Wrapped response for GET /v1.0/notes/{noteId}. The note entry is returned under the 'note' key.
Example output
{
"data": {
"note": {
"content": "example",
"createTime": "example",
"creatorId": 1,
"creatorName": "example",
"deleteFlag": false,
"id": 1,
"isPin": false,
"lastEditorId": 1,
"lastEditorName": "example",
"lastUpdate": "example",
"leadId": 1,
"noteId": 1,
"systemNote": false
}
}
}Get task
Get Task
Inputs
- Task id
task_idtextRequired - ID of the task or appointment to retrieve.
Outputs
dataobject- Wrapped response for GET /v2.0/tasks/{taskId}. The task entry is returned under the 'task' key.
Example output
{
"data": {
"task": {
"address": "example",
"allDay": false,
"assignedRole": "example",
"assignedUser": "example",
"assignedUserId": 1,
"body": "example",
"content": "example",
"createTime": "example",
"creatorId": 1,
"endAt": "example",
"finishFlag": false,
"finishTime": "example",
"id": 1,
"lastUpdate": "example",
"leadEmail": "example",
"leadFirstName": "example",
"leadId": 1,
"leadLastName": "example",
"leadName": "example",
"leadPhone": "example",
"leadUserId": 1,
"overdueFlag": false,
"pipelineId": 1,
"queryId": 1,
"queryInfo": "example",
"reminderType": 1,
"startAt": "example",
"subject": "example",
"teamId": 1,
"timeZoneCode": "example",
"type": "example"
}
}
}List lead pipelines
List Lead Pipelines
Inputs
- Name
nametext - Optional lead pipeline name filter (substring match). Defaults to empty.
- Curr page
curr_pagenumber - Zero-based page index.At least 0. Default:
0. - Page size
page_sizenumber - Number of entries to return per page.At least 1. Default:
10.
Outputs
dataobject- Response for GET /v1.0/teamFeatures/lead-pipelines: a page of lead pipeline entries with pagination metadata.
Example output
{
"data": {
"get_metadata": {
"collection": "example",
"limit": 1,
"offset": 1,
"scrollId": "example",
"total": 1
},
"pipelines": []
}
}List leads
List Leads
Inputs
- Stage
stagetext - Search for lead by pipeline stage names.
- Source
sourcetext - Search for lead by source name.
- Phone
phonetext - Precise search for lead by phone number. Example: 3479033333
- Email
emailtext - Precise search for lead by email address.
- Assigned user id
assigned_user_idtext - Search for contacts by user that is assigned to them.
- Contacted
contactedtrue/false - Search for contacts by if they have or have not been contacted.
- Groups
groupstext - Search for lead by group names. deprecated, use segments instead.
- Segments
segmentstext - Search for lead by segment names.
- All tags
all_tagstext - Search for lead with all tag names.
- Any tags
any_tagstext - Search for lead with any tag names.
- Group ids
group_idsnumber - Search for lead by office ids.
- Query sub group
query_sub_grouptrue/false - Query sub group leads or not
- Scroll id
scroll_idtext - Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request.
- Offset
offsetnumber - Start index of the responded leads
- Limit
limitnumber - Quantitative limitation of responded leads, range: [1, 100]
- Sort
sorttext - The sort order can be one of the following: Default, LastContact, LastCall, LastEmail, LastActivity, CreateTime, Inquries, DeleteTime, AssignTime, Score, Activity, Communication, HasDrip, HasAlert, Task, Lender, ActivitySearch, ActivityViews, ActivityFavorites, DripStatus, DripOpenRate, AlertFrequency,.
- Desc
desctrue/false - Descending sort(true) or ascending sort(false)
- Languages
languagestext - Search for lead with any languages (abbreviation)
- Precise search flag
precise_search_flagtrue/false - Whether to precise search for leads based on email or phone
- Role assignee filters
role_assignee_filterstext - [{"roleName":"Lead assign role name","assigneeToIds":[111,222]}]
- Key
keytext - Search by name, phone or email
- Other filters
other_filterstext - Other filters.
- Return fields
return_fieldstext - Return fields.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {
"get_metadata": {
"collection": "example",
"limit": 1,
"offset": 1,
"scrollId": "example",
"total": 1
},
"leads": []
}
}List members
Team Members
Inputs
- Group ids
group_idslist - Office / group IDs to filter members by. When omitted, all visible members are returned.
- Offset
offsetnumber - Zero-based index of the first entry to return. Values < 0 are silently reset to 0.At least 0. Default:
0. - Limit
limitnumber - Number of entries to return per page.At least 1. Default:
25.
Outputs
dataobject- Response for GET /v1.0/members: a page of team members with pagination metadata.
Example output
{
"data": {
"get_metadata": {
"collection": "example",
"limit": 1,
"offset": 1,
"scrollId": "example",
"total": 1
},
"members": []
}
}List notes
List Notes
Inputs
- Lead id
lead_idtextRequired - ID of the lead whose notes to return.
- Include system note
include_system_notetrue/false - When true, include system-generated notes alongside user-created notes.Default:
false.
Outputs
dataobject- Wrapped response for GET /v1.0/notes. Note entries are returned under the 'notes' key.
Example output
{
"data": {
"notes": []
}
}List tags
List Tags
Inputs
None.
Outputs
datalist- Lofty response data.
Example output
{
"data": []
}List tasks
List Tasks
Inputs
- Lead id
lead_idtextRequired - ID of the lead whose tasks and appointments to return.
Outputs
dataobject- Wrapped response for GET /v2.0/tasks and GET /v2.0/tasks/my-tasks. Task entries are returned under the 'tasks' key.
Example output
{
"data": {
"tasks": []
}
}List transactions
List Transactions
Inputs
- Page size
page_sizenumber - Page size; must be between 1 and 100.Default:
20. - Page num
page_numnumber - Page number (0-based); must be >= 0.Default:
0. - Query key
query_keytext - Search keyword. Performs a contains-style fuzzy match (first 15 characters only) against transaction name, property address, or the associated lead name; matching any one field is sufficient.
- Lead id
lead_idtext - Optional. Restrict results to transactions belonging to this lead.
- Transaction type
transaction_typetext - Optional. Filter by transaction type: Purchase, Listing, Lease, Other, or All to return every type in a single call. Case-insensitive. Defaults to Purchase when omitted. Unrecognized values return 400 (20012 INVALID_PARAMETER).One of:
Purchase,Listing,Lease,Other,All.
Outputs
dataobject- Paginated response for transaction search.
Example output
{
"data": {
"pageData": [],
"pageNum": 1,
"pageSize": 1,
"totalCount": 1
}
}List webhooks
List Webhooks
Inputs
None.
Outputs
datalist- Lofty response data.
Example output
{
"data": []
}Unfinish task
Unfinish Task
Inputs
- Task id
task_idtextRequired - ID of the task or appointment to revert to not-completed.
Outputs
dataobject- Generic message response
Example output
{
"data": {
"message": "example"
}
}Update lead
Update Lead
Inputs
- Lead id
lead_idtextRequired - ID of the lead to update.
- Deduplicate
deduplicatetrue/false - Defaults to false: the lead is updated in place. Pass true to also deduplicate: if another lead in the same team shares this lead's email after the update, this lead is merged into that lead (and this lead is deleted).Default:
false. - Cannot text
cannot_texttrue/false - false: can send message to the lead
- Cannot call
cannot_calltrue/false - false: can call to the lead
- Cannot email
cannot_emailtrue/false - false: can email to the lead
- First name
first_nametext - The first/given name of the lead Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
- Last name
last_nametext - The last/family name of the lead Caution: Max limit 30 characters. If you exceed the limit, the import will succuss, but only import 30 characters in front.
- Emails
emailslist - A list of email addresses associated with the lead
- Phones
phoneslist - A list of phone numbers associated with the lead. (No more than 20 characters per phone)
- Lead types
lead_typeslist - Types of lead, expressed by ID. Type ID : Other (-1), Seller (1), Buyer (2), Renter (5), Investor (6), Agent (7),Homeowner (8), Landlord (9)
- Assigned user id
assigned_user_idtext - Id of the agent assigned to this contact
- Street address
street_addresstext - The streetAddress associated with the lead. Deprecated: please use the streetAddress field in property instead.
- City
citytext - The city associated with the lead. Deprecated: please use the city field in property instead.
- State
statetext - The state associated with the lead. Deprecated: please use the state field in property instead.
- Zip code
zip_codetext - ZipCode. Deprecated: please use the zipCode field in property instead.
- Referred by
referred_bytext - The referee of the lead
- Is hidden
is_hiddentrue/false - The lead is hidden or not
- Stage
stagetext - The stage the lead is in, less than 20 characters
- Groups
groupslist - The groups the lead is in Caution: Max limit 30 characters.If you exceed the limit,the import will success , but only import 30 characters in front. deprecated, use segments instead.
- Segments
segmentslist - The segments the lead is in Caution: Max limit 30 characters.If you exceed the limit,the import will success , but only import 30 characters in front.
- Tags
tagslist - The tags associated with the lead. All existing tags will be updated based on this call Caution: Max limit 64 characters.If you exceed the limit,the import will success , but only import 64 characters in front.
- Tags add
tags_addlist - The tags associated with the lead. All existing tags will be retained, only add new tags base on this call Caution: Max limit 64 characters. If you exceed the limit, the import will success, but only import 64 characters in front.
- Source
sourcetext - The source of the lead
- Inquiry
inquiryobject - LeadInquirys
- Property
propertyobject - Lead property or mailing address details
- Custom attribute list
custom_attribute_listlist - User customized field
- Birthday
birthdaytext - The birthday of the lead(pattern:MMM d, yyyy)
- Buying time frame
buying_time_frametext - buying time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Pre qual
pre_qualtext - Pre-qual, `Yes` or `No`.
- House to sell
house_to_selltext - House to Sell, `Yes` or `No`.
- Fthb
fthbtext - first time home buyer, `Yes` or `No`.
- With buyer agent
with_buyer_agenttext - With buyer Agent, `Yes` or `No`.
- Selling time frame
selling_time_frametext - selling time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Mortgage
mortgagetext - Mortgage, `Yes` or `No`.
- Buy house
buy_housetext - Buy a house, `Yes` or `No`.
- With listing agent
with_listing_agenttext - With listing agent, `Yes` or `No`.
- Lead family member list
lead_family_member_listlist - A list of family members associated with the lead. You can add up to 4 family members.
- Language
languagetext - The lead's abbreviated language, `en`, `fr`, `de`, `es`, `zh-CN`, `zh-TW`, `ja`
- Ownership id
ownership_idtext - The entity ID for the ownership scope. Required when `ownershipScope` is `OFFICE` (pass the office ID) or `PERSONAL` (pass the agent's user ID). Ignored when `ownershipScope` is `TEAM`.
- Ownership scope
ownership_scopetext - Controls the visibility scope of the lead. `TEAM`: Account-wide: visible to all users in this Lofty client account. `OFFICE`: visible only within the specified office (requires `ownershipId`). `PERSONAL`: visible only to the specified agent (requires `ownershipId`). Note: `TEAM` refers to the entire client.
- Unsubscription
unsubscriptiontrue/false - Unsubscription the email
- Lead transaction
lead_transactionobject - Lead transaction.
- Tags remove
tags_removelist - Tags to remove from the lead, by literal name. Only tags that are already on the lead are affected: a name not currently on the lead is ignored (so a brand-new tag introduced by `tags`/`tagsAdd` in the same request is not affected). Names are matched literally, so a tag named "*" is removed like any other..
- Clear all tags
clear_all_tagstrue/false - Set to `true` to remove ALL tags from the lead. Takes precedence over `tags` / `tagsAdd` / `tagsRemove`. Defaults to `false` (no change).
Outputs
dataobject- Response containing the lead ID.
Example output
{
"data": {
"leadId": 1
}
}Update note
Update Note
Inputs
- Note id
note_idtextRequired - ID of the note to update.
- Content
contenttextRequired - Note content. Silently truncated to 2000 characters.
- Lead id
lead_idtextRequired - ID of the lead this note belongs to. Must be accessible to the caller.
- Is pin
is_pintrue/falseRequired - Whether to pin this note to the top of the lead's timeline.
Outputs
dataobject- Lofty response data.
Example output
{
"data": {}
}Update task
Update Task
Inputs
- Task id
task_idtextRequired - ID of the task or appointment to update.
- Content
contenttext - Description of the task
- Start at
start_atdate and time - When this task/appointment should start. ISO8601 format in specified timezone, e.g., '2026-03-01T15:00:00-08:00'
- End at
end_atdate and time - When this task/appointment should end. ISO8601 format in specified timezone, e.g., '2026-03-01T16:00:00-08:00'. For regular tasks, this represents the deadline
- Time zone code
time_zone_codetext - Timezone code for this task/appointment
- Address
addresstext - Address/location for appointment type tasks
Outputs
dataobject- Generic message response
Example output
{
"data": {
"message": "example"
}
}