> ## 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 a new agent > Creates a new agent under the caller's team using the supplied profile. Notes: - accountInfo.phoneNumber and accountInfo.emailAddress are required. - When phoneCode is omitted, '1' (US) is used by default. - When roleName is supplied, it is resolved to the team's matching role; unknown names are ignored and the agent is created without a role binding. - Long text fields (address, licenseId, position, personalWebsite, personalIntroduction, social-media item values) are silently truncated to their individual limits. - The response envelope carries errorCode = 0 on success; non-zero values indicate validation failure or upstream error, with errorMsg describing the cause. ## OpenAPI ````yaml openapi/openapi.json POST /v1.0/agent/profile/add 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: Listing V2 description: Listing search V2 - 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). paths: /v1.0/agent/profile/add: post: tags: - Agent User summary: Create a new agent description: >- Creates a new agent under the caller's team using the supplied profile. Notes: - accountInfo.phoneNumber and accountInfo.emailAddress are required. - When phoneCode is omitted, '1' (US) is used by default. - When roleName is supplied, it is resolved to the team's matching role; unknown names are ignored and the agent is created without a role binding. - Long text fields (address, licenseId, position, personalWebsite, personalIntroduction, social-media item values) are silently truncated to their individual limits. - The response envelope carries errorCode = 0 on success; non-zero values indicate validation failure or upstream error, with errorMsg describing the cause. operationId: addAgent 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/AgentProfile' required: true responses: '200': description: >- Envelope with the new agent's user ID, or a non-zero errorCode on failure. content: application/json: schema: $ref: '#/components/schemas/AddAgentResponse' '401': description: Missing or invalid authentication token. content: '*/*': schema: $ref: '#/components/schemas/ResultLong' '500': description: Internal server error. content: '*/*': schema: $ref: '#/components/schemas/ResultLong' components: schemas: AgentProfile: required: - accountInfo - accountType type: object properties: accountType: type: integer description: The account type of the agent format: int32 accountInfo: $ref: '#/components/schemas/AccountInfo' workInfo: $ref: '#/components/schemas/WorkInfo' socialMedias: $ref: '#/components/schemas/SocialMedias' personalPhotos: $ref: '#/components/schemas/PersonalPhotos' hasBackOffice: type: boolean agentPid: type: string fullSync: type: boolean shouldSync: type: boolean checkRosterNum: type: boolean description: Agent profile payload. AddAgentResponse: type: object properties: data: type: integer description: >- User ID of the newly created agent. Zero when creation fails or an existing agent is returned without a new ID. format: int64 example: 100234 errorCode: type: integer description: Business error code. 0 indicates success. format: int32 example: 0 errorMsg: type: string description: Human-readable error message when errorCode != 0. description: >- Response for POST /v1.0/agent/profile/add. Envelope that carries the new agent's user ID and an error code when creation fails. ResultLong: type: object properties: data: type: integer format: int64 errorCode: type: integer format: int32 errorMsg: type: string errorData: $ref: '#/components/schemas/JsonNode' AccountInfo: required: - emailAddress - firstName - lastName type: object properties: headUrl: type: string description: The head url of the agent example: http://xxx lastName: type: string description: last name of the agent example: Bob firstName: type: string description: first name of the agent example: Bob emailAddress: type: string description: email address of the agent example: aaaa@google.com phoneNumber: type: string description: phone number of the agent example: '83834748' phoneCode: type: string description: phone code of the agent example: '000001' phoneCountry: type: string description: phone country of the agent example: '000001' tagIds: type: array description: tags of the agent example: - 12345 - 67890 items: type: integer format: int64 example: 12345 sendingEmail: type: string domain: type: string allowChangeDomain: type: boolean roleName: type: string description: roleName example: role of the agent groupId: type: integer format: int64 roleId: type: integer format: int64 seatTypeName: type: string description: the seat type code of the agent example: Full Time Agent description: >- Account Base Info of agent, like name , email or phone and something else WorkInfo: type: object properties: streetAddress: type: string description: Street Address example: 123 Main St city: type: string description: City example: New York country: type: string description: Country example: US state: type: string description: State example: NY zipcode: type: string description: Zipcode example: '10001' licenseId: type: string description: licenseId of the agent example: xxx companyName: type: string description: Company Name example: xxx companyAddress: type: string description: Company Address example: xxx position: type: string description: position example: xxx personalWebsite: type: string description: Personal Website example: xxx personalAttachments: type: array items: $ref: '#/components/schemas/FileInfo' personalDisclaimers: type: array items: $ref: '#/components/schemas/FileInfo' personalIntroduction: type: string description: Personal Introduction example: xxx description: Work Info of agent, include company info etc.. SocialMedias: type: object properties: items: type: array items: $ref: '#/components/schemas/Item' description: 'Social media of agent, include company info ' PersonalPhotos: type: object properties: urls: type: array items: type: string description: 'Personal photos of agent ' JsonNode: type: object FileInfo: type: object properties: fileName: type: string size: type: integer format: int32 queryLink: type: string contentType: type: string Item: type: object properties: type: type: string name: type: string value: type: string ````