# Lofty

> Manage Lofty leads, notes, tasks, team references, transactions, and webhooks.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/lofty

## Actions

### Create lead

Create Lead

**Inputs**

- Cannot text (`cannot_text`, true/false): false: can send message to the lead
- Cannot call (`cannot_call`, true/false): false: can call to the lead
- Cannot email (`cannot_email`, true/false): false: can email to the lead
- First name (`first_name`, text, required): 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_name`, text): 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 (`emails`, list): A list of email addresses associated with the lead
- Phones (`phones`, list): A list of phone numbers associated with the lead. (No more than 20 characters per phone)
- Lead types (`lead_types`, list): 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_id`, text): 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_address`, text): The streetAddress associated with the lead. Deprecated: please use the streetAddress field in property instead.
- City (`city`, text): The city associated with the lead. Deprecated: please use the city field in property instead.
- State (`state`, text): The state associated with the lead. Deprecated: please use the state field in property instead.
- Zip code (`zip_code`, text): ZipCode. Deprecated: please use the zipCode field in property instead.
- Referred by (`referred_by`, text): The referee of the lead
- Stage (`stage`, text): The stage the lead is in, less than 20 characters
- Groups (`groups`, list): 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 (`segments`, list): 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 (`tags`, list): 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_add`, list): 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 (`source`, text): The source of the lead
- Inquiry (`inquiry`, object): LeadInquirys
- Property (`property`, object): Lead property or mailing address details
- Unsubscription (`unsubscription`, true/false): Unsubscription the email
- Welcome email (`welcome_email`, true/false): send Welcome Email. (Not supporting update)
- Lead alert (`lead_alert`, true/false): send new lead alert email. (Not supporting update)
- Custom attribute list (`custom_attribute_list`, list): User customized field
- Birthday (`birthday`, text): The birthday of the lead(pattern:MMM d, yyyy)
- Lead routing (`lead_routing`, true/false): Deprecated. Lead routing is now automatically applied when `assignedUserId` is not provided. This field has no effect.
- Assign group id (`assign_group_id`, text): 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_frame`, text): buying time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Pre qual (`pre_qual`, text): Pre-qual, `Yes` or `No`.
- House to sell (`house_to_sell`, text): House to Sell, `Yes` or `No`.
- Fthb (`fthb`, text): first time home buyer, `Yes` or `No`.
- With buyer agent (`with_buyer_agent`, text): With buyer Agent, `Yes` or `No`.
- Selling time frame (`selling_time_frame`, text): selling time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Mortgage (`mortgage`, text): Mortgage, `Yes` or `No`.
- Buy house (`buy_house`, text): Buy a house, `Yes` or `No`.
- With listing agent (`with_listing_agent`, text): With listing agent, `Yes` or `No`.
- Lead transaction (`lead_transaction`, object): Lead transaction.
- Lead family member list (`lead_family_member_list`, list): A list of family members associated with the lead. You can add up to 4 family members.
- Language (`language`, text): The lead's abbreviated language, `en`, `fr`, `de`, `es`, `zh-CN`, `zh-TW`, `ja`
- Content (`content`, text): Note content
- Is pin (`is_pin`, true/false): Pin this note or not
- Ownership id (`ownership_id`, text): 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_scope`, text): 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_param`, true/false): Default inquiry param.
- Specified assign group id (`specified_assign_group_id`, true/false): Specified assign group id.

**Outputs**

- `data` (object): Response containing the lead ID.

**Example output**

```json
{
  "data": {
    "leadId": 1
  }
}
```

### Create note

Create Note

**Inputs**

- Content (`content`, text, required): Note content. Silently truncated to 2000 characters.
- Lead id (`lead_id`, text, required): ID of the lead this note belongs to. Must be accessible to the caller.
- Is pin (`is_pin`, true/false, required): Whether to pin this note to the top of the lead's timeline.

**Outputs**

- `data` (object): Wrapped response for POST /v1.0/notes. The new note's ID is returned under the 'noteId' key.

**Example output**

```json
{
  "data": {
    "noteId": 1
  }
}
```

### Create task

Create Task

**Inputs**

- Content (`content`, text): Description of the task
- Lead id (`lead_id`, text): The ID of the lead this task is related to
- Type (`type`, text, required): The type of the task. Could be `Other`, `Call`, `Email`, `Text`, `Appointment`. One of: `Other`, `Call`, `Email`, `Text`, `Appointment`.
- Assigned role (`assigned_role`, text): Role the task should be assigned to (Agent or Assistant). One of: `Agent`, `Assistant`.
- Start at (`start_at`, date 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_at`, date 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_code`, text): Timezone code for this task/appointment
- Address (`address`, text): Address/location for appointment type tasks

**Outputs**

- `data` (object): Wrapped response for POST /v2.0/tasks. The new task's ID is returned under the 'taskId' key.

**Example output**

```json
{
  "data": {
    "taskId": 1
  }
}
```

### Create webhook

Create Webhook

**Inputs**

- List id (`list_id`, text, required): 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_url`, text, required): Callback URL that receives event payloads. Must be HTTPS and reachable from the Lofty backend.
- Limit (`limit`, number): Maximum number of events to include in a single callback batch. Default 100, maximum 5000. From 1 to 5000. Default: `100`.
- Permission mode (`permission_mode`, number): 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**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "data": {
    "callbackUrl": "example",
    "limit": 1,
    "listId": 1,
    "permissionMode": 1,
    "subscribeId": 1,
    "teamId": 1,
    "vendorId": 1
  }
}
```

### Delete lead

Delete Lead

**Inputs**

- Lead id (`lead_id`, text, required): ID of the lead to trash.
- Reason (`reason`, text, required): Free-text reason recorded with the trash operation.

**Outputs**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete note

Delete Note

**Inputs**

- Note id (`note_id`, text, required): ID of the note to delete.

**Outputs**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "data": {}
}
```

### Delete task

Delete Task

**Inputs**

- Task id (`task_id`, text, required): ID of the task or appointment to delete.

**Outputs**

- `data` (object): Generic message response

**Example output**

```json
{
  "data": {
    "message": "example"
  }
}
```

### Delete webhook

Delete Webhook

**Inputs**

- Subscribe id (`subscribe_id`, text, required): ID of the webhook subscription to delete.

**Outputs**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "data": {}
}
```

### Finish task

Finish Task

**Inputs**

- Task id (`task_id`, text, required): ID of the task or appointment to finish.

**Outputs**

- `data` (object): Generic message response

**Example output**

```json
{
  "data": {
    "message": "example"
  }
}
```

### Get lead

Get Lead

**Inputs**

- Lead id (`lead_id`, text, required): ID of the lead to retrieve.
- With trash (`with_trash`, true/false): When true, include trashed leads in the lookup. Default: `false`.

**Outputs**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "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**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "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_id`, text, required): ID of the note to retrieve.

**Outputs**

- `data` (object): Wrapped response for GET /v1.0/notes/{noteId}. The note entry is returned under the 'note' key.

**Example output**

```json
{
  "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_id`, text, required): ID of the task or appointment to retrieve.

**Outputs**

- `data` (object): Wrapped response for GET /v2.0/tasks/{taskId}. The task entry is returned under the 'task' key.

**Example output**

```json
{
  "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 (`name`, text): Optional lead pipeline name filter (substring match). Defaults to empty.
- Curr page (`curr_page`, number): Zero-based page index. At least 0. Default: `0`.
- Page size (`page_size`, number): Number of entries to return per page. At least 1. Default: `10`.

**Outputs**

- `data` (object): Response for GET /v1.0/teamFeatures/lead-pipelines: a page of lead pipeline entries with pagination metadata.

**Example output**

```json
{
  "data": {
    "get_metadata": {
      "collection": "example",
      "limit": 1,
      "offset": 1,
      "scrollId": "example",
      "total": 1
    },
    "pipelines": []
  }
}
```

### List leads

List Leads

**Inputs**

- Stage (`stage`, text): Search for lead by pipeline stage names.
- Source (`source`, text): Search for lead by source name.
- Phone (`phone`, text): Precise search for lead by phone number. Example: 3479033333
- Email (`email`, text): Precise search for lead by email address.
- Assigned user id (`assigned_user_id`, text): Search for contacts by user that is assigned to them.
- Contacted (`contacted`, true/false): Search for contacts by if they have or have not been contacted.
- Groups (`groups`, text): Search for lead by group names. deprecated, use segments instead.
- Segments (`segments`, text): Search for lead by segment names.
- All tags (`all_tags`, text): Search for lead with all tag names.
- Any tags (`any_tags`, text): Search for lead with any tag names.
- Group ids (`group_ids`, number): Search for lead by office ids.
- Query sub group (`query_sub_group`, true/false): Query sub group leads or not
- Scroll id (`scroll_id`, text): Scroll ID for the search. You can then use the scroll ID to retrieve the next batch of results for the request.
- Offset (`offset`, number): Start index of the responded leads
- Limit (`limit`, number): Quantitative limitation of responded leads, range: [1, 100]
- Sort (`sort`, text): 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 (`desc`, true/false): Descending sort(true) or ascending sort(false)
- Languages (`languages`, text): Search for lead with any languages (abbreviation)
- Precise search flag (`precise_search_flag`, true/false): Whether to precise search for leads based on email or phone
- Role assignee filters (`role_assignee_filters`, text): [{"roleName":"Lead assign role name","assigneeToIds":[111,222]}]
- Key (`key`, text): Search by name, phone or email
- Other filters (`other_filters`, text): Other filters.
- Return fields (`return_fields`, text): Return fields.

**Outputs**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "data": {
    "get_metadata": {
      "collection": "example",
      "limit": 1,
      "offset": 1,
      "scrollId": "example",
      "total": 1
    },
    "leads": []
  }
}
```

### List members

Team Members

**Inputs**

- Group ids (`group_ids`, list): Office / group IDs to filter members by. When omitted, all visible members are returned.
- Offset (`offset`, number): Zero-based index of the first entry to return. Values < 0 are silently reset to 0. At least 0. Default: `0`.
- Limit (`limit`, number): Number of entries to return per page. At least 1. Default: `25`.

**Outputs**

- `data` (object): Response for GET /v1.0/members: a page of team members with pagination metadata.

**Example output**

```json
{
  "data": {
    "get_metadata": {
      "collection": "example",
      "limit": 1,
      "offset": 1,
      "scrollId": "example",
      "total": 1
    },
    "members": []
  }
}
```

### List notes

List Notes

**Inputs**

- Lead id (`lead_id`, text, required): ID of the lead whose notes to return.
- Include system note (`include_system_note`, true/false): When true, include system-generated notes alongside user-created notes. Default: `false`.

**Outputs**

- `data` (object): Wrapped response for GET /v1.0/notes. Note entries are returned under the 'notes' key.

**Example output**

```json
{
  "data": {
    "notes": []
  }
}
```

### List tags

List Tags

**Inputs**: None.

**Outputs**

- `data` (list): Lofty response data.

**Example output**

```json
{
  "data": []
}
```

### List tasks

List Tasks

**Inputs**

- Lead id (`lead_id`, text, required): ID of the lead whose tasks and appointments to return.

**Outputs**

- `data` (object): Wrapped response for GET /v2.0/tasks and GET /v2.0/tasks/my-tasks. Task entries are returned under the 'tasks' key.

**Example output**

```json
{
  "data": {
    "tasks": []
  }
}
```

### List transactions

List Transactions

**Inputs**

- Page size (`page_size`, number): Page size; must be between 1 and 100. Default: `20`.
- Page num (`page_num`, number): Page number (0-based); must be >= 0. Default: `0`.
- Query key (`query_key`, text): 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_id`, text): Optional. Restrict results to transactions belonging to this lead.
- Transaction type (`transaction_type`, text): 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**

- `data` (object): Paginated response for transaction search.

**Example output**

```json
{
  "data": {
    "pageData": [],
    "pageNum": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}
```

### List webhooks

List Webhooks

**Inputs**: None.

**Outputs**

- `data` (list): Lofty response data.

**Example output**

```json
{
  "data": []
}
```

### Unfinish task

Unfinish Task

**Inputs**

- Task id (`task_id`, text, required): ID of the task or appointment to revert to not-completed.

**Outputs**

- `data` (object): Generic message response

**Example output**

```json
{
  "data": {
    "message": "example"
  }
}
```

### Update lead

Update Lead

**Inputs**

- Lead id (`lead_id`, text, required): ID of the lead to update.
- Deduplicate (`deduplicate`, true/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_text`, true/false): false: can send message to the lead
- Cannot call (`cannot_call`, true/false): false: can call to the lead
- Cannot email (`cannot_email`, true/false): false: can email to the lead
- First name (`first_name`, text): 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_name`, text): 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 (`emails`, list): A list of email addresses associated with the lead
- Phones (`phones`, list): A list of phone numbers associated with the lead. (No more than 20 characters per phone)
- Lead types (`lead_types`, list): 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_id`, text): Id of the agent assigned to this contact
- Street address (`street_address`, text): The streetAddress associated with the lead. Deprecated: please use the streetAddress field in property instead.
- City (`city`, text): The city associated with the lead. Deprecated: please use the city field in property instead.
- State (`state`, text): The state associated with the lead. Deprecated: please use the state field in property instead.
- Zip code (`zip_code`, text): ZipCode. Deprecated: please use the zipCode field in property instead.
- Referred by (`referred_by`, text): The referee of the lead
- Is hidden (`is_hidden`, true/false): The lead is hidden or not
- Stage (`stage`, text): The stage the lead is in, less than 20 characters
- Groups (`groups`, list): 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 (`segments`, list): 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 (`tags`, list): 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_add`, list): 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 (`source`, text): The source of the lead
- Inquiry (`inquiry`, object): LeadInquirys
- Property (`property`, object): Lead property or mailing address details
- Custom attribute list (`custom_attribute_list`, list): User customized field
- Birthday (`birthday`, text): The birthday of the lead(pattern:MMM d, yyyy)
- Buying time frame (`buying_time_frame`, text): buying time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Pre qual (`pre_qual`, text): Pre-qual, `Yes` or `No`.
- House to sell (`house_to_sell`, text): House to Sell, `Yes` or `No`.
- Fthb (`fthb`, text): first time home buyer, `Yes` or `No`.
- With buyer agent (`with_buyer_agent`, text): With buyer Agent, `Yes` or `No`.
- Selling time frame (`selling_time_frame`, text): selling time frame, `1-3`, `3-6`, `6-12`, `12+`, `Just Looking`, `Refinancing`.
- Mortgage (`mortgage`, text): Mortgage, `Yes` or `No`.
- Buy house (`buy_house`, text): Buy a house, `Yes` or `No`.
- With listing agent (`with_listing_agent`, text): With listing agent, `Yes` or `No`.
- Lead family member list (`lead_family_member_list`, list): A list of family members associated with the lead. You can add up to 4 family members.
- Language (`language`, text): The lead's abbreviated language, `en`, `fr`, `de`, `es`, `zh-CN`, `zh-TW`, `ja`
- Ownership id (`ownership_id`, text): 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_scope`, text): 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 (`unsubscription`, true/false): Unsubscription the email
- Lead transaction (`lead_transaction`, object): Lead transaction.
- Tags remove (`tags_remove`, list): 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_tags`, true/false): Set to `true` to remove ALL tags from the lead. Takes precedence over `tags` / `tagsAdd` / `tagsRemove`. Defaults to `false` (no change).

**Outputs**

- `data` (object): Response containing the lead ID.

**Example output**

```json
{
  "data": {
    "leadId": 1
  }
}
```

### Update note

Update Note

**Inputs**

- Note id (`note_id`, text, required): ID of the note to update.
- Content (`content`, text, required): Note content. Silently truncated to 2000 characters.
- Lead id (`lead_id`, text, required): ID of the lead this note belongs to. Must be accessible to the caller.
- Is pin (`is_pin`, true/false, required): Whether to pin this note to the top of the lead's timeline.

**Outputs**

- `data` (object): Lofty response data.

**Example output**

```json
{
  "data": {}
}
```

### Update task

Update Task

**Inputs**

- Task id (`task_id`, text, required): ID of the task or appointment to update.
- Content (`content`, text): Description of the task
- Start at (`start_at`, date 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_at`, date 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_code`, text): Timezone code for this task/appointment
- Address (`address`, text): Address/location for appointment type tasks

**Outputs**

- `data` (object): Generic message response

**Example output**

```json
{
  "data": {
    "message": "example"
  }
}
```
