> ## Documentation Index > Fetch the complete documentation index at: https://developer.lofty.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Transaction Custom Field > Creates a team-level custom field for transactions and returns it, id included, so the id can be used straight away when populating LeadTransaction.customFields. **Place the field in at least one group.** A field belonging to no field group is invisible - it will not show on the transaction detail page, as a list column, or in filters. Pass `formIds` from GET /v1.0/transaction/forms, or place it from the CRM UI afterwards. Differences from the lead custom field API worth knowing: `anniversary_date` does not exist on transactions, `html` is not offered, and the option list for select types is a bare JSON array, though the lead API's shape, that same array wrapped in an object under an `option` key, is accepted here too and normalised. Scope: the caller's team. ## OpenAPI ````yaml openapi/openapi.json POST /v1.0/transaction/customfields openapi: 3.0.1 info: title: Lofty Service Open APIs description: Lofty service API description version: '1.0' servers: - url: https://api.lofty.com security: [] tags: - name: Tasks & Appointments V2 description: >- Unified V2 API for lead tasks and appointments: list, create, read, update, finish, unfinish and delete. Tasks and appointments share the same taskId namespace; each endpoint resolves the target by ID regardless of underlying type. - name: Opportunity description: Operations about opportunity - name: Communication V2 description: >- Fetch a single communication record (text / email / call) by its communication ID. Closes the webhook follow-up gap where only list-by-lead endpoints existed for text and email. - name: Vendor description: >- Team vendor directory: team members, sub-accounts and associated agents within the caller's team. - name: Lead Routing description: >- Lead routing configuration: read and update routing rules and default (supplement) rules per business type, and list the members and roles available for assignment. - name: Lead Activity V2 API description: >- Unified lead activity timeline: returns call, text and email activities for a lead in chronological order, including both auto-captured and agent-logged entries. - name: Tasks & Appointments description: >- Agent tasks and lead appointments. Supports listing a lead's appointments, listing / reading / creating / updating / deleting tasks on a lead. - name: Transactions V2 description: V2 transaction APIs. - name: Lead Manual Log description: >- Agent-recorded log of communications that happened outside the Lofty CRM (calls placed on a personal line, emails sent from another mailbox, SMS sent from another device). Three channels are supported: logCall, logEmail, logText. Direction fields are recorded from the agent's point of view: 'outbound' = agent -> lead, 'inbound' = lead -> agent. Persistence is asynchronous: a POST returns the new entry's ID once the write is enqueued, and the entry becomes readable after a short delay. - name: Calls description: >- Calls placed or received through the Lofty dialer. Supports fetching a recording URL, retrieving a single call record, and listing calls attached to a lead. - name: Agents V2 description: >- Agent lifecycle management: deactivate an agent of the caller's team (frees the license seat, revokes sessions and tokens, keeps leads and data untouched) and reactivate a previously deactivated agent (re-occupies a seat and restores access without data loss). Deactivation is reversible and distinct from deletion. - name: Agent User description: >- Agent onboarding and team directory operations. Create a new agent under the caller's team and attach tags to existing agents. - name: Sales Agents V2 description: >- Sales Agent (AI Assistant) management: read the caller's assistant and quota, query leads followed by AI, mute leads, manage working-pool membership and plan tasks, and update Sales Agent settings. - name: Calendar V2 API description: >- Unified V2 API for tasks and appointments on a lead: create, update, delete, finish, unfinish, query a paginated list, and find available meeting slots. Calendar IDs returned by POST /v2.0/calendar are composite strings of the form '``-task' or '``-appointment' and must be sent back as-is to the per-entry endpoints. - name: Lead System Logs description: Query a lead's system log. - name: Lead Transaction description: Operations about leads - name: Notifications V2 description: Operations for sending notifications to agents - name: Notes description: >- Free-text notes attached to a lead. Supports create, list, get-by-id, update and delete. Notes may be pinned to surface them at the top of the lead's timeline. System-generated notes (automated activity) are included on the list endpoint only when explicitly requested. - name: Listing description: >- Listing data access: retrieve published listings for a site feed (XML), and search active / sold listings by agent, office or MLS id. - name: Intelligent Features description: AI-powered features for lead analysis and communication - name: Leads description: >- Lead lifecycle operations: create / read / update / delete a lead, search leads by stage, source, tag, create time or update time, place an inquiry or property on a lead, list lead activities, resolve assignee by lead info, and handle Brokermint contact callbacks. - name: Members description: >- Team member directory: look up members by user ID, by account (email), or list all members of the caller's team. Also supports retrieving the current user's profile. - name: Team Features description: >- Team-scoped metadata: lead tags, custom fields, and lead ponds. Supports listing existing entries, adding a new custom field, and retrieving a specific lead pond. - name: Agent Organization description: >- Team organizational structure: read the caller's organization info, manage company and office records, and list permission profiles available to the team. - name: Communication description: >- Lead communication history and outbound messaging: list call / email / text history for a lead, search communications for an agent, and send SMS or email to a lead. - name: Webhooks description: > Use webhooks to be notified about events that happen in a lofty account. Supported webhook event types (listId): | listId | Event Type | Description | |--------|-----------|-------------| | 1 | Agent Info | Agent created or updated | | 2 | Lead Info | Lead created, updated, or deleted | | 3 | Lead Activity | Lead site activity (e.g. SiteBrowse, SiteFavorite, SiteSearch) | | 4 | Listing Alert | Listing alert changed | | 5 | Transaction | Transaction created, updated, or deleted | | 6 | Call | Call event (MANUAL and LOGGED only, excludes AUTO) | | 7 | Email | Email event (MANUAL and LOGGED only, excludes AUTO) | | 8 | Text | Text message event (MANUAL and LOGGED only, excludes AUTO) | | 9 | Note | Note created, updated, or deleted | | 10 | Task | Task created, updated, finished, or deleted | | 11 | Appointment | Appointment created, updated, finished, or deleted | | 12 | Pipeline Change | Lead pipeline stage changed | ### Notification Recipient Rules Here "team" means the entire Lofty client account (the organization), not the Lofty "Team add-on" product. Which subscribed users receive a callback depends on the subscription's delivery mode (`permissionMode`). In both modes, only users in the lead's account (team) who have subscribed to the event type are considered. **Assignment-based delivery — `permissionMode: 0` (default)** A subscriber receives the callback only for leads assigned to them or that they administer: - If the lead is a **hidden lead**, only the **assigned agent** receives the notification. - Otherwise, the subscriber receives it if they are the **assigned agent** of the lead, or a **Company Owner** or **Company Admin**. - All other subscribers do **not** receive the notification. **Ownership-based delivery — `permissionMode: 1`** A subscriber receives the callback for any lead they manage, regardless of who it is assigned to: - Every assignment-based case above still applies (assigned agent, Company Owner / Company Admin). - In addition, the subscriber receives the callback for any lead within their **ownership scope** — a lead owned by their **team** or **office**, or **personally owned** by them — even if it is assigned to someone else. - Hidden leads are still delivered only to users who manage them. Ownership-based mode is intended for team/account-level integrations that must cover every lead in their scope, not only assigned leads. Set `permissionMode` when creating the subscription (POST /v1.0/webhook); it defaults to `0`, so existing subscriptions are unaffected. ### Delivery Timing Webhooks are typically delivered within **1 minute** of the event being triggered. During periods of high traffic, delivery may be delayed, but will always be sent within **5 minutes**. For detailed callback payload structures, see [Webhook Event Payloads](/concepts/webhooks#event-payloads). - name: Saved Searches description: >- Read the property searches a lead has saved, together with how their listing alerts are delivered. A saved search and its listing alert are one object: the search conditions and the delivery cadence travel together. ### Coverage `criteria` is a fixed field set. Filters this version does not model yet are listed by name in `unmappedCriteria`, so a partially understood search can be told apart from a fully mapped one. Values of unmapped filters are not returned. ### Pausing alerts A paused search keeps its conditions and schedule; only the emails stop. Pausing sets the cadence to NEVER, the same as choosing Never in the CRM, so a paused search reads back as `INACTIVE`, with the cadence it replaced in `frequencyBeforePause`; resume restores the same cadence. Alerts also stay silent while the lead is unsubscribed from property alerts, whatever the cadence. ### Errors A request rejected by validation or by a business rule (missing or invalid field, duplicate search, recipient that is not the lead's, ...) answers HTTP 200 with `{"code": , "message": "..."}` instead of the saved search. Check `code` in the body rather than the HTTP status. Unknown ids answer HTTP 404 and leads the token user cannot see answer HTTP 403. | code | meaning | |---|---| | 20012 | A field is missing, invalid or not allowed; `message` names it | | 2000001 | A saved search of the lead already has the same filters | | 2000005 | The lead has no email address to send alerts to | | 2000011 | The saved search cannot be edited (created by the lead on the website) | | 100000 | Lofty could not complete the change; try again later | paths: /v1.0/transaction/customfields: post: tags: - Lead Transaction summary: Create Transaction Custom Field description: >- Creates a team-level custom field for transactions and returns it, id included, so the id can be used straight away when populating LeadTransaction.customFields. **Place the field in at least one group.** A field belonging to no field group is invisible - it will not show on the transaction detail page, as a list column, or in filters. Pass `formIds` from GET /v1.0/transaction/forms, or place it from the CRM UI afterwards. Differences from the lead custom field API worth knowing: `anniversary_date` does not exist on transactions, `html` is not offered, and the option list for select types is a bare JSON array, though the lead API's shape, that same array wrapped in an object under an `option` key, is accepted here too and normalised. Scope: the caller's team. operationId: transactions_addTransactionCustomField parameters: - name: Authorization in: header description: Bearer [access_token] required: true schema: type: string - name: Content-Type in: header description: application/json required: true schema: type: string example: application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/TransactionCustomFieldRequest' required: true responses: '200': description: The field that was created, id included. content: application/json: schema: $ref: '#/components/schemas/CustomFieldResponse' '400': description: >- Body is {"code", "message"}. Rejected by this gateway: name empty (200068), unsupported attribute type (200307), malformed option list (200308). Rejected by the transaction service, with its own code and wording kept: name already taken (407), team at its custom-field quota, unknown or foreign field group, or a group already at its 50-field limit. content: application/json: schema: type: string '401': description: Missing or invalid authentication token. content: application/json: schema: type: string '403': description: >- The token does not carry the Team & Organization tag for creating custom fields (200100). '500': description: Internal server error. content: application/json: schema: type: string components: schemas: TransactionCustomFieldRequest: required: - attributeName - attributeType type: object properties: attributeName: type: string description: >- Display name for the new field. Trimmed before use, and checked for collisions against both existing custom fields and the built-in transaction fields. example: Mailer Sent attributeType: type: string description: >- Field data type. Note two differences from the lead custom field API: `anniversary_date` does not exist on transactions and is rejected, and `html` is not offered here. example: date enum: - text - number - date - percentage - currency - single_select - multi_select params: type: string description: >- Option list, required for `single_select` and `multi_select` and ignored otherwise. Both shapes are accepted and normalised: a bare JSON array `["Pending","Closed"]`, or the lead API's wrapper `{"option":["Pending","Closed"]}`. Sending an empty list for a select type is rejected. example: '["Pending","Closed"]' formIds: type: array description: >- Field groups to place the new field in, from `GET /v1.0/transaction/forms`. **A field in no group is invisible** - it will not appear on the transaction detail page, as a list column, or in filters. Omit this only if you intend to place the field from the CRM UI afterwards. Every id is validated before the field is created, so a bad id fails the whole request rather than leaving an orphaned field behind. A group already at its 50-field limit is rejected the same way. example: - 301 items: type: integer description: >- Field groups to place the new field in, from `GET /v1.0/transaction/forms`. **A field in no group is invisible** - it will not appear on the transaction detail page, as a list column, or in filters. Omit this only if you intend to place the field from the CRM UI afterwards. Every id is validated before the field is created, so a bad id fails the whole request rather than leaving an orphaned field behind. A group already at its 50-field limit is rejected the same way. format: int64 description: Custom field definition. CustomFieldResponse: type: object properties: id: type: integer description: Custom field id. format: int64 example: 1001 name: type: string description: Custom field display name. example: Closing Agent type: type: string description: >- Custom field data type. Note the mixed casing: Single-Select and Multi-Select are emitted with hyphens and mixed case, while the other values are the upper-case enum names. example: Single-Select enum: - DATE - TEXT - NUMBER - PERCENTAGE - Single-Select - Multi-Select - CURRENCY - HTML params: type: string description: >- For Single-Select and Multi-Select types, a JSON string encoding the option list, e.g. "[{\"label\":\"Option A\",\"value\":\"1\"},{\"label\":\"Option B\",\"value\":\"2\"}]". Empty or null for non-select types. example: '[{"label":"Option A","value":"1"},{"label":"Option B","value":"2"}]' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.