# Apten

- [Introduction](https://docs.apten.ai/introduction.md): Welcome to the Apten API documentation!
- [User Roles & Permissions](https://docs.apten.ai/account-security/user-roles.md): Understand the different user roles and their access levels in Apten.
- [Multi-Factor Authentication (MFA)](https://docs.apten.ai/account-security/multi-factor-authentication.md): Learn how to set up multi-factor authentication to secure your account, and how admins can enforce MFA across the organization.
- [Customer Profiles](https://docs.apten.ai/tutorials/customer_profiles.md): Learn how to setup/customize customer profiles for each type of lead
- [Custom Knowledge](https://docs.apten.ai/tutorials/custom_knowledge.md): Learn how to train Apten with information to use in conversations with leads.
- [Optimize](https://docs.apten.ai/tutorials/optimize.md): Use unanswered questions, objections, and follow-up insights to improve your AI agent.
- [Guardrails](https://docs.apten.ai/tutorials/guardrails.md): Learn how to set up AI guardrails to ensure safe and compliant conversations.
- [Tags](https://docs.apten.ai/tutorials/tags.md): Learn how to create and manage tags to organize and categorize your leads
- [Call Dispositions](https://docs.apten.ai/tutorials/call_dispositions.md): Classify completed calls using prioritized system and AI conditions.
- [Custom Notifications](https://docs.apten.ai/tutorials/notifications.md): Set up custom notifications to get alerted when important events happen in lead conversations.
- [Settings](https://docs.apten.ai/tutorials/settings.md): Configure your organization settings including AI behavior, phone numbers, email, and webchat.
- [Warm Transfer](https://docs.apten.ai/tutorials/warm_transfer.md): Set up AI-assisted warm transfers to brief human agents before connecting them with leads.
- [State-Specific TCPA Compliance](https://docs.apten.ai/compliance/state-specific-tcpa.md): Apply state-specific outreach windows, holidays, blackout dates, and rolling contact limits to SMS and voice outreach.
- [External Compliance Checks](https://docs.apten.ai/compliance/external-checks.md): Gate every outbound SMS, email, or call against your own compliance middleware before Apten sends.
- [Accessibility](https://docs.apten.ai/compliance/accessibility.md): Apten's accessibility features, assistive-technology compatibility, known limitations, and how to request help or accommodations.
- [Overview](https://docs.apten.ai/webhooks/overview.md): An overview of webhooks that Apten provides.
- [Lead Tagged](https://docs.apten.ai/webhooks/lead-tagged.md): Receive a webhook when a new lead is tagged by Apten.
- [Lead Additional Info Updated](https://docs.apten.ai/webhooks/lead-additional-info-updated.md): Get notified when a lead’s additionalInfo key-value fields change.
- [Notification Created](https://docs.apten.ai/webhooks/notification-created.md): Receive a webhook when a new notification is created by Apten
- [Message Sent](https://docs.apten.ai/webhooks/message-sent.md): Get notified when a message is sent to a lead
- [Message Received](https://docs.apten.ai/webhooks/message-received.md): Get notified when a message is received from a lead
- [Opt Out](https://docs.apten.ai/webhooks/opt-out.md): Get notified when a lead opts out of messaging
- [Opt In](https://docs.apten.ai/webhooks/opt-in.md): Get notified when a lead re-subscribes after previously opting out
- [Do Not Contact](https://docs.apten.ai/webhooks/do-not-contact.md): Get notified when a lead explicitly requests to never be contacted again
- [Guardrail Triggered](https://docs.apten.ai/webhooks/guardrail-triggered.md): Get notified when a guardrail is triggered during a conversation
- [Call Completed](https://docs.apten.ai/webhooks/call-completed.md): Get notified when a call is completed
- [Call Dispositioned](https://docs.apten.ai/webhooks/call-dispositioned.md): Get notified when a completed voice call is assigned a disposition.
- [Call Attempted](https://docs.apten.ai/webhooks/call-attempted.md): Get notified when a call attempt is made
- [Call Transferred](https://docs.apten.ai/webhooks/call-transferred.md): Get notified when a call is transferred to another agent or system
- [Call Transfer Connected](https://docs.apten.ai/webhooks/call-transfer-connected.md): Get notified when a warm call transfer successfully bridges a human agent to the lead
- [Transfer Fallback Triggered](https://docs.apten.ai/webhooks/transfer-fallback-triggered.md): Get notified when a warm transfer fallback is dispatched
- [Agent Missed Transfer](https://docs.apten.ai/webhooks/agent-missed-transfer.md): Get notified when a call transfer to a human agent is missed
- [Session Started](https://docs.apten.ai/webhooks/webchat/session-started.md): Get notified when a new webchat session is started.
- [Message Received](https://docs.apten.ai/webhooks/webchat/message-received.md): Get notified when a visitor sends a message in webchat.
- [Message Sent](https://docs.apten.ai/webhooks/webchat/message-sent.md): Get notified when a message is sent to a visitor in webchat.
- [Contact Form Submitted](https://docs.apten.ai/webhooks/webchat/contact-form-submitted.md): Get notified when a visitor submits the webchat contact form.
- [Session Converted](https://docs.apten.ai/webhooks/webchat/session-converted.md): Get notified when a webchat session is converted into a lead.
- [Guardrail Triggered](https://docs.apten.ai/webhooks/webchat/guardrail-triggered.md): Get notified when a guardrail is triggered on a webchat message.
- [Call Transferred](https://docs.apten.ai/webhooks/webchat/call-transferred.md): Get notified when a transfer call happens in a webchat session.
- [Verifying Webhooks](https://docs.apten.ai/webhooks/verification.md): Verifying webhook requests from the Apten API.
- [Salesforce](https://docs.apten.ai/integrations/salesforce.md): Integrate Apten with Salesforce.
- [Hubspot](https://docs.apten.ai/integrations/hubspot.md): Integrate Apten with Hubspot.
- [Microsoft Dynamics 365](https://docs.apten.ai/integrations/dynamics.md): Integrate Apten with Microsoft Dynamics 365.
- [Power Automate](https://docs.apten.ai/integrations/power-automate.md): Connect Apten to Microsoft Power Automate to automate lead engagement workflows
- [Webchat Overview](https://docs.apten.ai/webchat/overview.md): Engage website visitors with AI-powered webchat conversations
- [Setup and Integration](https://docs.apten.ai/webchat/setup.md): Add the Apten webchat widget to your website in minutes
- [Webchat Agent Capabilities](https://docs.apten.ai/webchat/capabilities.md): Understand what your Apten webchat agent can do
- [Configuration Settings](https://docs.apten.ai/webchat/settings.md): Complete reference for webchat configuration options
- [Automations Overview](https://docs.apten.ai/automations/overview.md): Build CRM-triggered workflows that create leads, send messages, and manage outreach in Apten automatically.
- [Building an Automation](https://docs.apten.ai/automations/building.md): Create an automation on the visual builder, publish it, and turn it on.
- [Triggers](https://docs.apten.ai/automations/triggers.md): Start automations when a record is created or a field changes in your CRM.
- [Actions](https://docs.apten.ai/automations/actions.md): Everything an automation step can do — create and update leads, send messages, and look up CRM records.
- [Control Steps](https://docs.apten.ai/automations/control-steps.md): Steps that shape the flow of a run — stop it with a Filter, pause it with a Delay, or split it into paths with a Branch.
- [Runs & Troubleshooting](https://docs.apten.ai/automations/runs.md): Inspect automation run history, understand run statuses, and resolve failed steps.
- [Introduction](https://docs.apten.ai/api-reference/introduction.md): An overview of the Apten API, including the base URL, authentication, and response codes.
- [Create a lead](https://docs.apten.ai/api-reference/leads/create.md): Creates a new lead
- [List leads](https://docs.apten.ai/api-reference/leads/list.md): Incrementally list leads. Requires `updatedSince` and/or `createdSince`. Soft-deleted leads are included (`deleted: true`); treat as removals. Use `lastActivityAt` to decide whether to fetch events.
- [Get lead](https://docs.apten.ai/api-reference/leads/get-lead.md): Fetches details of a specific lead. Returns 404 if the lead has been deleted; use `GET /leads` to enumerate deleted leads (which surface with `deleted: true`) for incremental sync.
- [Update lead](https://docs.apten.ai/api-reference/leads/update.md): Updates properties of a specific lead
- [Delete a lead](https://docs.apten.ai/api-reference/leads/delete.md): Deletes a specific lead
- [Get messages](https://docs.apten.ai/api-reference/leads/get-messages.md): Fetches messages sent to and received from a lead
- [List events for a lead](https://docs.apten.ai/api-reference/leads/list-events.md): List interaction events for a lead — messages, calls, emails, tool calls, custom events, compliance blocks, and other types documented in this reference.
- [Turn off a lead](https://docs.apten.ai/api-reference/leads/turn-off.md): Turns Apten off for a lead
- [Turn on a lead](https://docs.apten.ai/api-reference/leads/turn-on.md): Turns Apten on for a lead
- [Add context to a lead](https://docs.apten.ai/api-reference/leads/add-context.md): Adds context or a timeline event to a lead. Use `event` for things that happened at a point in time (a status change, a completed step, an update from your system) — Apten places it in the conversation timeline so the AI knows when it occurred relative to the lead's messages and can react to it. Use…
- [Switch lead's customer profile](https://docs.apten.ai/api-reference/leads/switch-customer-profile.md): Switches the customer profile of a lead. Any pending scheduled follow-up for the lead (automated follow-up steps, dynamic AI-scheduled follow-ups, etc.) is always canceled as part of the switch. Manually scheduled messages (created via "Schedule Message" in the dashboard) are preserved. If `sendMess…
- [Look up lead by phone](https://docs.apten.ai/api-reference/leads/lookup.md): Looks up a lead by phone number
- [Send message to a lead](https://docs.apten.ai/api-reference/leads/send-message.md): Sends a message to a lead
- [Rescribe a lead to text messages](https://docs.apten.ai/api-reference/leads/resubscribe.md): Resubscribes a lead to text messages from Apten.
- [Replace tags](https://docs.apten.ai/api-reference/leads/replace-tags.md): Replace all tags on a lead
- [Add tags](https://docs.apten.ai/api-reference/leads/add-tags.md): Add tags to a lead (will not remove existing tags)
- [Remove tags](https://docs.apten.ai/api-reference/leads/remove-tags.md): Remove specific tags from a lead
- [Get call](https://docs.apten.ai/api-reference/calls/get-call.md): Fetch full details for a call by ID — transcript, AI summary, and transfer metadata.
- [Get tags](https://docs.apten.ai/api-reference/tags/get-tags.md): Retrieve all custom tags defined for the organization
- [Get usage](https://docs.apten.ai/api-reference/usage/get-usage.md): Retrieve the current usage limit status for the organization. Today the only tracked usage dimension is the per-organization lead limit; additional dimensions may be added in the future under sibling keys.
- [Add to DNC List](https://docs.apten.ai/api-reference/dnc/register.md): Adds a phone number to the Do Not Contact (DNC) list to prevent it from being imported.
- [Check DNC Status](https://docs.apten.ai/api-reference/dnc/get-dnc.md): Checks if a phone number is in the DNC list
- [Remove from DNC List](https://docs.apten.ai/api-reference/dnc/delete-dnc.md): Removes a phone number from the DNC list
- [August 2026](https://docs.apten.ai/changelog/2026-08.md)
- [July 2026](https://docs.apten.ai/changelog/2026-07.md)
- [June 2026](https://docs.apten.ai/changelog/2026-06.md)
- [May 2026](https://docs.apten.ai/changelog/2026-05.md)
- [April 2026](https://docs.apten.ai/changelog/2026-04.md)
- [March 2026](https://docs.apten.ai/changelog/2026-03.md)
- [February 2026](https://docs.apten.ai/changelog/2026-02.md)
- [January 2026](https://docs.apten.ai/changelog/2026-01.md)
- [December 2025](https://docs.apten.ai/changelog/2025-12.md)
- [November 2025](https://docs.apten.ai/changelog/2025-11.md)
- [October 2025](https://docs.apten.ai/changelog/2025-10.md)
- [September 19, 2025](https://docs.apten.ai/changelog/2025-09-19.md)
- [September 12, 2025](https://docs.apten.ai/changelog/2025-09-12.md)
- [September 5, 2025](https://docs.apten.ai/changelog/2025-09-05.md)
- [August 29, 2025](https://docs.apten.ai/changelog/2025-08-29.md)
- [August 22, 2025](https://docs.apten.ai/changelog/2025-08-22.md)
- [August 15, 2025](https://docs.apten.ai/changelog/2025-08-15/2025-08-15.md)
- [August 8, 2025](https://docs.apten.ai/changelog/2025-08-08/2025-08-08.md)
- [August 1, 2025](https://docs.apten.ai/changelog/2025-08-01.md)
- [July 25, 2025](https://docs.apten.ai/changelog/2025-07-25/2025-07-25.md)

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)