# Nexor ## Start here - [Welcome to Nexor](https://docs.getnexor.ai/docs/en/guides/getting-started.md): What Nexor does, what agents and tasks are, and the five steps to get your first agent talking to leads. - [Agents and tasks](https://docs.getnexor.ai/docs/en/guides/getting-started/anatomy-of-an-agent.md): How an agent and its tasks fit together: what the agent shares with every task, what each task controls, how a lead gets into a task, and how it moves to the next one. - [Changelog](https://docs.getnexor.ai/docs/en/changelog.md): New Nexor features, improvements, and fixes ## Quickstart - [Connect channels and bring in leads](https://docs.getnexor.ai/docs/en/guides/getting-started/operate-and-connect-channels.md): Connect the channels your agent talks on, choose which task uses each one, set the agent's working hours, and bring leads in from a CRM, a file, your website, or the API. - [Create your first agent](https://docs.getnexor.ai/docs/en/guides/getting-started/overview.md): Step by step from an empty account to a live agent: describe your business to Nexor AI, agree on the tasks, add what the agent should know, connect channels and leads, test, and go live. - [Bring in leads and connect your systems](https://docs.getnexor.ai/docs/en/guides/integrations/overview.md): Bring in leads from your CRM, CSV, Excel, Google Sheets, a form, or the API. Configure the destination task and verify the first import. ## API reference - [Introduction to the Nexor API](https://docs.getnexor.ai/docs/en/api/introduction.md): Choose a Nexor developer interface, use the correct key type, and learn the public API base URL and rate limits. - [Authentication](https://docs.getnexor.ai/docs/en/api/authentication.md): Choose and secure REST, MCP, and publishable keys, then create, use, rotate, and revoke a REST key. - [JavaScript SDK](https://docs.getnexor.ai/docs/en/api/sdk.md): Use @getnexorai/sdk v0.1.44 from a Node.js server, or mount its advanced browser widget with a public web-chat key. ### MCP Server - [MCP Server](https://docs.getnexor.ai/docs/en/api/mcp-server.md): Connect Claude, Codex, Cursor, or Claude Desktop to Nexor's session-based MCP server with scoped keys and explicit safety controls. - [MCP tool catalog](https://docs.getnexor.ai/docs/en/api/mcp-server/tools.md): Generated reference for 348 non-admin Nexor MCP tools listed to customer sessions, pinned to the public server manifest. ### Leads - [Create or Update Leads](https://docs.getnexor.ai/docs/en/api/leads/create-lead.md): Create or update one lead or a partial-success bulk batch. Safety note: This operation is an upsert: matching source plus external_id, email, or phone can update an existing lead. move deactivates other runs, do_not_contact suppresses enrollment, and forced fields can contact immediately. Bulk ident… - [Force First Message](https://docs.getnexor.ai/docs/en/api/leads/force-first-message.md): Send a literal email or WhatsApp first message while creating and assigning a lead through POST /leads. - [List Leads](https://docs.getnexor.ai/docs/en/api/leads/list-leads.md): List the authenticated account's live leads. - [List test conversations](https://docs.getnexor.ai/docs/en/api/leads/list-test-conversations.md): List your most recent Playground tests with the task they ran on and their last messages, to check what the agent answered. - [Get Lead](https://docs.getnexor.ai/docs/en/api/leads/get-lead.md): Retrieve a single lead by ID with all fields, plus collected field values ("variables") captured by the AI agent across the lead's workflow runs. - [Update Lead](https://docs.getnexor.ai/docs/en/api/leads/update-lead.md): Update any field on an existing lead. - [Patch Lead](https://docs.getnexor.ai/docs/en/api/leads/patch-lead.md): Partial update of a lead. - [Set Lead Status](https://docs.getnexor.ai/docs/en/api/leads/set-status.md): Force a lead's status within its active workflow run. Safety note: The discard_reason_code, discard_reason_label, discard_reason_subcode, discard_reason_subcode_label, and discard_reason_note fields preserve structured discard provenance. - [Patch Tags](https://docs.getnexor.ai/docs/en/api/leads/patch-tags.md): Replace the complete tag set for a lead identified by ID or email. Safety note: Omitting tags, or sending null, an empty string, or an empty array, removes every current tag. - [Bulk Patch Metadata](https://docs.getnexor.ai/docs/en/api/leads/patch-metadata.md): Shallow-merge a JSON object into the metadata of every lead matching a list of values on a selector key. - [Archive a Lead](https://docs.getnexor.ai/docs/en/api/leads/delete-leads-by-id.md): Archive a lead without permanently erasing its stored record. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Assign Agent to Lead](https://docs.getnexor.ai/docs/en/api/leads/assign-workflow.md): Assign an Agent to a lead and optionally request an immediate call, including outside contact hours. - [Get Lead History](https://docs.getnexor.ai/docs/en/api/leads/get-lead-history.md): Returns the full conversation and activity history for a lead in chronological order. Safety note: The response can include message media, call recordings, meeting URLs, and attendee data; treat it as tenant-confidential. - [Get Lead Meetings](https://docs.getnexor.ai/docs/en/api/leads/get-lead-meetings.md): Returns all meetings for a lead, sorted by most recent first. Safety note: Items can expose attendee email addresses and meeting URLs. - [Stop Automation](https://docs.getnexor.ai/docs/en/api/leads/stop-automation.md): Stops all AI automation for a lead's active workflow run. - [Resume Automation](https://docs.getnexor.ai/docs/en/api/leads/resume-automation.md): Resumes AI automation for a lead's workflow run after it was stopped. ### Workflows (tasks) - [List Agents](https://docs.getnexor.ai/docs/en/api/workflows/list-workflows.md): List tenant workflows, optionally filtered by active state and with archived workflows excluded by default. - [Get an Agent](https://docs.getnexor.ai/docs/en/api/workflows/get-workflow.md): This operation lets you get an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Create an Agent](https://docs.getnexor.ai/docs/en/api/workflows/create-workflow.md): This operation lets you create an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Update an Agent](https://docs.getnexor.ai/docs/en/api/workflows/update-workflow.md): This operation lets you update an agent for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Archive an Agent](https://docs.getnexor.ai/docs/en/api/workflows/delete-workflows-by-id.md): Archive an agent after confirmation; active leads can prevent the archive. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Update Agent Structure](https://docs.getnexor.ai/docs/en/api/workflows/update-workflow-structure.md): This operation lets you update agent structure for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Test Workflow Tool](https://docs.getnexor.ai/docs/en/api/workflow-tools/test-workflow-tool.md): Run a custom tool once, exactly as the agent calls it, and see the request, the response, and what the agent reads. ### Messages - [Send Message](https://docs.getnexor.ai/docs/en/api/messages/send-message.md): Send a message or start a call through any supported public channel. Safety note: HTTP 202 and 207 protect against duplicate sends. Do not automatically replay accepted, ambiguous, or partially delivered sends; inspect retryable and honor retry_after_ms. Call startup can also return HTTP 503 with co… - [List WhatsApp Templates](https://docs.getnexor.ai/docs/en/api/messages/list-templates.md): List all WhatsApp message templates available for your account. ### Meetings - [Log a Meeting](https://docs.getnexor.ai/docs/en/api/meetings/create-meeting.md): Log a meeting booked in an external system against an existing Nexor lead. - [List Meetings](https://docs.getnexor.ai/docs/en/api/meetings/get-meetings.md): This operation lets you list meetings for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Get a Meeting](https://docs.getnexor.ai/docs/en/api/meetings/get-meetings-by-id.md): This operation lets you get a meeting for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Cancel a Meeting](https://docs.getnexor.ai/docs/en/api/meetings/cancel-meeting.md): Cancel a meeting and run all cancellation side effects. Safety note: Cancellation can delete an external calendar event and trigger reminders, notifications, email, webhooks, and recontact side effects. - [Reschedule a Meeting](https://docs.getnexor.ai/docs/en/api/meetings/patch-meetings-by-id-reschedule.md): This operation lets you reschedule a meeting for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Book a Meeting](https://docs.getnexor.ai/docs/en/api/meetings/post-meetings-book.md): Book a meeting for a lead and selected host, with optional invitation and idempotency controls. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain ope… - [Get Available Meeting Times](https://docs.getnexor.ai/docs/en/api/meetings/get-workflows-by-id-slots.md): List available meeting times for an agent, date range, meeting type, and optional host. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Mark a Meeting as No-Show](https://docs.getnexor.ai/docs/en/api/meetings/mark-no-show.md): Mark the outcome of a meeting as **no-show** (the lead didn't attend). - [Mark a Meeting as Completed](https://docs.getnexor.ai/docs/en/api/meetings/complete-meeting.md): Mark a meeting as **completed** (the lead attended). ### Conversions - [List Conversion Events](https://docs.getnexor.ai/docs/en/api/conversions/list-conversions.md): List conversion events for your account. - [Create Conversion Event](https://docs.getnexor.ai/docs/en/api/conversions/create-conversion.md): Record a conversion event using a lead ID, email address, or phone number. Safety note: A conversion type can asynchronously start a workflow transfer and status change after HTTP 201. A later failure does not roll back the conversion event. - [List Conversion Types](https://docs.getnexor.ai/docs/en/api/conversions/list-conversion-types.md): List all active conversion types for your account. ### Reports - [Funnel Report](https://docs.getnexor.ai/docs/en/api/reports/get-funnel-report.md): Aggregate report of how many leads sit at each funnel status, plus contacted/connected-call/discovery-call totals, for one agent or across all of them. - [Lead Report](https://docs.getnexor.ai/docs/en/api/reports/get-lead-report.md): Profile, current status, captured field values with evidence, insights, a per-call summary and scheduled tasks for one lead — everything needed to write a report about them in a single call. - [Get Meeting Statistics](https://docs.getnexor.ai/docs/en/api/reports/get-reports-meeting-stats.md): This operation lets you get meeting statistics for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. - [Team performance](https://docs.getnexor.ai/docs/en/api/reports/get-team-performance.md): See what each teammate did in a period: leads assigned, messages sent, escalations resolved and overdue, and the median first reply after an escalation. - [Tool health](https://docs.getnexor.ai/docs/en/api/reports/get-tool-health.md): See how each tool your agents use behaved in real conversations and calls: runs, failures, empty results, platform blocks, top errors, and examples. - [Export a Leads Report](https://docs.getnexor.ai/docs/en/api/reports/post-reports-leads-export.md): This operation lets you export a leads report for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open. ### Inbox - [Inbox summary](https://docs.getnexor.ai/docs/en/api/inbox/get-inbox-summary.md): Count what is waiting in Inbox right now for each teammate: unanswered conversations, open and overdue escalations, and manual contact. - [List escalations](https://docs.getnexor.ai/docs/en/api/inbox/list-escalations.md): List the cases where an agent asked a person for help, filtered by status, teammate, task and date, with the question, the reason and the outcome. ### Webhooks - [Overview](https://docs.getnexor.ai/docs/en/api/webhooks/overview.md): Configure outbound webhooks and review their supported events, payload envelope, and request headers. - [Receive leads by webhook](https://docs.getnexor.ai/docs/en/api/webhooks/inbound-leads.md): Choose and test Nexor's per-door webhook or generic Public API webhook for inbound leads. - [Event: Status changed](https://docs.getnexor.ai/docs/en/api/webhooks/status-changed.md): Receive workflow status changes and understand the event payload and available dashboard filters. - [Event: Meeting events](https://docs.getnexor.ai/docs/en/api/webhooks/meeting-events.md): Receive meeting lifecycle events and understand their shared payload and dashboard filters. - [Event: Outreach failed](https://docs.getnexor.ai/docs/en/api/webhooks/outreach-failed.md): Receive terminal outreach failures and route leads that need manual review. - [Verifying signatures](https://docs.getnexor.ai/docs/en/api/webhooks/verifying-signatures.md): Verify the HMAC-SHA256 signature included with every Nexor webhook delivery. - [Retries and error handling](https://docs.getnexor.ai/docs/en/api/webhooks/retries-and-errors.md): Understand webhook timeouts, the default retry schedule, health states, and delivery logs. ### CRM Management - [List native CRM booking choices](https://docs.getnexor.ai/docs/en/api/crm-management/list-choices.md): Read verified HubSpot meeting links or GHL calendars, including their location, for an appointment agent. - [Read native CRM booking setup](https://docs.getnexor.ai/docs/en/api/crm-management/get-booking.md): Read saved provider configuration and native tools. The revision is required for changes; this is not proof of a successful booking. - [Configure native CRM booking](https://docs.getnexor.ai/docs/en/api/crm-management/change-booking.md): Configure or remove native HubSpot/GHL booking for one appointment agent. Requires consent and the current revision. Calendar setup does not create or cancel meetings. - [Read GHL import evidence](https://docs.getnexor.ai/docs/en/api/crm-management/get-ghl-import-status.md): Read the latest 20 stored import runs for a connection. Counters can cover several agents; an active connection does not prove that an agent synchronized. ### CRM Chat - [Configure CRM integrations through chat](https://docs.getnexor.ai/docs/en/guides/integrations/crm-chat-configuration.md): Configure supported Nexor CRM connections, routing, field mappings and imports from NexorAI or Claude with Nexor MCP. - [Get crm intake details](https://docs.getnexor.ai/docs/en/api/crm-chat/get-crm-intake-details.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Rotate kommo webhook token](https://docs.getnexor.ai/docs/en/api/crm-chat/rotate-kommo-webhook-token.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Get crm import job](https://docs.getnexor.ai/docs/en/api/crm-chat/get-crm-import-job.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Get hubspot sync preview](https://docs.getnexor.ai/docs/en/api/crm-chat/get-hubspot-sync-preview.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Run hubspot sync](https://docs.getnexor.ai/docs/en/api/crm-chat/run-hubspot-sync.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [List odoo sync conflicts](https://docs.getnexor.ai/docs/en/api/crm-chat/list-odoo-sync-conflicts.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Resolve odoo sync conflict](https://docs.getnexor.ai/docs/en/api/crm-chat/resolve-odoo-sync-conflict.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Change odoo account outputs](https://docs.getnexor.ai/docs/en/api/crm-chat/change-odoo-account-outputs.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [List crm account connections](https://docs.getnexor.ai/docs/en/api/crm-chat/list-crm-account-connections.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Change odoo account inputs](https://docs.getnexor.ai/docs/en/api/crm-chat/change-odoo-account-inputs.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Get crm account configuration](https://docs.getnexor.ai/docs/en/api/crm-chat/get-crm-account-configuration.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Change zoho account defaults](https://docs.getnexor.ai/docs/en/api/crm-chat/change-zoho-account-defaults.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Change hubspot account controls](https://docs.getnexor.ai/docs/en/api/crm-chat/change-hubspot-account-controls.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Reassign crm intake](https://docs.getnexor.ai/docs/en/api/crm-chat/reassign-crm-intake.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Run crm account import](https://docs.getnexor.ai/docs/en/api/crm-chat/run-crm-account-import.md): Account-wide operation, including tasks that inherit defaults and future tasks. Use only in explicit account context. First inspect get_crm_account_configuration and explain all affected_workflows. Writes require their exact IDs, the revision, and explicit confirm=true. Locked tasks or changed confi… - [Get agent crm diagnostics](https://docs.getnexor.ai/docs/en/api/crm-chat/get-agent-crm-diagnostics.md): Read safe stored execution evidence for an exact HubSpot, GHL, Kommo, Zoho, Odoo or custom inbound connection. Read connection_id from get_agent_integration_flows. Provider counters cover the connection, possibly several tasks; custom evidence covers that task-owned entry. Connected/configured is ne… - [List agent hubspot catalog](https://docs.getnexor.ai/docs/en/api/crm-chat/list-agent-hubspot-catalog.md): Read verified HubSpot owners, lead/deal pipelines, or writable contact/deal property choices before configuring native tools and mappings. These are account choices read in a task context. No writes or imports. - [Count agent kommo source](https://docs.getnexor.ai/docs/en/api/crm-chat/count-agent-kommo-source.md): Count cards currently in one saved task-owned Kommo source stage without importing or moving anything. has_more=true means the count is a lower bound, not the total. The source can change after this read. Use exact route_key and connection_id from get_agent_integration_flows. - [Get agent odoo inputs](https://docs.getnexor.ai/docs/en/api/crm-chat/get-agent-odoo-inputs.md): Read Odoo intake routes, inherited field mappings, lifecycle mappings, verified CRM catalogs and exact revision for one task or group. Reads provider metadata without importing records. Runtime apply availability is reported explicitly; saved configuration does not imply execution. Legacy connection… - [Preview agent odoo inputs](https://docs.getnexor.ai/docs/en/api/crm-chat/preview-agent-odoo-inputs.md): Preview replacing one Odoo intake section for the selected task/group, preserving sibling tasks and shared ignore/observe rules. First read get_agent_odoo_inputs. routes/lifecycle values must use workflow IDs inside the selected scope. fields maps provider fields to canonical lead fields or metadata… - [Change agent odoo inputs](https://docs.getnexor.ai/docs/en/api/crm-chat/change-agent-odoo-inputs.md): Save the exact task/group Odoo intake patch after a fresh successful preview and explicit operator consent. Requires confirm=true, current revision and identical previewed patch. Saves through the same guarded service as the panel. Preserves sibling tasks, enforces task locks and available runtime g… - [Create CRM connection](https://docs.getnexor.ai/docs/en/api/integrations/create-crm-connection.md): Issue a safe browser URL for connecting HubSpot, Zoho, Kommo, or GoHighLevel. - [Get CRM connection](https://docs.getnexor.ai/docs/en/api/integrations/get-crm-connection.md): Read a CRM provider's connection state without returning credentials. - [Disconnect CRM](https://docs.getnexor.ai/docs/en/api/integrations/disconnect-crm.md): Stop a CRM connection after explicit confirmation, with optional provider-specific purge behavior. ### Agents - [Set phone-menu navigation](https://docs.getnexor.ai/docs/en/api/master-workflows/set-ivr-navigation.md): Turn phone-menu (IVR) navigation on or off for an agent's calls. ### Inbound router - [Get inbound router](https://docs.getnexor.ai/docs/en/api/inbound-router/get-inbound-router.md): Read an agent's inbound router settings, its shared identity, and the tasks the router can choose from. - [Update inbound router](https://docs.getnexor.ai/docs/en/api/inbound-router/update-inbound-router.md): Turn an agent's inbound router on or off and change its default task, AI thresholds, and clarifying questions. Requires confirm: true. - [List routing rules](https://docs.getnexor.ai/docs/en/api/inbound-router/list-routing-rules.md): List the rules the inbound router checks, in priority order, before the AI picks a task. - [Replace routing rules](https://docs.getnexor.ai/docs/en/api/inbound-router/replace-routing-rules.md): Replace an agent's routing rules in one call. Array order is priority. Requires confirm: true. - [Update shared identity](https://docs.getnexor.ai/docs/en/api/inbound-router/update-agent-identity.md): Replace the name, voice, language, and instructions all tasks of an agent speak with. Requires confirm: true. - [Test a message](https://docs.getnexor.ai/docs/en/api/inbound-router/test-inbound-router.md): Simulate a first message and see which task the inbound router would pick, without sending anything or saving a lead. - [List routing decisions](https://docs.getnexor.ai/docs/en/api/inbound-router/list-routing-decisions.md): See the latest inbound routing decisions of an agent: the step that decided, the task chosen, and any later correction. - [Get routing stats](https://docs.getnexor.ai/docs/en/api/inbound-router/get-routing-stats.md): Count an agent's routing decisions over a window of up to 30 days, by step and outcome, with the share of routes corrected later. - [List entry points](https://docs.getnexor.ai/docs/en/api/inbound-router/list-entry-points.md): List the numbers, lines, accounts, and inboxes where leads reach you, and which agent or task answers each one. - [Set entry point destination](https://docs.getnexor.ai/docs/en/api/inbound-router/set-entry-point-destination.md): Connect a number, line, account, or inbox to an agent or a task, or disconnect it. Phone changes can ask for a confirmation. Requires confirm: true. ### Agent files - [List agent files](https://docs.getnexor.ai/docs/en/api/agent-files/list-agent-files.md): List the files your agents can send to leads, with their handles and sending instructions, and optionally whether one task can send each file. - [Get agent file](https://docs.getnexor.ai/docs/en/api/agent-files/get-agent-file.md): Read one file your agents can send, with its handle and sending instructions. - [Update agent file](https://docs.getnexor.ai/docs/en/api/agent-files/update-agent-file.md): Rename a file your agents can send or rewrite its sending instructions. The handle never changes. - [Set agent file availability](https://docs.getnexor.ai/docs/en/api/agent-files/set-agent-file-availability.md): Let specific tasks send a file, or remove the file from them without deleting it. - [Delete agent file](https://docs.getnexor.ai/docs/en/api/agent-files/delete-agent-file.md): Permanently delete a file so no agent can send it. Rules that mention its handle stop sending it. There is no undo. ### Sub-accounts - [List sub-accounts](https://docs.getnexor.ai/docs/en/api/sub-accounts/list-sub-accounts.md): List your sub-accounts with their state, owner, tasks, leads, and the leads each one contacted this period against your plan. - [Create sub-account](https://docs.getnexor.ai/docs/en/api/sub-accounts/create-sub-account.md): Create a sub-account under your account and invite its owner by email. Its usage counts toward your plan. Requires confirm: true. - [Resend sub-account invitation](https://docs.getnexor.ai/docs/en/api/sub-accounts/resend-sub-account-invitation.md): Send a sub-account's owner invitation again with a new 7-day link. Requires confirm: true. - [Copy an agent to a sub-account](https://docs.getnexor.ai/docs/en/api/sub-accounts/copy-agent-to-sub-account.md): Copy one of your agents, or a single task, into a sub-account. The copy is created paused and lists what to connect. Requires confirm: true. - [Pause sub-account](https://docs.getnexor.ai/docs/en/api/sub-accounts/pause-sub-account.md): Pause every live task of a sub-account so its agents stop writing and calling. Its team keeps access. Requires confirm: true. - [Deactivate sub-account](https://docs.getnexor.ai/docs/en/api/sub-accounts/deactivate-sub-account.md): Pause every task of a sub-account and hide it from its team. No data is deleted. Requires confirm: true. - [Reactivate sub-account](https://docs.getnexor.ai/docs/en/api/sub-accounts/reactivate-sub-account.md): Make a deactivated sub-account visible to its team again. Its tasks stay paused. Requires confirm: true. ## Build and launch - [Build and change your agents with Nexor AI](https://docs.getnexor.ai/docs/en/guides/getting-started/build-with-nexorgpt.md): Nexor AI is the assistant for your team: ask it to create an agent, add or change tasks, edit instructions and schedules, review a lead's conversation, or see how your leads are doing. - [Test your agent](https://docs.getnexor.ai/docs/en/guides/getting-started/test-in-playground.md): Test your agent as a lead, add test lead metadata, and edit the agent in the same right panel while keeping its stages visible. - [Tasks that work together](https://docs.getnexor.ai/docs/en/guides/getting-started/connected-agents.md): Split a sales or support process into several tasks and pass each lead from one task to the next when it reaches a final stage, with its conversation history and the information already collected. - [Go-live checklist](https://docs.getnexor.ai/docs/en/guides/getting-started/launch-checklist.md): What to check before your agent talks to real leads: tasks, instructions and knowledge, channels and WhatsApp templates, working hours, leads, testing, and who on your team watches the first conversations. - [Plan your agent](https://docs.getnexor.ai/docs/en/guides/getting-started/define-your-use-case.md): A worksheet to prepare before building: the result you want, where leads come from, the channels, the jobs your agent will do as tasks, the information to collect, and when a person should step in. - [For developers](https://docs.getnexor.ai/docs/en/guides/getting-started/for-developers.md): Manage Nexor from Claude, Cursor, or your own code with the MCP server and the REST API, and use webhooks, MCP tools, functions, and background jobs to connect your agents to your systems. ## WhatsApp - [Connect WhatsApp](https://docs.getnexor.ai/docs/en/guides/connecting-whatsapp.md): Connect a WhatsApp number to your agent: connect a phone number and verify it by SMS or call, or keep using the WhatsApp Business app on the same number, and complete Meta's signup. - [WhatsApp message templates](https://docs.getnexor.ai/docs/en/guides/whatsapp/message-templates.md): Understand the WhatsApp 24-hour window, template categories, Meta review, and how to create templates in Nexor. - [Consent and opt-out on WhatsApp](https://docs.getnexor.ai/docs/en/guides/whatsapp/consent-and-opt-out.md): Get permission before you message, recognize how a lead opts out, and understand what they stop receiving when they do. - [Message delivery and account quality](https://docs.getnexor.ai/docs/en/guides/whatsapp/delivery-and-quality.md): Understand Meta's quality rating, how many templates you can send per day, what Nexor does when a message cannot be delivered, and when it uses a backup template. - [WhatsApp connection troubleshooting](https://docs.getnexor.ai/docs/en/guides/whatsapp/troubleshooting.md): Fix a WhatsApp connection that does not finish, a number that shows Offline, and payment issues that block template sending. - [WhatsApp error code reference](https://docs.getnexor.ai/docs/en/guides/whatsapp/error-codes.md): Look up a Meta error code from a failed WhatsApp message and find out what it means and how to fix it. - [WhatsApp pricing](https://docs.getnexor.ai/docs/en/guides/whatsapp/pricing.md): Understand the difference between a Nexor subscription and Meta's usage charges for WhatsApp messages. ## Channels - [Set up voice calls](https://docs.getnexor.ai/docs/en/guides/channels/voice.md): Provision a Nexor phone number, assign it to an Agent, change or remove the Agent's number, understand which number each task calls from, configure call behavior and voicemail handling, and place a real test call. - [Email](https://docs.getnexor.ai/docs/en/guides/channels/email.md): Connect and authenticate an email sender, assign it to an Agent, and configure the first email, writing style, signature, and language. - [Set up SMS and US 10DLC](https://docs.getnexor.ai/docs/en/guides/channels/sms-and-10dlc.md): Assign an SMS-capable number, understand US A2P 10DLC readiness, record consent, handle STOP, and test delivery. - [Web Chat](https://docs.getnexor.ai/docs/en/guides/channels/web-chat.md): Configure Web Chat, restrict its domains, and choose between Nexor's hosted loader and the npm SDK widget. - [Connect Instagram](https://docs.getnexor.ai/docs/en/guides/channels/instagram.md): Connect Instagram Business or Creator accounts, route direct messages, reactions, story mentions, and story replies to Nexor agents, and reply to leads on Instagram from Inbox. - [Connect Messenger](https://docs.getnexor.ai/docs/en/guides/channels/messenger.md): Connect Facebook Pages to Messenger and route text from their direct messages to Nexor agents. ## Agents - [Pipeline and Agent operations](https://docs.getnexor.ai/docs/en/guides/agents/pipeline.md): Monitor leads by stage, understand Agent and lead pause states, manage Agent ownership, and archive or restore an Agent safely. - [Agent settings](https://docs.getnexor.ai/docs/en/guides/agents/settings.md): Configure an agent's goal, identity, business rules, channels, lead sources, pipeline, knowledge, and operating limits, including how long replies split into several messages. - [Route inbound leads between tasks](https://docs.getnexor.ai/docs/en/guides/agents/router.md): When an agent has two or more tasks, the Router decides which task handles each new inbound lead: always the same task, or the task that fits what the lead says, with a fallback task when it is unclear. - [Logical check](https://docs.getnexor.ai/docs/en/guides/agents/logical-check.md): Review an Agent's prompt, stages and tools for contradictions before a lead runs into them, and hand the fixes to NexorGPT. - [Prompt best practices](https://docs.getnexor.ai/docs/en/guides/agents/prompt-best-practices.md): Use @ metadata mentions for campaign context and repeat forms, and write clear agent instructions for each goal. - [Knowledge base, files and product catalogs](https://docs.getnexor.ai/docs/en/guides/agents/knowledge-base.md): Add documents, websites, images and text to the Knowledge Base, choose which agents use each folder, add files the agent can send with their sending instructions in Files to send, and manage product catalogs in Settings → Products. - [Track conversions](https://docs.getnexor.ai/docs/en/guides/agents/conversions.md): Define conversion types, choose their scope and follow-up action, and record conversion events for leads. ### Leads - [Manage leads](https://docs.getnexor.ai/docs/en/guides/agents/leads/manage-leads.md): Find leads across Agents, use the available filters, customize the table, and understand which actions the dashboard supports. - [Lead details and conversations](https://docs.getnexor.ai/docs/en/guides/agents/leads/conversations.md): Review a lead's information and unified timeline, update its assignment or stage, and contact it through available channels. - [Organize leads with tags](https://docs.getnexor.ai/docs/en/guides/agents/leads/tags.md): Create, edit, color, apply, filter, and safely delete the tags your team uses to organize leads. - [Add a lead manually](https://docs.getnexor.ai/docs/en/guides/agents/leads/manual-upload.md): Create one lead from the dashboard, optionally assign an Agent, and understand when outreach begins. - [Upload leads from CSV or Excel](https://docs.getnexor.ai/docs/en/guides/agents/leads/csv-upload.md): Prepare a CSV or XLSX file, map its columns, and understand which lead rows Nexor imports or skips. - [Connect HubSpot](https://docs.getnexor.ai/docs/en/guides/agents/leads/hubspot.md): Connect HubSpot with OAuth, choose how contacts enter Nexor, map their fields, and control which results are written back. Includes the HubSpot permissions and objects Nexor can access. - [Connect Kommo](https://docs.getnexor.ai/docs/en/guides/agents/leads/kommo.md): Connect Kommo CRM, choose the pipelines and stages that send leads to a task, and map Kommo fields such as phone, email and name. - [Connect API](https://docs.getnexor.ai/docs/en/guides/agents/leads/api.md): Send leads to Nexor through the REST API with an API key. - [Test leads](https://docs.getnexor.ai/docs/en/guides/agents/leads/test-leads.md): What a test lead is, where it comes from, where it shows up, and why you cannot find it in Leads, in the pipeline, or through the API until you turn on Show test. ## Meetings - [Manage meetings](https://docs.getnexor.ai/docs/en/guides/meetings/overview.md): Find, review, reschedule, reassign, and cancel the meetings booked by your Nexor Agents. - [Calendars and availability](https://docs.getnexor.ai/docs/en/guides/meetings/calendars-and-availability.md): Connect a host's calendar and set the weekly hours, time off, and timezone Nexor uses for meeting availability. - [Configure meeting types and hosts](https://docs.getnexor.ai/docs/en/guides/meetings/meeting-types-and-hosts.md): Choose how a booking Agent creates meetings, assign eligible hosts, and configure scheduling limits and attendees. - [Configure reminders and alerts](https://docs.getnexor.ai/docs/en/guides/meetings/reminders-and-alerts.md): Send meeting reminders to leads and booking alerts to hosts from a booking Agent's Meeting settings. - [CRM booking through chat](https://docs.getnexor.ai/docs/en/guides/meetings/crm-booking-chat.md): Choose a HubSpot meeting link or GoHighLevel calendar through NexorAI or Claude, and distinguish saved setup from execution evidence. ## Integrations - [Google Calendar](https://docs.getnexor.ai/docs/en/guides/integrations/google-calendar.md): Connect a host's Google Calendar from Meetings and resolve authorization, provider conflicts, and reauthorization issues. - [Outlook Calendar](https://docs.getnexor.ai/docs/en/guides/integrations/outlook-calendar.md): Connect a host's Outlook Calendar from Meetings and understand Microsoft authorization, Teams links, and reconnection states. - [Connect Calendly](https://docs.getnexor.ai/docs/en/guides/integrations/calendly.md): Connect a supported Calendly account, map team hosts, and let a Nexor booking Agent use an event type or scheduling link. - [Connect Cal.com](https://docs.getnexor.ai/docs/en/guides/integrations/calcom.md): Connect a Cal.com account with the Cal.com login or an API key, pick an event type per booking Agent, and let the Agent book, move and cancel real Cal.com bookings. - [Custom connection](https://docs.getnexor.ai/docs/en/guides/integrations/custom-connection.md): Connect an in-house CRM or unsupported system to Nexor with input doors, webhooks, API keys, and HTTP tools. - [Connect GoHighLevel](https://docs.getnexor.ai/docs/en/guides/integrations/gohighlevel.md): Connect one or more GoHighLevel Locations, route open opportunities into Nexor, sync configured terminal outcomes back, and fix common problems such as Auto-sync that cannot be saved or a webhook that receives no opportunities. - [Connect Zoho CRM](https://docs.getnexor.ai/docs/en/guides/integrations/zoho.md): Connect Zoho CRM with OAuth and configure the lead, attribution, agent-field, and status data Nexor sends to Zoho. - [Connect Odoo](https://docs.getnexor.ai/docs/en/guides/integrations/odoo.md): Connect Odoo with a native read-only API-key connection, configure and preview inputs, and distinguish it from the generic inbound webhook alias. - [Connect Google Sheets](https://docs.getnexor.ai/docs/en/guides/integrations/google-sheets.md): Import leads from a Google Sheets tab into a Nexor agent, with verified mapping, sync behavior, and current limitations. ## Account - [Personal profile and preferences](https://docs.getnexor.ai/docs/en/guides/account/profile.md): Change your language and light or dark theme in Settings → General, and update your photo, job title, phone and host bio. - [Members, roles, and access](https://docs.getnexor.ai/docs/en/guides/account/members-and-roles.md): Invite teammates, choose the right role, assign appointment Agents, manage availability, hand off a departing teammate's leads, and understand what Members can access. - [Notification settings](https://docs.getnexor.ai/docs/en/guides/account/notifications.md): Choose who on your team is notified, in the app and by email, when a lead needs a person, a tool or webhook fails, or a connection stops working. - [Billing, lead quota, and invoices](https://docs.getnexor.ai/docs/en/guides/account/billing.md): Understand what counts toward your lead quota, when it resets, how overage works, and how to manage cards, invoices, and cancellation. - [Sub-accounts](https://docs.getnexor.ai/docs/en/guides/account/sub-accounts.md): Create and manage sub-accounts: separate Nexor accounts with their own team, agents, numbers, and leads, billed through the main account's plan. Copy agents, resend invitations, pause, deactivate, and reactivate. ## Inbox - [Inbox overview](https://docs.getnexor.ai/docs/en/guides/inbox/overview.md): Use Inbox to find active conversations, see each teammate's conversations, reply on Instagram, organize human follow-up, and review each lead's context. - [Handle escalations in Inbox](https://docs.getnexor.ai/docs/en/guides/inbox/escalations.md): Review an Agent escalation, reply without closing the case, and return the conversation safely. ## Developer tools - [Advanced automation](https://docs.getnexor.ai/docs/en/guides/advanced/overview.md): Choose the right tool in Developers for webhooks, agent tools, background jobs (cron in the account timezone), routing, functions, and shared secrets. - [Cloud Functions](https://docs.getnexor.ai/docs/en/guides/advanced/cloud-functions.md): Create event-driven JavaScript functions, inspect their payloads, use shared secrets, and review each execution. - [Scheduled Functions](https://docs.getnexor.ai/docs/en/guides/advanced/scheduled-functions.md): Create scheduled JavaScript jobs, select the lead cohort they receive, run them safely, and inspect their execution history. ## Support reference - [Glossary: agent, task, group and old names](https://docs.getnexor.ai/docs/en/support/glossary.md): Map old and new names customers use: Group is now Agent, Agent is now Task (workflow), NexorGPT, Nexor Bot and Nexor Agent are Nexor AI, Brain, doors, Variables and metadata, with the matching API field and v1 or v2 label. - [Settings scope: account, agent and task](https://docs.getnexor.ai/docs/en/support/settings-scope.md): Which setting belongs to the account, the shared agent (group) or one task, what a task inherits or overrides: channels, WhatsApp number, contact hours, templates, prompt, knowledge, CRM connection, field mapping and Variables. - [Find a setting: v2 workspace vs classic v1](https://docs.getnexor.ai/docs/en/support/where-is-each-setting.md): Where each setting lives in the v2 chat workspace and in the classic v1 panel: agent and task settings, lead, meeting, integration, billing, team, knowledge, channel and phone number screens, with link patterns. - [Contact hours, cadence and follow-up rules](https://docs.getnexor.ai/docs/en/support/contact-hours-and-cadence.md): When an agent contacts a lead: contact hours and days, timezone, cadence blocks, follow-up attempts and follow-up template rotation, recontact rules, per-lead limits, 24-hour WhatsApp window, and why a lead was not contacted. - [Troubleshoot CRM sync and lead intake](https://docs.getnexor.ai/docs/en/support/crm-sync-and-lead-intake.md): Why leads do not arrive or do not sync: connection vs configuration vs execution, expired token, paused input door, routing rules, agent paused, webhook URL or token, field mapping to Variables, output stage trigger for HubSpot, Zoho, GoHighLevel, Odoo, Google Sheets and custom webhooks. - [Classic Overview dashboard (v1): metrics and warnings](https://docs.getnexor.ai/docs/en/guides/getting-started/dashboard.md): What each number, filter, KPI card and warning banner means in the classic Overview dashboard at app.getnexor.ai/v1: new leads, meetings booked, qualified leads, conversion rate, response rate, channel activity and insights. ### US compliance - [US outreach regulations: consent, AI calls, texts and calling hours](https://docs.getnexor.ai/docs/en/guides/compliance/us-outreach-overview.md): Legal requirements, TCPA and state regulations for AI voice calls and SMS to United States numbers: what consent must say, calling hours, do-not-call lists, penalties, and what Nexor enforces automatically. - [US state-by-state regulations for calls and texts](https://docs.getnexor.ai/docs/en/guides/compliance/us-state-rules.md): Legal telemarketing regulations by US state (Florida, Texas, California, New York and all others): calling hours, Sunday and holiday bans, mini-TCPA consent laws, calls-per-day limits, state do-not-call lists, registration and call-recording consent for AI outreach. - [AI disclosure and call recording rules for US agents](https://docs.getnexor.ai/docs/en/guides/compliance/ai-disclosure-and-recording.md): US regulations on when the law requires the agent to say it is an AI or a bot, which states require everyone's consent to record a call, and how to write a compliant opener for AI voice calls, SMS and chat. ## OpenAPI Specs - [openapi](/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Spanish (183 pages)](https://docs.getnexor.ai/_llms/es.md): Documentation for Spanish. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.